Foundry API

SearchTelemetriesRequest

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

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class SearchTelemetriesRequest : SearchOperationTenanted<SearchTelemetriesResponse>()
{
    var id:String? = null
    var granularity:String? = null
    var telemetryType:String? = null
    var observedAfter:Date? = null
    var observedBefore:Date? = null
}

open class SearchOperationTenanted<TResponse> : SearchOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class SearchOperationUnTenanted<TResponse> : GetOperationUnTenanted<TResponse>(), IHasSearchOptions
{
    var distinct:String? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:String? = null
    var filter:String? = null
}

open class GetOperationUnTenanted<TResponse> : IHasGetOptions, IGet
{
    var embed:String? = null
}

open class SearchTelemetriesResponse : SearchOperationResponse()
{
    var granularity:String? = null
    @SerializedName("type") var Type:String? = null
    var from:Date? = null
    var to:Date? = null
    var telemetries:ArrayList<SummarisedTelemetry> = ArrayList<SummarisedTelemetry>()
    var responseStatus:ResponseStatus? = null
}

open class SearchOperationResponse
{
    var metadata:SearchMetadata? = null
}

open class SearchMetadata
{
    var total:Int? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:Sorting? = null
    var filter:Filtering? = null
}

open class Sorting
{
    @SerializedName("by") var By:String? = null
    var direction:SortDirection? = null
}

enum class SortDirection
{
    Ascending,
    Descending,
}

open class Filtering
{
    var fields:ArrayList<String> = ArrayList<String>()
}

open class SummarisedTelemetry
{
    @SerializedName("type") var Type:String? = null
    var value:String? = null
    var observedAt:Date? = null
}

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