- URL:
- https://<root>/notebooks/jobs
- Methods:
GET- Child Resources:
- Job, Cancel job
- Version Introduced:
- 11.4
Access requirements
Required privileges
The ArcGIS Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
To access notebook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above as well as the Create and edit notebooks privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the ArcGIS Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the ArcGIS Portal Directory API. For security reasons, all POST requests made to the ArcGIS Enterprise Administrator API must include a token in the request body.
Description
The jobs resource returns a list of interactive and automatic notebook jobs, including open and execute jobs triggered by API requests, notebook tasks, web tools, and webhooks. An administrator can view all jobs, while non-administrative notebook users can only see notebook jobs they own.
Request parameters
| Parameter | Details |
|---|---|
(Optional) | Introduced at ArcGIS Enterprise on Kubernetes 12.1. Set this parameter to true to obtain full job details. By default the jobs resource returns an abbreviated response. Values: |
(Optional) | The response format. The default response format is Values: |
Example usages
The following is a sample request URL used to access the jobs resource that includes the default value for the details parameter:
https://organization.example.com/<context>/admin/notebooks/jobs?f=json&details=falseThe following sample JSON response is returned when details is false:
{
"asyncNotebookJobs": [
{
"jobId": "jllqhst373b6zkumo6xg03u6z16p1zkuf",
"startTime": 1747664140996,
"endTime": 1747664335113,
"type": "executeNotebook",
"status": "COMPLETED",
"username": "user1"
},
{
"jobId": "ja76kwqaiu62gql24bnyg60w2zlikz9i7",
"startTime": 1747663733448,
"endTime": 1747663734027,
"type": "executeNotebook",
"status": "FAILED",
"username": "user1"
},
{
"jobId": "jsmxxqor3lqg0qv7gt1co3fmutfhgb0kr",
"startTime": 1747664863350,
"endTime": 0,
"type": "executeNotebook",
"status": "EXECUTING",
"username": "user2"
},
{
"jobId": "jms7ypxnt8yccra3q46163d7w8ofqqk87",
"startTime": 1747664998517,
"endTime": 0,
"type": "executeNotebook",
"status": "SUBMITTED",
"username": "user2"
},
{
"jobId": "jsiprxjotfr8lhwjgrds14pl3d2056pwj",
"startTime": 1747665055187,
"endTime": 1747665107274,
"type": "openNotebook",
"status": "COMPLETED",
"username": "user2"
},
{
"jobId": "je5h31ng58b8agahs63763vsfo526cti2",
"startTime": 1747666049540,
"endTime": 0,
"type": "executeNotebookAsWebTool",
"status": "EXECUTING",
"username": "user3"
}
]
}JSON Response example
{"notebookJobs": [{
"privateUrl": "",
"notebookRuntimeName": "ArcGIS Notebook Python 3 Standard",
"jobId": "j75a8b604-8697-441a-9842-2e3c0b215c23",
"dateCreated": 1731011993758,
"inputs": {
"itemId": "d9c20adc5f95476590be87f1e6eb1dba",
"executionTimeoutInMinutes": 10000000,
"updatePortalItem": true,
"saveInjectedParameters": false,
"runId": "",
"taskId": ""
},
"id": "5c16fe9b-3471-4ddc-9cfc-88f6e59c4fcc",
"notebookRuntimeId": "e9558e8e-0f1f-4d11-b509-815193312940",
"type": "executeNotebook",
"url": "",
"username": "joe",
"notebookRuntimeVersion": "11.0",
"revision": 1731011993758
}]}