Foundry API

<back to all web services

SearchTelemetriesRequest

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SearchTelemetriesRequest extends SearchOperationTenanted<SearchTelemetriesResponse>
    {
        public String id = null;
        public String granularity = null;
        public String telemetryType = null;
        public Date observedAfter = null;
        public Date observedBefore = null;
        
        public String getId() { return id; }
        public SearchTelemetriesRequest setId(String value) { this.id = value; return this; }
        public String getGranularity() { return granularity; }
        public SearchTelemetriesRequest setGranularity(String value) { this.granularity = value; return this; }
        public String getTelemetryType() { return telemetryType; }
        public SearchTelemetriesRequest setTelemetryType(String value) { this.telemetryType = value; return this; }
        public Date getObservedAfter() { return observedAfter; }
        public SearchTelemetriesRequest setObservedAfter(Date value) { this.observedAfter = value; return this; }
        public Date getObservedBefore() { return observedBefore; }
        public SearchTelemetriesRequest setObservedBefore(Date value) { this.observedBefore = value; return this; }
    }

    public static class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public SearchOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
    {
        public String distinct = null;
        public Integer limit = null;
        public Integer offset = null;
        public String sort = null;
        public String filter = null;
        
        public String getDistinct() { return distinct; }
        public SearchOperationUnTenanted<TResponse> setDistinct(String value) { this.distinct = value; return this; }
        public Integer getLimit() { return limit; }
        public SearchOperationUnTenanted<TResponse> setLimit(Integer value) { this.limit = value; return this; }
        public Integer getOffset() { return offset; }
        public SearchOperationUnTenanted<TResponse> setOffset(Integer value) { this.offset = value; return this; }
        public String getSort() { return sort; }
        public SearchOperationUnTenanted<TResponse> setSort(String value) { this.sort = value; return this; }
        public String getFilter() { return filter; }
        public SearchOperationUnTenanted<TResponse> setFilter(String value) { this.filter = value; return this; }
    }

    public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
    {
        public String embed = null;
        
        public String getEmbed() { return embed; }
        public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
    }

    public static class SearchTelemetriesResponse extends SearchOperationResponse
    {
        public String granularity = null;
        public String type = null;
        public Date from = null;
        public Date to = null;
        public ArrayList<SummarisedTelemetry> telemetries = null;
        public ResponseStatus responseStatus = null;
        
        public String getGranularity() { return granularity; }
        public SearchTelemetriesResponse setGranularity(String value) { this.granularity = value; return this; }
        public String getType() { return type; }
        public SearchTelemetriesResponse setType(String value) { this.type = value; return this; }
        public Date getFrom() { return from; }
        public SearchTelemetriesResponse setFrom(Date value) { this.from = value; return this; }
        public Date getTo() { return to; }
        public SearchTelemetriesResponse setTo(Date value) { this.to = value; return this; }
        public ArrayList<SummarisedTelemetry> getTelemetries() { return telemetries; }
        public SearchTelemetriesResponse setTelemetries(ArrayList<SummarisedTelemetry> value) { this.telemetries = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public SearchTelemetriesResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class SearchOperationResponse
    {
        public SearchMetadata metadata = null;
        
        public SearchMetadata getMetadata() { return metadata; }
        public SearchOperationResponse setMetadata(SearchMetadata value) { this.metadata = value; return this; }
    }

    public static class SearchMetadata
    {
        public Integer total = null;
        public Integer limit = null;
        public Integer offset = null;
        public Sorting sort = null;
        public Filtering filter = null;
        
        public Integer getTotal() { return total; }
        public SearchMetadata setTotal(Integer value) { this.total = value; return this; }
        public Integer getLimit() { return limit; }
        public SearchMetadata setLimit(Integer value) { this.limit = value; return this; }
        public Integer getOffset() { return offset; }
        public SearchMetadata setOffset(Integer value) { this.offset = value; return this; }
        public Sorting getSort() { return sort; }
        public SearchMetadata setSort(Sorting value) { this.sort = value; return this; }
        public Filtering getFilter() { return filter; }
        public SearchMetadata setFilter(Filtering value) { this.filter = value; return this; }
    }

    public static class Sorting
    {
        public String by = null;
        public SortDirection direction = null;
        
        public String getBy() { return by; }
        public Sorting setBy(String value) { this.by = value; return this; }
        public SortDirection getDirection() { return direction; }
        public Sorting setDirection(SortDirection value) { this.direction = value; return this; }
    }

    public static enum SortDirection
    {
        Ascending,
        Descending;
    }

    public static class Filtering
    {
        public ArrayList<String> fields = null;
        
        public ArrayList<String> getFields() { return fields; }
        public Filtering setFields(ArrayList<String> value) { this.fields = value; return this; }
    }

    public static class SummarisedTelemetry
    {
        public String type = null;
        public String value = null;
        public Date observedAt = null;
        
        public String getType() { return type; }
        public SummarisedTelemetry setType(String value) { this.type = value; return this; }
        public String getValue() { return value; }
        public SummarisedTelemetry setValue(String value) { this.value = value; return this; }
        public Date getObservedAt() { return observedAt; }
        public SummarisedTelemetry setObservedAt(Date value) { this.observedAt = value; return this; }
    }

}

Java SearchTelemetriesRequest DTOs

GET /machines/{Id}/telemetries HTTP/1.1 
Host: staging-api.foundrylab.com 
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
			]
		}
	}
}