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

Parameter	Details
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

Example usage

Use dark colors for code blocksCopy
https://notebookservermachine.domain.com/webadaptor/admin/services/buffer.GPServer?f=json

JSON Response syntax

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

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