| GET | /machines/{Id}/telemetries |
|---|
import 'package:servicestack/servicestack.dart';
abstract class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
String? embed;
GetOperationUnTenanted({this.embed});
GetOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
embed = json['embed'];
return this;
}
Map<String, dynamic> toJson() => {
'embed': embed
};
getTypeName() => "GetOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
String? distinct;
int? limit;
int? offset;
String? sort;
String? filter;
SearchOperationUnTenanted({this.distinct,this.limit,this.offset,this.sort,this.filter});
SearchOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
distinct = json['distinct'];
limit = json['limit'];
offset = json['offset'];
sort = json['sort'];
filter = json['filter'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'distinct': distinct,
'limit': limit,
'offset': offset,
'sort': sort,
'filter': filter
});
getTypeName() => "SearchOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
String? organisationId;
SearchOperationTenanted({this.organisationId});
SearchOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
organisationId = json['organisationId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'organisationId': organisationId
});
getTypeName() => "SearchOperationTenanted<$TResponse>";
TypeContext? context = _ctx;
}
enum SortDirection
{
Ascending,
Descending,
}
class Sorting implements IConvertible
{
String? by;
SortDirection? direction;
Sorting({this.by,this.direction});
Sorting.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
by = json['by'];
direction = JsonConverters.fromJson(json['direction'],'SortDirection',context!);
return this;
}
Map<String, dynamic> toJson() => {
'by': by,
'direction': JsonConverters.toJson(direction,'SortDirection',context!)
};
getTypeName() => "Sorting";
TypeContext? context = _ctx;
}
class Filtering implements IConvertible
{
List<String>? fields;
Filtering({this.fields});
Filtering.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
fields = JsonConverters.fromJson(json['fields'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'fields': JsonConverters.toJson(fields,'List<String>',context!)
};
getTypeName() => "Filtering";
TypeContext? context = _ctx;
}
class SearchMetadata implements IConvertible
{
int? total;
int? limit;
int? offset;
Sorting? sort;
Filtering? filter;
SearchMetadata({this.total,this.limit,this.offset,this.sort,this.filter});
SearchMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
total = json['total'];
limit = json['limit'];
offset = json['offset'];
sort = JsonConverters.fromJson(json['sort'],'Sorting',context!);
filter = JsonConverters.fromJson(json['filter'],'Filtering',context!);
return this;
}
Map<String, dynamic> toJson() => {
'total': total,
'limit': limit,
'offset': offset,
'sort': JsonConverters.toJson(sort,'Sorting',context!),
'filter': JsonConverters.toJson(filter,'Filtering',context!)
};
getTypeName() => "SearchMetadata";
TypeContext? context = _ctx;
}
abstract class SearchOperationResponse
{
SearchMetadata? metadata;
SearchOperationResponse({this.metadata});
SearchOperationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
metadata = JsonConverters.fromJson(json['metadata'],'SearchMetadata',context!);
return this;
}
Map<String, dynamic> toJson() => {
'metadata': JsonConverters.toJson(metadata,'SearchMetadata',context!)
};
getTypeName() => "SearchOperationResponse";
TypeContext? context = _ctx;
}
class SummarisedTelemetry implements IConvertible
{
String? type;
String? value;
DateTime? observedAt;
SummarisedTelemetry({this.type,this.value,this.observedAt});
SummarisedTelemetry.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
type = json['type'];
value = json['value'];
observedAt = JsonConverters.fromJson(json['observedAt'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'type': type,
'value': value,
'observedAt': JsonConverters.toJson(observedAt,'DateTime',context!)
};
getTypeName() => "SummarisedTelemetry";
TypeContext? context = _ctx;
}
class SearchTelemetriesResponse extends SearchOperationResponse implements IConvertible
{
String? granularity;
String? type;
DateTime? from;
DateTime? to;
List<SummarisedTelemetry>? telemetries;
ResponseStatus? responseStatus;
SearchTelemetriesResponse({this.granularity,this.type,this.from,this.to,this.telemetries,this.responseStatus});
SearchTelemetriesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
granularity = json['granularity'];
type = json['type'];
from = JsonConverters.fromJson(json['from'],'DateTime',context!);
to = JsonConverters.fromJson(json['to'],'DateTime',context!);
telemetries = JsonConverters.fromJson(json['telemetries'],'List<SummarisedTelemetry>',context!);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'granularity': granularity,
'type': type,
'from': JsonConverters.toJson(from,'DateTime',context!),
'to': JsonConverters.toJson(to,'DateTime',context!),
'telemetries': JsonConverters.toJson(telemetries,'List<SummarisedTelemetry>',context!),
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
});
getTypeName() => "SearchTelemetriesResponse";
TypeContext? context = _ctx;
}
class SearchTelemetriesRequest extends SearchOperationTenanted<SearchTelemetriesResponse> implements IConvertible
{
String? id;
String? granularity;
String? telemetryType;
DateTime? observedAfter;
DateTime? observedBefore;
SearchTelemetriesRequest({this.id,this.granularity,this.telemetryType,this.observedAfter,this.observedBefore});
SearchTelemetriesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
id = json['id'];
granularity = json['granularity'];
telemetryType = json['telemetryType'];
observedAfter = JsonConverters.fromJson(json['observedAfter'],'DateTime',context!);
observedBefore = JsonConverters.fromJson(json['observedBefore'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'id': id,
'granularity': granularity,
'telemetryType': telemetryType,
'observedAfter': JsonConverters.toJson(observedAfter,'DateTime',context!),
'observedBefore': JsonConverters.toJson(observedBefore,'DateTime',context!)
});
getTypeName() => "SearchTelemetriesRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SearchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SearchOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SortDirection': TypeInfo(TypeOf.Enum, enumValues:SortDirection.values),
'Sorting': TypeInfo(TypeOf.Class, create:() => Sorting()),
'Filtering': TypeInfo(TypeOf.Class, create:() => Filtering()),
'SearchMetadata': TypeInfo(TypeOf.Class, create:() => SearchMetadata()),
'SearchOperationResponse': TypeInfo(TypeOf.AbstractClass),
'SummarisedTelemetry': TypeInfo(TypeOf.Class, create:() => SummarisedTelemetry()),
'SearchTelemetriesResponse': TypeInfo(TypeOf.Class, create:() => SearchTelemetriesResponse()),
'List<SummarisedTelemetry>': TypeInfo(TypeOf.Class, create:() => <SummarisedTelemetry>[]),
'SearchTelemetriesRequest': TypeInfo(TypeOf.Class, create:() => SearchTelemetriesRequest()),
});
Dart SearchTelemetriesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /machines/{Id}/telemetries HTTP/1.1
Host: foundrystage-api-app.azurewebsites.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
granularity: String,
type: String,
telemetries:
[
{
type: String,
value: String
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
metadata:
{
total: 0,
limit: 0,
offset: 0,
sort:
{
by: String,
direction: Ascending
},
filter:
{
fields:
[
String
]
}
}
}