Foundry API

<back to all web services

SearchTelemetriesRequest

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Telemetries
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces

        Public Partial Class Filtering
            Public Sub New()
                Fields = New List(Of String)
            End Sub

            Public Overridable Property Fields As List(Of String)
        End Class

        Public Partial Class SearchMetadata
            Public Overridable Property Total As Integer
            Public Overridable Property Limit As Integer
            Public Overridable Property Offset As Integer
            Public Overridable Property Sort As Sorting
            Public Overridable Property Filter As Filtering
        End Class

        Public Enum SortDirection
            Ascending
            Descending
        End Enum

        Public Partial Class Sorting
            Public Overridable Property By As String
            Public Overridable Property Direction As SortDirection
        End Class
    End Namespace

    Namespace Application.Interfaces.Resources

        Public Partial Class SummarisedTelemetry
            Public Overridable Property Type As String
            Public Overridable Property Value As String
            Public Overridable Property ObservedAt As Date
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class GetOperationUnTenanted(Of TResponse)
            Implements IHasGetOptions
            Implements IGet
            Public Overridable Property Embed As String
        End Class

        Public Partial Class SearchOperationResponse
            Public Overridable Property Metadata As SearchMetadata
        End Class

        Public Partial Class SearchOperationTenanted(Of TResponse)
            Inherits SearchOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class SearchOperationUnTenanted(Of TResponse)
            Inherits GetOperationUnTenanted(Of TResponse)
            Implements IHasSearchOptions
            Public Overridable Property Distinct As String
            Public Overridable Property Limit As Nullable(Of Integer)
            Public Overridable Property Offset As Nullable(Of Integer)
            Public Overridable Property Sort As String
            Public Overridable Property Filter As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Telemetries

        Public Partial Class SearchTelemetriesRequest
            Inherits SearchOperationTenanted(Of SearchTelemetriesResponse)
            Public Overridable Property Id As String
            Public Overridable Property Granularity As String
            Public Overridable Property TelemetryType As String
            Public Overridable Property ObservedAfter As Date
            Public Overridable Property ObservedBefore As Date
        End Class

        Public Partial Class SearchTelemetriesResponse
            Inherits SearchOperationResponse
            Public Sub New()
                Telemetries = New List(Of SummarisedTelemetry)
            End Sub

            Public Overridable Property Granularity As String
            Public Overridable Property Type As String
            Public Overridable Property From As Date
            Public Overridable Property To As Date
            Public Overridable Property Telemetries As List(Of SummarisedTelemetry)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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
			]
		}
	}
}