Foundry API

<back to all web services

GetRecentTelemetryRequest

import Foundation
import ServiceStack

public class GetRecentTelemetryRequest : GetOperationTenanted<GetRecentTelemetryResponse>
{
    public var id:String?
    public var targetTelemetryType:String?

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

    private enum CodingKeys : String, CodingKey {
        case id
        case targetTelemetryType
    }

    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)
        targetTelemetryType = try container.decodeIfPresent(String.self, forKey: .targetTelemetryType)
    }

    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 targetTelemetryType != nil { try container.encode(targetTelemetryType, forKey: .targetTelemetryType) }
    }
}

public class GetOperationTenanted<TResponse : Codable> : GetOperationUnTenanted<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 GetOperationUnTenanted<TResponse : Codable> : IHasGetOptions, IGet, Codable
{
    public var embed:String?

    required public init(){}
}

public class GetRecentTelemetryResponse : Codable
{
    public var telemetry:Telemetry?
    public var responseStatus:ResponseStatus?

    required public init(){}
}

public class Telemetry : IIdentifiableResource, Codable
{
    public var type:String?
    public var value:String?
    public var observedAt:Date?
    public var id:String?

    required public init(){}
}

Swift GetRecentTelemetryRequest DTOs

GET /machines/{Id}/telemetries/recent HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	telemetry: 
	{
		type: String,
		value: String,
		id: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}