Job (Notebook Jobs) | ArcGIS REST APIs

URL:: https://<root>/notebooks/jobs/<jobId>
Methods:: GET
Version Introduced:: 11.4

Access requirements

Required privileges

The 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.

Manage licenses Link to organization-specific group Update Delete Security and infrastructure Servers Organization website Organization webhooks

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 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 generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

A job resource returns the progress and status messages of an interactive or automated notebook 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

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 a job resource:

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

JSON Response example

Use dark colors for code blocksCopy
{
    "jobId": "jms7ypxnt8yccra3q46163d7w8ofqqk87",
    "inputs": {
        "itemId": "f69a8c21f86c49eca97beb3a113fb3e2",
        "executionTimeoutInMinutes": 10000000,
        "updatePortalItem": true,
        "saveInjectedParameters": true,
        "notebookParameters": "{\"Abbr\":\"CA\",\"Name\":\"California\"}",
        "runId": "",
        "taskId": ""
    },
    "name": "executeNotebook",
    "messages": [],
    "startTime": 1747664998517,
    "endTime": 1747665098818,
    "status": "COMPLETED",
    "username": "user1",
    "customAttributes": {}
}

JSON Response example

Use dark colors for code blocksCopy
{
    "result": {"notebookUrl": "https://gke-cloudnative-cert-sql.dev.geocloud.com/arcgis/notebooks/c20cafea-c6a3-4e20-bfcb-3c4fce053890/notebooks/281ca86b6fd8475a9d5a1b27844e7180.ipynb"},
    "jobId": "jkclobhs1k0pj7eqsx53a0lvyskil8w5c",
    "inputs": {
        "agsDeploymentId": "kgmxqbw6jcojtj0wl7m2f",
        "itemId": "281ca86b6fd8475a9d5a1b27844e7180"
    },
    "name": "openNotebook",
    "messages": [],
    "startTime": 1747665805565,
    "endTime": 1747665846040,
    "status": "COMPLETED",
    "username": "administrator",
    "customAttributes": {}
}

JSON Response example

Use dark colors for code blocksCopy
{
    "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": "user1",
    "status": "EXECUTING"
}