Foundry API

<back to all web services

SearchTelemetriesRequest

import Foundation
import ServiceStack

public class SearchTelemetriesRequest : SearchOperationTenanted<SearchTelemetriesResponse>
{
    public var id:String?
    public var granularity:String?
    public var telemetryType:String?
    public var observedAfter:Date?
    public var observedBefore:Date?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case granularity
        case telemetryType
        case observedAfter
        case observedBefore
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(String.self, forKey: .id)
        granularity = try container.decodeIfPresent(String.self, forKey: .granularity)
        telemetryType = try container.decodeIfPresent(String.self, forKey: .telemetryType)
        observedAfter = try container.decodeIfPresent(Date.self, forKey: .observedAfter)
        observedBefore = try container.decodeIfPresent(Date.self, forKey: .observedBefore)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if granularity != nil { try container.encode(granularity, forKey: .granularity) }
        if telemetryType != nil { try container.encode(telemetryType, forKey: .telemetryType) }
        if observedAfter != nil { try container.encode(observedAfter, forKey: .observedAfter) }
        if observedBefore != nil { try container.encode(observedBefore, forKey: .observedBefore) }
    }
}

public class SearchOperationTenanted<TResponse : Codable> : SearchOperationUnTenanted<TResponse>, ITenantedRequest
{
    public var organisationId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case organisationId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        organisationId = try container.decodeIfPresent(String.self, forKey: .organisationId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if organisationId != nil { try container.encode(organisationId, forKey: .organisationId) }
    }
}

public class SearchOperationUnTenanted<TResponse : Codable> : GetOperationUnTenanted<TResponse>, IHasSearchOptions
{
    public var distinct:String?
    public var limit:Int?
    public var offset:Int?
    public var sort:String?
    public var filter:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case distinct
        case limit
        case offset
        case sort
        case filter
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        distinct = try container.decodeIfPresent(String.self, forKey: .distinct)
        limit = try container.decodeIfPresent(Int.self, forKey: .limit)
        offset = try container.decodeIfPresent(Int.self, forKey: .offset)
        sort = try container.decodeIfPresent(String.self, forKey: .sort)
        filter = try container.decodeIfPresent(String.self, forKey: .filter)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if distinct != nil { try container.encode(distinct, forKey: .distinct) }
        if limit != nil { try container.encode(limit, forKey: .limit) }
        if offset != nil { try container.encode(offset, forKey: .offset) }
        if sort != nil { try container.encode(sort, forKey: .sort) }
        if filter != nil { try container.encode(filter, forKey: .filter) }
    }
}

public class GetOperationUnTenanted<TResponse : Codable> : IHasGetOptions, IGet, Codable
{
    public var embed:String?

    required public init(){}
}

public class SearchTelemetriesResponse : SearchOperationResponse
{
    public var granularity:String?
    public var type:String?
    public var from:Date?
    public var to:Date?
    public var telemetries:[SummarisedTelemetry] = []
    public var responseStatus:ResponseStatus?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case granularity
        case type
        case from
        case to
        case telemetries
        case responseStatus
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        granularity = try container.decodeIfPresent(String.self, forKey: .granularity)
        type = try container.decodeIfPresent(String.self, forKey: .type)
        from = try container.decodeIfPresent(Date.self, forKey: .from)
        to = try container.decodeIfPresent(Date.self, forKey: .to)
        telemetries = try container.decodeIfPresent([SummarisedTelemetry].self, forKey: .telemetries) ?? []
        responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if granularity != nil { try container.encode(granularity, forKey: .granularity) }
        if type != nil { try container.encode(type, forKey: .type) }
        if from != nil { try container.encode(from, forKey: .from) }
        if to != nil { try container.encode(to, forKey: .to) }
        if telemetries.count > 0 { try container.encode(telemetries, forKey: .telemetries) }
        if responseStatus != nil { try container.encode(responseStatus, forKey: .responseStatus) }
    }
}

public class SearchOperationResponse : Codable
{
    public var metadata:SearchMetadata?

    required public init(){}
}

public class SearchMetadata : Codable
{
    public var total:Int?
    public var limit:Int?
    public var offset:Int?
    public var sort:Sorting?
    public var filter:Filtering?

    required public init(){}
}

public class Sorting : Codable
{
    public var by:String?
    public var direction:SortDirection?

    required public init(){}
}

public enum SortDirection : String, Codable
{
    case Ascending
    case Descending
}

public class Filtering : Codable
{
    public var fields:[String] = []

    required public init(){}
}

public class SummarisedTelemetry : Codable
{
    public var type:String?
    public var value:String?
    public var observedAt:Date?

    required public init(){}
}

Swift 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
			]
		}
	}
}