Foundry API

<back to all web services

GetRecentTelemetryRequest

Requires Authentication
The following routes are available for this service:
GET/machines/{Id}/telemetries/recent

export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    public embed?: string;

    public constructor(init?: Partial<GetOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<GetOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export class Telemetry implements IIdentifiableResource
{
    public type?: string;
    public value?: string;
    public observedAt: string;
    public id?: string;

    public constructor(init?: Partial<Telemetry>) { (Object as any).assign(this, init); }
}

export class GetRecentTelemetryResponse
{
    public telemetry?: Telemetry;
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<GetRecentTelemetryResponse>) { (Object as any).assign(this, init); }
}

export class GetRecentTelemetryRequest extends GetOperationTenanted<GetRecentTelemetryResponse>
{
    public id?: string;
    public targetTelemetryType?: string;

    public constructor(init?: Partial<GetRecentTelemetryRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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"}}}