Foundry API

<back to all web services

GetRecentTelemetryRequest

Requires Authentication
The following routes are available for this service:
GET/machines/{Id}/telemetries/recent
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Telemetry() = 
        member val Type:String = null with get,set
        member val Value:String = null with get,set
        member val ObservedAt:DateTime = new DateTime() with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type GetRecentTelemetryResponse() = 
        member val Telemetry:Telemetry = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GetRecentTelemetryRequest() = 
        inherit GetOperationTenanted<GetRecentTelemetryResponse>()
        member val Id:String = null with get,set
        member val TargetTelemetryType:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationTenanted<'TResponse>() = 
        inherit GetOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationUnTenanted<'TResponse>() = 
        interface IGet
        member val Embed:String = null with get,set

F# GetRecentTelemetryRequest DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}