- URL:https://<notebookserveradmin>/system/jobs/<jobID>
- Required Capability:Administrator or Create and Edit ArcGIS Notebooks
- Version Introduced:10.7
Description
A job represents the asynchronous execution of an operation in ArcGIS Notebook Server. You can acquire progress information by periodically querying the job resource.
Request parameters
Parameter | Details |
---|---|
f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
https://gisserver.domain.com:11443/arcgis/admin/system/jobs/jf9322f05-6b31-4bdd-8d42-be471fe904eb7?f=pjson
JSON Response syntax
Example one
A job response for the openNotebook operation:
{
"jobId": "<jobId>",
"inputs": {
"itemId": "itemId"
},
"startTime": start time in epoch milliseconds,
"endTime": start time in epoch milliseconds,
"results": {
"notebookUrl": "<notebookUrl>",
"notebookId": "<notebookId>"
},
"type": "openNotebook",
"status": "SUBMITTED|PROCESSING|FAILED|COMPLETED",
"username": "<username>",
"customAttributes": {
"isCancelled": true|false
}
}
Example two
A job response for the executeNotebook operation:
{
"jobId": "<jobId>",
"inputs": {
"itemId": "itemId",
"updatePortalItem": true|false,
"saveInjectedParameters": true|false,
"notebookParameters": "{\"parameter name 1\":\"parameter value 1\",\"parameter name 2\":\"parameter value2\"}",
"executeJobUpdated": true|false
},
"startTime": start time in epoch milliseconds,
"endTime": start time in epoch milliseconds,
"results": {
"containerConfigStoreId": "<containerConfigStoreId>"
},
"messages": ["message1", "message2", "message3", "message4", "message5"],
"type": "executeNotebook",
"status": "SUBMITTED|PROCESSING|FAILED|COMPLETED",
"username": "<username>",
"customAttributes": {
"isCancelled": true|false
}
}
JSON Response examples
Job responses for the openNotebook operation
Example one
A job status response for an openNotebook request in its SUBMITTED state:
{
"jobId": "jf9322f05-6b31-4bdd-8d42-be471fe904eb",
"startTime": 1600418685508,
"type": "openNotebook",
"status": "SUBMITTED",
"username": "admin",
"customAttributes": {
"isCancelled": false
}
}
Example two
A job status response for an openNotebook request in its PROCESSING state:
{
"jobId": "j52c9f6a4-2a7c-418f-a360-0ce757077342",
"inputs": {
"itemId": "c21213a381804c85935f50a1349a390f"
},
"startTime": 1600419767280,
"type": "openNotebook",
"results": {},
"status": "PROCESSING",
"username": "admin",
"customAttributes": {
"isCancelled": false
}
}
Example three
A job status response for an openNotebook request in its COMPLETED state:
{
"jobId": "j52c9f6a4-2a7c-418f-a360-0ce757077342",
"inputs": {
"itemId": "c21213a381804c85935f50a1349a390f"
},
"startTime": 1600419767280,
"endTime": 1600419770042,
"type": "openNotebook",
"results": {
"notebookUrl": "https://machine.domain.com/notebookserver/notebooks/4a491bea47864f91b4aee7ae2c4739e3/notebooks/c21213a381804c85935f50a1349a390f.ipynb",
"notebookId": "0a465abc08ed4fe8ac087f204222fb02"
},
"status": "COMPLETED",
"username": "admin",
"customAttributes": {
"isCancelled": false
}
}
Job response for the executeNotebook operation
Example one
A job status response for an executeNotebook request in its SUBMITTED state:
{
"jobId": "j252e2b9a-4f35-4737-ad98-33465b3db57a",
"startTime": 1600420355086,
"type": "executeNotebook",
"status": "SUBMITTED",
"username": "admin",
"customAttributes": {
"isCancelled": false
}
}
Example two
A job status response for an executeNotebook request in its PROCESSING state:
{
"jobId": "j6185135c-92a8-4402-b8de-90a66dc61fcc",
"inputs": {
"itemId": "c21213a381804c85935f50a1349a390f",
"updatePortalItem": true,
"saveInjectedParameters": true,
"notebookParameters": "{\"Abbr\":\"CA\",\"Name\":\"California\"}",
"executeJobUpdated": false
},
"startTime": 1600419894050,
"type": "executeNotebook",
"results": {
"containerConfigStoreId": "408119d098564c1c9c0448c31d1db32b"
},
"status": "PROCESSING",
"username": "admin",
"customAttributes": {
"isCancelled": false
}
}
Example three
A job status response for an executeNotebook request in its COMPLETED state:
{
"jobId": "j6185135c-92a8-4402-b8de-90a66dc61fcc",
"inputs": {
"itemId": "c21213a381804c85935f50a1349a390f",
"updatePortalItem": true,
"saveInjectedParameters": true,
"notebookParameters": "{\"Abbr\":\"CA\",\"Name\":\"California\"}",
"executeJobUpdated": false
},
"messages": ["Input Notebook Path: /arcgis/home/.tasks/j6185135c-92a8-4402-b8de-90a66dc61fcc/c21213a381804c85935f50a1349a390f.ipynb", "Output Notebook Path: /arcgis/home/.tasks/j6185135c-92a8-4402-b8de-90a66dc61fcc/output.ipynb", "Start processing time: 2020-09-18 09:05:04.315161", "Finish processing time: 2020-09-18 09:05:35.189362", "Successfully completed."],
"startTime": 1600419894050,
"endTime": 1600419939146,
"type": "executeNotebook",
"results": {
"containerConfigStoreId": "408119d098564c1c9c0448c31d1db32b"
},
"status": "COMPLETED",
"username": "admin",
"customAttributes": {
"isCancelled": false
}
}