| GET | /jobs |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MachineId | query | string | No | |
| Completed | query | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrganisationId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Distinct | form | string | No | |
| Limit | form | int? | No | |
| Offset | form | int? | No | |
| Sort | form | string | No | |
| Filter | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Embed | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Jobs | form | List<Job> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Metadata | form | SearchMetadata | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Total | form | int | No | |
| Limit | form | int | No | |
| Offset | form | int | No | |
| Sort | form | Sorting | No | |
| Filter | form | Filtering | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| By | form | string | No | |
| Direction | form | SortDirection | No |
| Ascending | |
| Descending |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Fields | form | List<string> | 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 | |
| Jobs | form | List<Job> | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /jobs HTTP/1.1 Host: foundrystage-api-app.azurewebsites.net Accept: application/json
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"}},"jobs":[{"machineId":"String","name":"String","totalLayers":0,"finishedAt":null,"aborted":false,"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"]}}}