Job (Notebook Jobs)

URL:
https://<root>/notebooks/jobs/<jobId>
Methods:
GET
Required Capability:
Access allowed with "Create and edit notebooks" privilege
Version Introduced:
11.4

Description

A job resource returns the progress and status messages of a Notebook automation job, such as executeNotebooks, web tools, scheduled tasks, and notebook webhooks. Updated progress information can be acquired by periodically querying this resource. An administrator will be able to view jobs owned by any user, and a non-administrative notebook user will only be able to see notebook jobs of their own. The job resource is removed after a job is completed successfully or if there is a failure. Notebook job information can also be obtained from the admin jobs resource.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access a job resource:

Use dark colors for code blocksCopy
1
https://organization.domain.com/context/admin/notebooks/jobs/j69a35465-0cf4-4e4f-a815-7e90fb5d5a2f?f=json

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "privateUrl": "",
    "inputs": {
        "itemId": "d9c20adc5f95476590be87f1e6eb1dba",
        "executionTimeoutInMinutes": 10000000,
        "updatePortalItem": true,
        "saveInjectedParameters": false,
        "runId": "",
        "taskId": ""
    },
    "type": "executeNotebook",
    "url": "",
    "notebookRuntimeVersion": "11.0",
    "revision": 1731012905732,
    "notebookRuntimeName": "ArcGIS Notebook Python 3 Standard",
    "jobId": "j69a35465-0cf4-4e4f-a815-7e90fb5d5a2f",
    "dateCreated": 1731012905732,
    "id": "10559837-a784-4064-8919-9542a78e8438",
    "notebookRuntimeId": "e9558e8e-0f1f-4d11-b509-815193312940",
    "username": "Joe",
    "status": "EXECUTING"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.