Delete (Circuits) | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/UtilityNetworkServer/circuits/delete
Methods:: GETPOST
Version Introduced:: 11.x5

The delete operation on the circuits resource allows you to logically delete one or more circuits in a telecom domain network.

Request parameters

Parameter Details

Parameter	Details
`f`	Specifies the output format of the response. The default response format is `html`. Values: `html` \| `json` \| `pjson`
`gdbVersion` (Optional)	Specifies the name of the geodatabase version. The default is 'sde.DEFAULT'. Syntax: Use dark colors for code blocksCopy `1 2 gdbVersion=<version>`
`sessionId` (Optional)	Specifies the token (guid) used to lock the version. If a client has previously started an edit session and holds an exclusive lock on the version specified, the request will fail if the sessionId is not provided. If the specified version is currently locked by any other session, the request will fail if the sessionId is not provided or does not match the sessionId that holds the exclusive lock. Syntax: Use dark colors for code blocksCopy `1 2 sessionId=<guid>`
`domainNetworkName` (Required)	Specifies the name of the telecom domain network from which the circuit will be deleted. Syntax: Use dark colors for code blocksCopy `1 2 domainNetworkName=<string>` Example: Use dark colors for code blocksCopy `1 2 domainNetworkName=Telco`
`circuits` (Required)	The names of the circuit or circuits to be deleted. Syntax: Use dark colors for code blocksCopy `1 2 circuits=[<string>]` Example: Use dark colors for code blocksCopy `1 2 circuits=[CIRCUITA","CIRCUITB"]` Note When multiple circuits are specified, if one or more circuits fail to delete the entire operation is rolled back.

f

Specifies the output format of the response. The default response format is html.

Values: html | json | pjson

gdbVersion

(Optional)

Specifies the name of the geodatabase version. The default is 'sde.DEFAULT'.

Syntax:

Use dark colors for code blocksCopy

gdbVersion=<version>

sessionId

(Optional)

Specifies the token (guid) used to lock the version. If a client has previously started an edit session and holds an exclusive lock on the version specified, the request will fail if the sessionId is not provided. If the specified version is currently locked by any other session, the request will fail if the sessionId is not provided or does not match the sessionId that holds the exclusive lock.

Syntax:

Use dark colors for code blocksCopy

sessionId=<guid>

domainNetworkName

(Required)

Specifies the name of the telecom domain network from which the circuit will be deleted.

Syntax:

Use dark colors for code blocksCopy

domainNetworkName=<string>

Example:

Use dark colors for code blocksCopy

domainNetworkName=Telco

circuits

(Required)

The names of the circuit or circuits to be deleted.

Syntax:

Use dark colors for code blocksCopy

circuits=[<string>]

Example:

Use dark colors for code blocksCopy

circuits=[CIRCUITA","CIRCUITB"]

JSON Response syntax

Use dark colors for code blocksCopy
{
  "moment": <epochtime>,
  "exceededTransferLimit": <true | false>,
  "serviceEdits": [
    {
      "id": <layerId>,
      "editedFeatures": {
        "deletes": [<currentFeature1>, <currentFeature2>]
      }
    }
  ],
  "success": <boolean>,
  "error" : {                   // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <string>,
    "details" : [ <string> ]
  }
}

Example usage

Request URL and parameters:

Use dark colors for code blocksCopy

https://myserver.esri.com/server/rest/services/Telco/UtilityNetworkServer/circuits/delete

Use the delete operation to delete a circuit named A32/T3U/79232211/82256420 in a telecom domain network named Telco.

Use dark colors for code blocksCopy

f=json
gdbVersion=sde.Default
domainNetworkName=Telco
circuits=["A32/T3U/79232211/82256420"]

JSON response:

Use dark colors for code blocksCopy
{
  "moment": 1751403336637,
  "exceededTransferLimit": false,
  "serviceEdits": [
    {
      "id": 23,
      "editedFeatures": {
        "deletes": [
          {
            "attributes": {
              "objectid": 33,
              "circuitid": "{7187C7FF-42F7-4551-A5B6-37E8F23B5E71}",
              "sectionid": 1,
              "startlocationsourceid": 20,
              "startlocationid": "{8A1B5A33-3EBA-42CC-9085-31B22DAFE5DC}",
              "startlocationterminalid": 1,
              "startlocationfirstunit": 1,
              "startlocationlastunit": 1,
              "stoplocationsourceid": 20,
              "stoplocationid": "{8A1B5A33-3EBA-42CC-9085-31B22DAFE5DC}",
              "stoplocationterminalid": 1,
              "stoplocationfirstunit": 4,
              "stoplocationlastunit": 1,
              "role": 0,
              "sectiontype": 0,
              "globalid": "{3215003A-44A1-433D-A86E-9AF6C982670D}",
              "created_user": "unadmin",
              "created_date": 1751402535000,
              "last_edited_user": "unadmin",
              "last_edited_date": 1751402535000
            }
          }
        ]
      }
    },
    {
      "id": 22,
      "editedFeatures": {
        "updates": [
          [
            {
              "attributes": {
                "objectid": 46,
                "name": "A32/T3U/79232211/82256420",
                "sectionorder": "{\"1\":[]}",
                "status": 1,
                "isdeleted": 0,
                "lastverified": null,
                "lastexported": null,
                "startlocationsourceid": null,
                "startlocationid": null,
                "startlocationterminalid": null,
                "startlocationfirstunit": null,
                "startlocationlastunit": null,
                "stoplocationsourceid": null,
                "stoplocationid": null,
                "stoplocationterminalid": null,
                "stoplocationfirstunit": null,
                "stoplocationlastunit": null,
                "issectioned": 1,
                "circuittype": 0,
                "conflictcontainerstate": null,
                "globalid": "{7187C7FF-42F7-4551-A5B6-37E8F23B5E71}",
                "created_user": "unadmin",
                "created_date": 1751402535000,
                "last_edited_user": "unadmin",
                "last_edited_date": 1751403223000
              }
            },
            {
              "attributes": {
                "objectid": 46,
                "name": "A32/T3U/79232211/82256420",
                "sectionorder": "{\"1\":[]}",
                "status": 0,
                "isdeleted": 1,
                "lastverified": null,
                "lastexported": null,
                "startlocationsourceid": null,
                "startlocationid": null,
                "startlocationterminalid": null,
                "startlocationfirstunit": null,
                "startlocationlastunit": null,
                "stoplocationsourceid": null,
                "stoplocationid": null,
                "stoplocationterminalid": null,
                "stoplocationfirstunit": null,
                "stoplocationlastunit": null,
                "issectioned": 1,
                "circuittype": 0,
                "conflictcontainerstate": null,
                "globalid": "{7187C7FF-42F7-4551-A5B6-37E8F23B5E71}",
                "created_user": "unadmin",
                "created_date": 1751402535000,
                "last_edited_user": "unadmin",
                "last_edited_date": 1751403336000
              }
            }
          ]
        ]
      }
    }
  ],
  "success": true
}