Foundry API

<back to all web services

StartJobRequest

Requires Authentication
The following routes are available for this service:
POST/jobs
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Jobs
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Partial Class Job
            Implements IIdentifiableResource
            Public Overridable Property MachineId As String
            Public Overridable Property Name As String
            Public Overridable Property TotalLayers As Integer
            Public Overridable Property StartedAt As Date
            Public Overridable Property FinishedAt As Nullable(Of Date)
            Public Overridable Property Aborted As Boolean
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class PostOperationTenanted(Of TResponse)
            Inherits PostOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class PostOperationUnTenanted(Of TResponse)
            Implements IPost
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Jobs

        Public Partial Class StartJobRequest
            Inherits PostOperationTenanted(Of StartJobResponse)
            Public Overridable Property MachineId As String
            Public Overridable Property StartedAt As Date
            Public Overridable Property Name As String
            Public Overridable Property TotalLayers As Integer
        End Class

        Public Partial Class StartJobResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Job As Job
        End Class
    End Namespace
End Namespace

VB.NET StartJobRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"machineId":"String","name":"String","totalLayers":0,"organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"job":{"machineId":"String","name":"String","totalLayers":0,"finishedAt":null,"aborted":false,"id":"String"}}