POST | /jobs |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MachineId | body | string | No | |
StartedAt | body | DateTime | No | |
Name | body | string | No | |
TotalLayers | body | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Job | form | Job | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MachineId | form | string | No | |
Name | form | string | No | |
TotalLayers | form | int | No | |
StartedAt | form | DateTime | No | |
FinishedAt | form | DateTime? | No | |
Aborted | form | bool | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Job | form | Job | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } }