Jobs¶
This page outlines the operations, endpoints, parameters, and example requests and responses for the Jobs.
GET /api/v2/status/¶
List the async tasks that are currently running for your account
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/status/?offset=0&limit=0 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | true | This many results will be skipped. |
limit | query | integer | true | At most this many results are returned. If 0, all results. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"code": 0,
"created": "2019-08-24T14:15:22Z",
"description": "string",
"message": "string",
"status": "ABORTED",
"statusId": "string",
"statusType": "string",
"type": "Dataset"
}
],
"next": "http://example.com",
"previous": "http://example.com"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The list of statuses | StatusListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/status/{statusId}/¶
Destroy an async status object
Code samples¶
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/status/{statusId}/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
statusId | path | string | true | The ID of the status object. |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Successfully deleted | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/status/{statusId}/¶
Check the status of an asynchronous task such as project creation
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/status/{statusId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
statusId | path | string | true | The ID of the status object. |
Example responses¶
200 Response
{
"code": 0,
"created": "2019-08-24T14:15:22Z",
"description": "string",
"message": "string",
"status": "ABORTED",
"statusId": "string",
"statusType": "string",
"type": "Dataset"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The status of the asynchronous task | StatusRetrieveResponse |
303 | See Other | Task is completed, see Location header for the location of a new resource | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | Location | string | A url that can be polled to check the status. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas¶
StatusListResponse
{
"count": 0,
"data": [
{
"code": 0,
"created": "2019-08-24T14:15:22Z",
"description": "string",
"message": "string",
"status": "ABORTED",
"statusId": "string",
"statusType": "string",
"type": "Dataset"
}
],
"next": "http://example.com",
"previous": "http://example.com"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
count | integer | false | Number of items returned on this page. | |
data | [StatusRetrieveResponse] | true | An array of currently running async status jobs. | |
next | string(uri)¦null | true | URL pointing to the next page (if null, there is no next page). | |
previous | string(uri)¦null | true | URL pointing to the previous page (if null, there is no previous page). |
StatusRetrieveResponse
{
"code": 0,
"created": "2019-08-24T14:15:22Z",
"description": "string",
"message": "string",
"status": "ABORTED",
"statusId": "string",
"statusType": "string",
"type": "Dataset"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | integer | true | If no error occurred, 0. Otherwise, may contain a status code reflecting the error. | |
created | string(date-time) | true | The time the status record was created. | |
description | string¦null | true | A description of the task being performed, if applicable | |
message | string¦null | true | May contain further information about the status. | |
status | string | true | The status of the task. | |
statusId | string | true | The ID of the status object. | |
statusType | string¦null | false | The type of thing being created by the Task, if applicable. | |
type | string¦null | false | The type of thing being created by the Task, if applicable. |
Enumerated Values¶
Property | Value |
---|---|
status | [ABORTED , COMPLETED , ERROR , EXPIRED , INITIALIZED , RUNNING ] |
type | [Dataset , Testing , CustomModelBlueprintBuild , CustomModelFeatureImpact , ProjectPermanentDeletion ] |