Foundry API

<back to all web services

SearchTelemetriesRequest

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

namespace Application.Interfaces
{
    public partial class Filtering
    {
        public Filtering()
        {
            Fields = new List<string>{};
        }

        public virtual List<string> Fields { get; set; }
    }

    public partial class SearchMetadata
    {
        public virtual int Total { get; set; }
        public virtual int Limit { get; set; }
        public virtual int Offset { get; set; }
        public virtual Sorting Sort { get; set; }
        public virtual Filtering Filter { get; set; }
    }

    public enum SortDirection
    {
        Ascending,
        Descending,
    }

    public partial class Sorting
    {
        public virtual string By { get; set; }
        public virtual SortDirection Direction { get; set; }
    }

}

namespace Application.Interfaces.Resources
{
    public partial class SummarisedTelemetry
    {
        public virtual string Type { get; set; }
        public virtual string Value { get; set; }
        public virtual DateTime ObservedAt { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

    public partial class SearchOperationResponse
    {
        public virtual SearchMetadata Metadata { get; set; }
    }

    public partial class SearchOperationTenanted<TResponse>
        : SearchOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class SearchOperationUnTenanted<TResponse>
        : GetOperationUnTenanted<TResponse>, IHasSearchOptions
    {
        public virtual string Distinct { get; set; }
        public virtual int? Limit { get; set; }
        public virtual int? Offset { get; set; }
        public virtual string Sort { get; set; }
        public virtual string Filter { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Telemetries
{
    public partial class SearchTelemetriesRequest
        : SearchOperationTenanted<SearchTelemetriesResponse>
    {
        public virtual string Id { get; set; }
        public virtual string Granularity { get; set; }
        public virtual string TelemetryType { get; set; }
        public virtual DateTime ObservedAfter { get; set; }
        public virtual DateTime ObservedBefore { get; set; }
    }

    public partial class SearchTelemetriesResponse
        : SearchOperationResponse
    {
        public SearchTelemetriesResponse()
        {
            Telemetries = new List<SummarisedTelemetry>{};
        }

        public virtual string Granularity { get; set; }
        public virtual string Type { get; set; }
        public virtual DateTime From { get; set; }
        public virtual DateTime To { get; set; }
        public virtual List<SummarisedTelemetry> Telemetries { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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