Reset (Unit Identifiers) | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/UtilityNetworkServer/unitIdentifiers/reset
Methods:: GETPOST
Version Introduced:: 11.5

Description

The reset operation on the unitIdentifiers resource is used to reset the unit identifiers associated with a unit container feature in a telecom domain network. This is done to condense the unit identifier space or overcome unit identifier sequence exhaustion.

Request parameters

Parameter Details

Parameter	Details
`f`	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 value 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 the calling client is editing a named version, the `sessionId` value must be provided; if the client is editing `DEFAULT`, the version may not be locked and the `sessionId` value should not be specified. Syntax: Use dark colors for code blocksCopy `1 2 sessionId=<guid>`
`objects` (Required)	Array containing the unit identifiable features or objects to be reset. Syntax: Use dark colors for code blocksCopy `1 2 3 4 5 6 [ { "sourceId": <short>, "globalIds": ["<guid>"] } ]` Example: Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 [ { "sourceId": 9, "globalIds": [ "{BE504BEE-F6AB-4474-A632-BC94E35DCD2A}" ] } ]`

f

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 value is sde.DEFAULT.

Syntax:

Use dark colors for code blocksCopy

gdbVersion=<version>

sessionID

(Optional)

Specifies the token guid used to lock the version. If the calling client is editing a named version, the sessionId value must be provided; if the client is editing DEFAULT, the version may not be locked and the sessionId value should not be specified.

Syntax:

Use dark colors for code blocksCopy

sessionId=<guid>

objects

(Required)

Array containing the unit identifiable features or objects to be reset.

Syntax:

Use dark colors for code blocksCopy
[
  {
    "sourceId": <short>,
    "globalIds": ["<guid>"]
  }
]

Example:

Use dark colors for code blocksCopy
[
  {
    "sourceId": 9,
    "globalIds": [
      "{BE504BEE-F6AB-4474-A632-BC94E35DCD2A}"
    ]
  }
]

Example usage

Request URL and parameters:

Use dark colors for code blocksCopy

https://myserver.esri.com/server/rest/services/Telco/UtilityNetworkServer/unitIdentifiers/reset

Use dark colors for code blocksCopy
f=json
gdbVersion=sde.Default
objects= [
  {
    "sourceId": 9,
    "globalIds": [
      "{BE504BEE-F6AB-4474-A632-BC94E35DCD2A}"
    ]
  }
]

JSON response syntax

Use dark colors for code blocksCopy
{
  "objects": [
    {
      "sourceId": 9,
      "globalId": "{BE504BEE-F6AB-4474-A632-BC94E35DCD2A}",
      "gaps": [
        {
          "start": 4,
          "end": 7
        }
      ],
      "unitIdentifiers": [
        {
          "sourceId": 13,
          "globalId": "{B2597E28-1751-4AB0-860A-AA722C8A4349}",
          "firstUnit": 1,
          "numUnits": 1
        },
        {
          "sourceId": 13,
          "globalId": "{475D2C72-F1E9-458E-941A-8D7CAC442C67}",
          "firstUnit": 2,
          "numUnits": 1
        },
        {
          "sourceId": 13,
          "globalId": "{6A43AB2F-A6FD-4B83-AA07-F2F1CF04C52B}",
          "firstUnit": 3,
          "numUnits": 1
        },
        {
          "sourceId": 13,
          "globalId": "{9A8061CA-B96B-466E-8B0A-CE6CBFE6C70B}",
          "firstUnit": 8,
          "numUnits": 1
        }
      ]
    }
  ],
  "success": true
}