Insert Gap (Unit Identifiers)

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

Description

The insertGap operation on the unitIdentifiers resource inserts a gap into the NextUnitID sequence of a unit container feature's containment hierarchy in 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

ParameterDetails

f

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

Use dark colors for code blocksCopy
1
f=html | json | pjson

gdbVersion

(Optional)

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

Syntax: 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: sessionId=<guid>

moment

(Optional)

Specifies the session moment. The default value is the version's current moment. This should only be specified by the client when they do not want to use the current moment.

Syntax: moment=<Epoch time in milliseconds>

Example: moment=1601505446

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: firstUnit=<short>

Example: firstUnit=1

numUnits

(Optional)

The number of units in the gap.

Syntax: numUnits=<short>

Example: numUnits=3

Example usage

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

Request URL and parameters:

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9

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
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
{
	"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,
								"rootcontainerstate": 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,
								"rootcontainerstate": 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
}

JSON Response example

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.