Edit GP service

URL:
https://<notebookserveradmin>/services/serviceName.GPServer/edit
Methods:
POST
Required Capability:
Create and Edit and Publish Web Tools
Version Introduced:
11.0

Description

ArcGIS Notebook Server supports overwriting a geoprocessing service previously published from a notebook.

The edit operation overwrites a service when an updated JSON representation of the service is submitted to it. A new snapshot of the notebook is automatically created for the web tool when the service is overwritten.

Read and input the serviceProperties of the service to be edited into the edit operation.

You must either be a user with administrative privileges or the owner of the notebook and web tool being edited.

Request parameters

ParameterDetails

serviceProperties

The JSON representation of the service being created.

Example

1
2
3
{"description": "Description of the web tool", "provider": "notebooks",
 "type": "GPServer","jsonProperties": {"title": "title","notebookId": "notebookId",
 "tasks": [{"type": "notebook", "name": "taskName" }]}}

f

The response format. The default response format is html .

Values: html

Example usage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
serviceProperties={
  "extensions": [],
  "provider": "notebooks",
  "jsonProperties": {
    "snapshotId": "execute-notebook-snapshot-7b5b9f746db14bf983fcd0112cbad96e.json",
    "notebookId": "8182aa0f33324e1a9184889e13c36a4b",
    "title": "webtoolTitle",
    "tasks": [
      {
        "name": "taskName",
        "type": "notebook"
      }
    ]
  },
  "description": "Description of task",
  "datasets": [],
  "serviceName": "13187da5eedd412d871a224072fca07d",
  "type": "GPServer",
  "frameworkProperties": {},
  "portalProperties": {
    "isHosted": false,
    "portalItems": [
      {
        "itemID": "13187da5eedd412d871a224072fca07d",
        "type": "GPServer"
      }
    ]
  }
}

JSON Response syntax

1
{"status": "<success|failure>"}

JSON Response example

1
{"status": "success"}

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