Query (Unit Identifiers)

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

Description

The query operation on the unitIdentifiers resource is used to return unit identifiers for, and identify existing gaps in, a unit container feature's containment hierarchy in a telecom domain network.

Request parameters

Parameter Details

Parameter	Details
`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`
`objects` (Optional)	Array containing the unit container features to be queried for unit IDs. 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 [ { "sourceId": 9, "globalIds": ["{BE504BEE-F6AB-4474-A632-BC94E35DCD2A}"] } ]`

f

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

Use dark colors for code blocksCopy
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

objects

(Optional)

Array containing the unit container features to be queried for unit IDs.

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

Use the query operation to return unit identifiers and gaps for a unit container feature.

Request URL and parameters:

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

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
}