Delete From Definition (Feature Service)

Description

The deleteFromDefinition operation supports deleting a definition property from a hosted feature service. The result of this operation is a response indicating success or failure with error code and description.

New at 11.4

This operation now supports performing asynchronous requests for ArcGIS Enterprise hosted feature services.

Request parameters

Example usage

Below is a sample URL used to access the deleteFromDefinition operation:

1
https://services.myserver.com/OrgID/ArcGIS/rest/admin/services/example1/FeatureServer/deleteFromDefinition

Example input for the deleteFromDefinition parameter:

1
2
3
4
5
6
7
8
9
10
{
  "layers": [
    {
      "id": "0"
    },
    {
      "id": "1"
    }
  ]
}

JSON Response syntax

The example below reflects the syntax of a synchronous response:

1
2
3
4
5
6
7
8
9
10
{
  "success": <true|false>,
  "error": {
    "code": <code>,
    "message": "<description>",
    "details": [
      "<message>"
    ]
  }
}

The example below reflects the syntax of an asynchronous response:

1
{"statusURL": “<response status URL>”}

JSON Response examples

Synchronous responses

When deleteFromDefinition succeeds as a synchronous response:

1
2
3
{
  "success": true
}

When deleteFromDefinition fails as a synchronous response:

1
2
3
4
5
6
7
8
9
{
  "error": {
    "code": 400,
    "message": "",
    "details": [
      "Unable to update feature service layer definition."
    ]
  }
}

Asynchronous responses

When an deleteFromDefinition request is submitted asynchronously, the response will include a statusURL, the value of which is a URL that can be accessed to check the status of the request:

1
2
3
{
  "statusURL": "https://machine.domain.com/ArcGIS/rest/admin/services/myhostedservice/FeatureServer/deleteFromDefinition/5f4f34c6-2bcf-41c7-8bd1-ea777570ad23"
}

The URL can be used to periodically check the progress of the request, which is returned as the status property. When the job completes, the response retrieved from the status URL will indicate whether the request completed successfully.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
//success

{
  "submissionTime":1726444564500,
  "lastUpdatedTime":1726444568893,
  "status":"Completed"
}

//failure

{
  "submissionTime": 1726520769240,
  "lastUpdatedTime": 1726520769773,
  "status": "Failed",
  "error": {
    "code": 500,
    "description": "Editing definition error - RCPerfTestOneWayAllRowsParent.DBO.Volcano_Roop "
  }
}