Foundry API

<back to all web services

AddTelemetryRequest

Requires Authentication
The following routes are available for this service:
POST/machines/{MachineId}/telemetries

export class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
{

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

export class PutPatchOperationTenanted<TResponse> extends PutPatchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

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

export class AddTelemetryResponse
{
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<AddTelemetryResponse>) { (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 AddTelemetryRequest extends PutPatchOperationTenanted<AddTelemetryResponse>
{
    public machineId?: string;
    public telemetries?: Telemetry[];

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

TypeScript AddTelemetryRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /machines/{MachineId}/telemetries HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"machineId":"String","telemetries":[{"type":"String","value":"String","id":"String"}],"organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}