Insert Gap (Unit Identifiers) | ArcGIS REST APIs

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

Description

The insertGap operation on the unitIdentifiers resource shifts existing records in the containment hierarchy of a unit container's NextUnitID sequence to reserve a range of unit IDs when working with a telecom domain network. When a gap is inserted at the end of the sequence, the NEXTUNITID attribute value for the unit container increases. If a gap is inserted into the middle of an existing sequence, the system will attempt to shift existing records to accommodate the reserved space. The operation will fail and return an error if the reservation requires regrouping an object or occurs in the middle of a connectivity assignment.

Learn more about reserving unit identifiers

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>`
`object` (Optional)	The unit identifiable features or objects being reset. Syntax: Use dark colors for code blocksCopy `1 2 3 4 { "sourceId": <short>, "globalId": "<guid>" }` Example: Use dark colors for code blocksCopy `1 2 3 4 { "sourceId": 9, "globalId": "{E8F7E030-A537-4D05-8CAE-0067D0B48625}" }`
`firstUnit` (Optional)	The first unit for the gap to be introduced. Syntax: Use dark colors for code blocksCopy `1 2 firstUnit=<short>` Example: Use dark colors for code blocksCopy `1 2 firstUnit=1`
`numUnits` (Optional)	The number of units in the gap. Syntax: Use dark colors for code blocksCopy `1 2 numUnits=<short>` Example: Use dark colors for code blocksCopy `1 2 numUnits=3`

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>

object

(Optional)

The unit identifiable features or objects being reset.

Syntax:

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

Example:

Use dark colors for code blocksCopy
{
  "sourceId": 9,
  "globalId": "{E8F7E030-A537-4D05-8CAE-0067D0B48625}"
}

firstUnit

(Optional)

The first unit for the gap to be introduced.

Syntax:

Use dark colors for code blocksCopy

firstUnit=<short>

Example:

Use dark colors for code blocksCopy

firstUnit=1

numUnits

(Optional)

The number of units in the gap.

Syntax:

Use dark colors for code blocksCopy

numUnits=<short>

Example:

Use dark colors for code blocksCopy

numUnits=3

Example usage

Use the insertGap operation to reserve space within the unit sequence of the unit container, updating the NextUnitID attribute value on the unit container feature from 13 to 15.

Request URL and parameters:

Use dark colors for code blocksCopy

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

Use dark colors for code blocksCopy

f=json
gdbVersion=sde.Default
object= {
  "sourceId": 16,
  "globalId": "{B97653FC-99C7-4DBF-954D-F38EA214C692}"
 }
firstUnit=13
numUnits=2

JSON Response syntax

Use dark colors for code blocksCopy
{
  "exceededTransferLimit": false,
  "serviceEdits": [
    {
      "id": 5,
      "editedFeatures": {
        "spatialReference": {
          "wkid": 3498,
          "latestWkid": 3498,
          "xyTolerance": 0.003280833333333333,
          "zTolerance": 0.001,
          "mTolerance": 0.001,
          "falseX": -117608900,
          "falseY": -91881400,
          "xyUnits": 3048.0060960121929,
          "falseZ": -100000,
          "zUnits": 10000,
          "falseM": -100000,
          "mUnits": 10000
        },
        "updates": [
          [
            {
              "attributes": {
                "objectid": 13,
                "assetgroup": 1,
                "assettype": 2,
                "associationstatus": 1,
                "terminalconfiguration": "Default",
                "containersourceid": null,
                "containerglobalid": null,
                "nextunitid": 7,
                "conflictcontainerstate": null,
                "clusterkey": null,
                "globalid": "{B97653FC-99C7-4DBF-954D-F38EA214C692}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": "unadmin",
                "last_edited_date": 1736878108000
              },
              "geometry": {
                "x": 6812288.661061972,
                "y": 1843640.8011838943,
                "z": 0,
                "m": null
              }
            },
            {
              "attributes": {
                "objectid": 13,
                "assetgroup": 1,
                "assettype": 2,
                "associationstatus": 1,
                "terminalconfiguration": "Default",
                "containersourceid": null,
                "containerglobalid": null,
                "nextunitid": 15,
                "conflictcontainerstate": null,
                "clusterkey": null,
                "globalid": "{B97653FC-99C7-4DBF-954D-F38EA214C692}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": "unadmin",
                "last_edited_date": 1736878175000
              },
              "geometry": {
                "x": 6812288.661061972,
                "y": 1843640.8011838943,
                "z": 0,
                "m": null
              }
            }
          ]
        ]
      }
    }
  ],
  "moment": 1736878175375,
  "success": true
}