Foundry API

StartJobRequest

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class StartJobRequest : PostOperationTenanted<StartJobResponse>()
{
    var machineId:String? = null
    var startedAt:Date? = null
    var name:String? = null
    var totalLayers:Int? = null
}

open class PostOperationTenanted<TResponse> : PostOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class PostOperationUnTenanted<TResponse> : IPost
{
}

open class StartJobResponse
{
    var responseStatus:ResponseStatus? = null
    var job:Job? = null
}

open class Job : IIdentifiableResource
{
    var machineId:String? = null
    var name:String? = null
    var totalLayers:Int? = null
    var startedAt:Date? = null
    var finishedAt:Date? = null
    var aborted:Boolean? = null
    var id:String? = null
}

Kotlin StartJobRequest DTOs

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

HTTP + JSV

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

POST /jobs HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	machineId: String,
	name: String,
	totalLayers: 0,
	organisationId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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: ,
		aborted: False,
		id: String
	}
}