Service

URL:
https://<notebookserveradmin>/services/<serviceName.serviceType>
Methods:
GET
Required Capability:
Administrator or Create and Edit
Version Introduced:
10.9.1

Description

The service resource represents services published to ArcGIS Notebook Server. ArcGIS Notebook Server allows you to publish a notebook as an asynchronous geoprocessing service that is shared as a web tool in the portal and supports the REST services API.

Request parameters

ParameterDetails

f

The response format. The default response format is html .

Values: html | json | pjson

Example usage

1
https://notebookservermachine.domain.com/webadaptor/admin/services/buffer.GPServer?f=json

JSON Response syntax

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "extensions": [],
  "provider": "notebooks",
  "description": "<Service Description>",
  "datasets": [],
  "serviceName": "<Service Name - defaults to itemId of Web Tool item >",
  "type": "GPServer",
  "frameworkProperties": {},
  "portalProperties": {
    "isHosted": false,
    "portalItems": [
      {
        "itemID": "< itemId of Web Tool item>",
        "type": "GPServer"
      }
    ]
  },
  "properties": {
    "tasks": [
      "<itemId of source Notebook item>"
    ]
  }
}

JSON Response example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "extensions": [],
  "provider": "notebooks",
  "description": "This is a web tool for buffering a feature layer",
  "datasets": [],
  "serviceName": "da53e59c3ae847e0999d71d0ff898d9d",
  "type": "GPServer",
  "frameworkProperties": {},
  "portalProperties": {
    "isHosted": false,
    "portalItems": [
      {
        "itemID": "da53e59c3ae847e0999d71d0ff898d9d",
        "type": "GPServer"
      }
    ]
  },
  "properties": {
    "tasks": [
      "bea9ca994f6749ab8ad3868f3124521a"
    ]
  }
}

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close