Foundry API

<back to all web services

StartJobRequest

Requires Authentication
The following routes are available for this service:
POST/jobs
StartJobRequest Parameters:
NameParameterData TypeRequiredDescription
MachineIdbodystringNo
StartedAtbodyDateTimeNo
NamebodystringNo
TotalLayersbodyintNo
PostOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
StartJobResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
JobformJobNo
Job Parameters:
NameParameterData TypeRequiredDescription
MachineIdformstringNo
NameformstringNo
TotalLayersformintNo
StartedAtformDateTimeNo
FinishedAtformDateTime?No
AbortedformboolNo
IdformstringNo
StartJobResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
JobformJobNo

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: foundrystage-api-app.azurewebsites.net 
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
	}
}