Jobs (Notebooks)

URL:: https://<root>/notebooks/jobs
Methods:: GET
Child Resources:: Job, Cancel job
Required Capability:: Access allowed with "Create and edit notebooks" privilege
Version Introduced:: 11.4

Description

The jobs resource returns a list of interactive and automatic notebook jobs, such as executeNotebooks, web tools, scheduled tasks, and notebook webhooks. An administrator will be able to view all jobs, and a non-administrative notebook user will only see notebook jobs they own. The jobs 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

Parameter	Details
`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 the jobs resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/notebooks/jobs?f=json

JSON Response example

Use dark colors for code blocksCopy
{"asyncNotebookJobs": [
    {
        "jobId": "jllqhst373b6zkumo6xg03u6z16p1zkuf",
        "name": "executeNotebook",
        "startTime": 1747664140996,
        "endTime": 1747664335113,
        "status": "COMPLETED"
    },
    {
        "jobId": "ja76kwqaiu62gql24bnyg60w2zlikz9i7",
        "name": "executeNotebook",
        "startTime": 1747663733448,
        "endTime": 1747663734027,
        "status": "FAILED"
    },
    {
        "jobId": "jsmxxqor3lqg0qv7gt1co3fmutfhgb0kr",
        "name": "executeNotebook",
        "startTime": 1747664863350,
        "endTime": 0,
        "status": "EXECUTING"
    },
    {
        "jobId": "jms7ypxnt8yccra3q46163d7w8ofqqk87",
        "name": "executeNotebook",
        "startTime": 1747664998517,
        "endTime": 0,
        "status": "SUBMITTED"
    },
    {
        "jobId": "jsiprxjotfr8lhwjgrds14pl3d2056pwj",
        "name": "openNotebook",
        "startTime": 1747665055187,
        "endTime": 1747665107274,
        "status": "COMPLETED"
    },
 {
        "jobId": "je5h31ng58b8agahs63763vsfo526cti2",
        "name": "executeNotebookAsWebTool",
        "startTime": 1747666049540,
        "endTime": 0,
        "status": "EXECUTING"
    }
]}

JSON Response example

Use dark colors for code blocksCopy
{"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
}]}