Foundry API

<back to all web services

GetRecentTelemetryRequest

Requires Authentication
The following routes are available for this service:
GET/machines/{Id}/telemetries/recent
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 GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    GetOperationTenanted({this.organisationId});
    GetOperationTenanted.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() => "GetOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class Telemetry implements IIdentifiableResource, IConvertible
{
    String? type;
    String? value;
    DateTime? observedAt;
    String? id;

    Telemetry({this.type,this.value,this.observedAt,this.id});
    Telemetry.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!);
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'type': type,
        'value': value,
        'observedAt': JsonConverters.toJson(observedAt,'DateTime',context!),
        'id': id
    };

    getTypeName() => "Telemetry";
    TypeContext? context = _ctx;
}

class GetRecentTelemetryResponse implements IConvertible
{
    Telemetry? telemetry;
    ResponseStatus? responseStatus;

    GetRecentTelemetryResponse({this.telemetry,this.responseStatus});
    GetRecentTelemetryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        telemetry = JsonConverters.fromJson(json['telemetry'],'Telemetry',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'telemetry': JsonConverters.toJson(telemetry,'Telemetry',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetRecentTelemetryResponse";
    TypeContext? context = _ctx;
}

class GetRecentTelemetryRequest extends GetOperationTenanted<GetRecentTelemetryResponse> implements IConvertible
{
    String? id;
    String? targetTelemetryType;

    GetRecentTelemetryRequest({this.id,this.targetTelemetryType});
    GetRecentTelemetryRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        targetTelemetryType = json['targetTelemetryType'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'targetTelemetryType': targetTelemetryType
    });

    getTypeName() => "GetRecentTelemetryRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'GetOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Telemetry': TypeInfo(TypeOf.Class, create:() => Telemetry()),
    'GetRecentTelemetryResponse': TypeInfo(TypeOf.Class, create:() => GetRecentTelemetryResponse()),
    'GetRecentTelemetryRequest': TypeInfo(TypeOf.Class, create:() => GetRecentTelemetryRequest()),
});

Dart GetRecentTelemetryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /machines/{Id}/telemetries/recent HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"telemetry":{"type":"String","value":"String","id":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}