Services

• URL: https://<notebookserveradmin>/services
  
• Required Capability:Administrator or Create and Edit ArcGIS Notebooks
• Version Introduced:10.9.1

Description

The services resource is a container of services published on Notebook Server. You can create a geoprocessing service (web tool) using the createService operation. The types resource returns a list of all service types and their extensions supported on ArcGIS Notebook Server.

This list includes services published by all users when accessed by an administrator. Users with the Publish Web Tool privileges who are not administrators can see only their services listed.

Request parameters

Parameter	Details
start	The number of the first entry in the result set response. The index number is 1-based. Default value: 1 Example: start=5
num	The maximum number of results to be included in the result set response. The default value is 10, and the maximum allowed value is 100. Note: The actual number of returned results may be less than num. This occurs when the number of results remaining after start is less than num. Example: //Returns a maximum of 50 results in a response num=50
f	The response format. The default response format is html. Values: html | json | pjson

Example usage

https://machine.domain.com/webadaptor/admin/services?f=json

JSON Response syntax

{ 
  "total" : <total number of results>,
  "start" : <The number of the first entry in the result set response>,
  "num": < maximum number of results to be included in the result set response >,
  "services": [ 
    { 
      "owner": "service 1 owner username", 
      "name": "service name", 
      "id": "itemId of Web Tool item 1", 
      "type": "GPServer" 
    }, 
    { 
      "owner": "service 2 owner username", 
      "name": "service name", 
      "id": "itemId of Web Tool item 2", 
      "type": "GPServer" 
    } 
  ], 
  "currentVersion": "currentVersion" 
}

JSON Response example

{
  "total": 3,
  "num": 10,
  "start": 1,
  "services": [
    {
      "owner": "nbdemo",
      "name": "Calculate Market Area",
      "id": "d83d3a26a6be47e88d44337aa655ece1",
      "type": "GPServer"
    },
    {
      "owner": "nbdemo",
      "name": "EV Route Planning Tool",
      "id": "928975fc42454fb39626db5d178a8e38",
        "type": "GPServer"
      },
      {
        "owner": "nbdemo",
        "name": "Web tool demo",
        "id": "d38b2de4b3844703887228b9db256b7c",
        "type": "GPServer"
      }
    ],
    "currentVersion": 11.1
}