Foundry API

<back to all web services

StartJobRequest

import Foundation
import ServiceStack

public class StartJobRequest : PostOperationTenanted<StartJobResponse>
{
    public var machineId:String?
    public var startedAt:Date?
    public var name:String?
    public var totalLayers:Int?

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

    private enum CodingKeys : String, CodingKey {
        case machineId
        case startedAt
        case name
        case totalLayers
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        machineId = try container.decodeIfPresent(String.self, forKey: .machineId)
        startedAt = try container.decodeIfPresent(Date.self, forKey: .startedAt)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        totalLayers = try container.decodeIfPresent(Int.self, forKey: .totalLayers)
    }

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

public class PostOperationTenanted<TResponse : Codable> : PostOperationUnTenanted<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 PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
    required public init(){}
}

public class StartJobResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var job:Job?

    required public init(){}
}

public class Job : IIdentifiableResource, Codable
{
    public var machineId:String?
    public var name:String?
    public var totalLayers:Int?
    public var startedAt:Date?
    public var finishedAt:Date?
    public var aborted:Bool?
    public var id:String?

    required public init(){}
}

Swift StartJobRequest DTOs

POST /jobs HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StartJobRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Jobs">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <MachineId>String</MachineId>
  <Name>String</Name>
  <StartedAt>0001-01-01T00:00:00</StartedAt>
  <TotalLayers>0</TotalLayers>
</StartJobRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StartJobResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Jobs">
  <Job xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Aborted>false</d2p1:Aborted>
    <d2p1:FinishedAt>0001-01-01T00:00:00</d2p1:FinishedAt>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:MachineId>String</d2p1:MachineId>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:StartedAt>0001-01-01T00:00:00</d2p1:StartedAt>
    <d2p1:TotalLayers>0</d2p1:TotalLayers>
  </Job>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</StartJobResponse>