Foundry API

StartJobRequest

The following routes are available for this service:
POST	/jobs

namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Job() = 
        member val MachineId:String = null with get,set
        member val Name:String = null with get,set
        member val TotalLayers:Int32 = new Int32() with get,set
        member val StartedAt:DateTime = new DateTime() with get,set
        member val FinishedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Aborted:Boolean = new Boolean() with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type StartJobResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Job:Job = null with get,set

    [<AllowNullLiteral>]
    type StartJobRequest() = 
        inherit PostOperationTenanted<StartJobResponse>()
        member val MachineId:String = null with get,set
        member val StartedAt:DateTime = new DateTime() with get,set
        member val Name:String = null with get,set
        member val TotalLayers:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PostOperationTenanted<'TResponse>() = 
        inherit PostOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationUnTenanted<'TResponse>() = 
        interface IPost

F# StartJobRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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>