Foundry API

<back to all web services

SearchTelemetriesRequest

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

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

export class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
    public distinct?: string;
    public limit?: number;
    public offset?: number;
    public sort?: string;
    public filter?: string;

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

export class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

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

export enum SortDirection
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class Sorting
{
    public by?: string;
    public direction: SortDirection;

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

export class Filtering
{
    public fields?: string[];

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

export class SearchMetadata
{
    public total: number;
    public limit: number;
    public offset: number;
    public sort?: Sorting;
    public filter?: Filtering;

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

export class SearchOperationResponse
{
    public metadata?: SearchMetadata;

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

export class SummarisedTelemetry
{
    public type?: string;
    public value?: string;
    public observedAt: string;

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

export class SearchTelemetriesResponse extends SearchOperationResponse
{
    public granularity?: string;
    public type?: string;
    public from: string;
    public to: string;
    public telemetries?: SummarisedTelemetry[];
    public responseStatus?: ResponseStatus;

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

export class SearchTelemetriesRequest extends SearchOperationTenanted<SearchTelemetriesResponse>
{
    public id?: string;
    public granularity?: string;
    public telemetryType?: string;
    public observedAfter: string;
    public observedBefore: string;

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

TypeScript SearchTelemetriesRequest DTOs

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
			]
		}
	}
}