Verify (Circuits) | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/UtilityNetworkServer/circuits/verify
Methods:: GETPOST
Version Introduced:: 12.1

The verify operation on the circuits resource is used to check the validity of circuits in a telecom domain network after features associated with the circuit are modified. The operation confirms that a circuit can be traced from the start location to the stop location and ensures that circuit sections and subcircuits are properly configured.

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 containing the circuits to be verified. 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 verified. Syntax: Use dark colors for code blocksCopy `1 2 circuits=[<string>]` Example: Use dark colors for code blocksCopy `1 2 circuits=["CIRCUITA","CIRCUITB"]`
`async` (Optional)	If `true`, the request is processed as an asynchronous job, and a URL is returned that a client can use to check the status of the job. The default is `false`. Use dark colors for code blocksCopy `1 async=true \| false`
`forceVerify` (Optional)	The `forceVerify` parameter enables circuits to be verified regardless of their status. When `false`, the verify operation returns an error if the circuit status is clean. When `true`, the verify operation will run against clean, dirty, and invalid circuits. The default is `false`. Values: `true` \| `false`
`synthesizeGeometries` (Optional)	Specifies whether geometries will be inferred and created (synthesized) for the circuits. The default is `false`. Values: `true` \| `false`
`outSR` (Optional)	Specifies the output spatial reference for the synthesized geometries using a well-known ID (`wkid`) or well-known text (`wkt`or `wkt2`). If `outSR` is not specified, the spatial reference of the feature service is used. Syntax: Use dark colors for code blocksCopy `1 2 3 4 "outSR": { "wkid": <spatial reference well-known identifier>, "latestWkid": <the current wkid value associated with the wkid> // Optional }` Example: Use dark colors for code blocksCopy `1 2 outSR={"wkid":3498,"latestWkid":3498}` Example: Use dark colors for code blocksCopy `1 2 outSR={"wkt": "PROJCS[\"WGS_1984_Web_Mercator_Auxiliary_Sphere\",GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Mercator_Auxiliary_Sphere\"],PARAMETER[\"False_Easting\",0.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",0.0],PARAMETER[\"Standard_Parallel_1\",0.0],PARAMETER[\"Auxiliary_Sphere_Type\",0.0],UNIT[\"Meter\",1.0]]"}`

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 containing the circuits to be verified.

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 verified.

Syntax:

Use dark colors for code blocksCopy

circuits=[<string>]

Example:

Use dark colors for code blocksCopy

circuits=["CIRCUITA","CIRCUITB"]

async

(Optional)

If true, the request is processed as an asynchronous job, and a URL is returned that a client can use to check the status of the job. The default is false.

Use dark colors for code blocksCopy
async=true | false

forceVerify

(Optional)

The forceVerify parameter enables circuits to be verified regardless of their status. When false, the verify operation returns an error if the circuit status is clean. When true, the verify operation will run against clean, dirty, and invalid circuits. The default is false.

Values: true | false

synthesizeGeometries

(Optional)

Specifies whether geometries will be inferred and created (synthesized) for the circuits. The default is false.

Values: true | false

outSR

(Optional)

Specifies the output spatial reference for the synthesized geometries using a well-known ID (wkid) or well-known text (wktor wkt2). If outSR is not specified, the spatial reference of the feature service is used.

Syntax:

Use dark colors for code blocksCopy
"outSR": {
  "wkid": <spatial reference well-known identifier>,
  "latestWkid": <the current wkid value associated with the wkid>  // Optional
}

Example:

Use dark colors for code blocksCopy

outSR={"wkid":3498,"latestWkid":3498}

Example:

Use dark colors for code blocksCopy

outSR={"wkt": "PROJCS[\"WGS_1984_Web_Mercator_Auxiliary_Sphere\",GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Mercator_Auxiliary_Sphere\"],PARAMETER[\"False_Easting\",0.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",0.0],PARAMETER[\"Standard_Parallel_1\",0.0],PARAMETER[\"Auxiliary_Sphere_Type\",0.0],UNIT[\"Meter\",1.0]]"}

JSON Response syntax

Use dark colors for code blocksCopy
{
  "moment": <epoch time in milliseconds>,

  "circuits": [
    {
      "name": <string>,
      "success": <boolean>,
      "error": {                   // only if success is false
        "extendedCode": <HRESULT>,
        "message": <string>
      }
    }
  ],
  "success": <boolean>
}

Example usage

Request URL and parameters:

Use dark colors for code blocksCopy

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

Use dark colors for code blocksCopy

f=json
gdbVersion=sde.Default
domainNetworkName=Telco
circuits=["CIRCUITA","CIRCUITB"]
synthesizeGeometries=true
outSR={"wkid":3498,"latestWkid":3498}

JSON response:

Use dark colors for code blocksCopy
{
  "moment": 1767734134573,
  "circuits": [
    {
      "name": "CIRCUITA",
      "success": true,
      "geometry": {
        "hasZ": true,
        "hasM": true,
        "paths": [
          [
            [
              6804688.956445143,
              1844028.6983739734,
              0,
              null
            ],
            [
              6804688.57652463,
              1844037.2390393168,
              0,
              null
            ],
            [
              6804687.667077631,
              1844067.519490555,
              0,
              null
            ],
            [
              6804886.927177802,
              1844145.5121167303,
              0,
              null
            ],
            [
              6804688.956445143,
              1844028.6983739734,
              0,
              null
            ]
          ]
        ]
      }
    },
    {
      "name": "CIRCUITB",
      "success": true,
      "geometry": {
        "hasZ": true,
        "hasM": true,
        "paths": [
          [
            [
              6804688.956445143,
              1844028.6983739734,
              0,
              null
            ],
            [
              6804688.57652463,
              1844037.2390393168,
              0,
              null
            ],
            [
              6804861.807149306,
              1844441.4373779,
              0,
              null
            ],
            [
              6805261.306350306,
              1844587.3691726477,
              0,
              null
            ],
            [
              6805270.266634226,
              1844590.6421319843,
              0,
              null
            ],
            [
              6805271.626211554,
              1844330.8769034744,
              0,
              null
            ],
            [
              6805272.047470555,
              1844250.4256208093,
              0,
              null
            ],
            [
              6804688.956445143,
              1844028.6983739734,
              0,
              null
            ]
          ]
        ]
      }
    }
  ],
  "spatialReference": {
    "wkid": 3498,
    "latestWkid": 3498
  },
  "exceededTransferLimit": false,
  "serviceEdits": [
    {
      "id": 20,
      "editedFeatures": {
        "updates": [
          [
            {
              "attributes": {
                "OBJECTID": 6,
                "NAME": "CIRCUITA",
                "SECTIONORDER": null,
                "STATUS": 1,
                "LASTVERIFIED": null,
                "LASTEXPORTED": null,
                "STARTLOCATIONSOURCEID": 20,
                "STARTLOCATIONID": "{EF34D81C-86B5-42FB-9860-AB8C90F5094D}",
                "STARTLOCATIONFIRSTUNIT": 3,
                "STARTLOCATIONLASTUNIT": 3,
                "STOPLOCATIONSOURCEID": 20,
                "STOPLOCATIONID": "{F75B0037-657E-4F1F-8FEB-2D8B5D4C70ED}",
                "STOPLOCATIONFIRSTUNIT": 1,
                "STOPLOCATIONLASTUNIT": 1,
                "ISSECTIONED": 0,
                "CIRCUITTYPE": 0,
                "ERRORMESSAGE": null,
                "CONFLICTCONTAINERSTATE": null,
                "UPPERNAME": "CIRCUITA",
                "GLOBALID": "{AA07985C-4C61-4456-AFF7-BA7E862296EF}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": null,
                "last_edited_date": null
              }
            },
            {
              "attributes": {
                "OBJECTID": 6,
                "NAME": "CIRCUITA",
                "SECTIONORDER": null,
                "STATUS": 0,
                "LASTVERIFIED": 1767734135000,
                "LASTEXPORTED": null,
                "STARTLOCATIONSOURCEID": 20,
                "STARTLOCATIONID": "{EF34D81C-86B5-42FB-9860-AB8C90F5094D}",
                "STARTLOCATIONFIRSTUNIT": 3,
                "STARTLOCATIONLASTUNIT": 3,
                "STOPLOCATIONSOURCEID": 20,
                "STOPLOCATIONID": "{F75B0037-657E-4F1F-8FEB-2D8B5D4C70ED}",
                "STOPLOCATIONFIRSTUNIT": 1,
                "STOPLOCATIONLASTUNIT": 1,
                "ISSECTIONED": 0,
                "CIRCUITTYPE": 0,
                "ERRORMESSAGE": null,
                "CONFLICTCONTAINERSTATE": null,
                "UPPERNAME": "CIRCUITA",
                "GLOBALID": "{AA07985C-4C61-4456-AFF7-BA7E862296EF}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": "unadmin",
                "last_edited_date": 1767734134000
              }
            }
          ],
          [
            {
              "attributes": {
                "OBJECTID": 8,
                "NAME": "CIRCUITB",
                "SECTIONORDER": null,
                "STATUS": 1,
                "LASTVERIFIED": null,
                "LASTEXPORTED": null,
                "STARTLOCATIONSOURCEID": 20,
                "STARTLOCATIONID": "{EF34D81C-86B5-42FB-9860-AB8C90F5094D}",
                "STARTLOCATIONFIRSTUNIT": 5,
                "STARTLOCATIONLASTUNIT": 5,
                "STOPLOCATIONSOURCEID": 20,
                "STOPLOCATIONID": "{83000DAB-7969-44D7-9CEE-65141ECA2CB8}",
                "STOPLOCATIONFIRSTUNIT": 1,
                "STOPLOCATIONLASTUNIT": 1,
                "ISSECTIONED": 0,
                "CIRCUITTYPE": 0,
                "ERRORMESSAGE": null,
                "CONFLICTCONTAINERSTATE": null,
                "UPPERNAME": "CIRCUITB",
                "GLOBALID": "{66274489-155C-426D-B869-969E9BD27599}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": null,
                "last_edited_date": null
              }
            },
            {
              "attributes": {
                "OBJECTID": 8,
                "NAME": "CIRCUITB",
                "SECTIONORDER": null,
                "STATUS": 0,
                "LASTVERIFIED": 1767734135000,
                "LASTEXPORTED": null,
                "STARTLOCATIONSOURCEID": 20,
                "STARTLOCATIONID": "{EF34D81C-86B5-42FB-9860-AB8C90F5094D}",
                "STARTLOCATIONFIRSTUNIT": 5,
                "STARTLOCATIONLASTUNIT": 5,
                "STOPLOCATIONSOURCEID": 20,
                "STOPLOCATIONID": "{83000DAB-7969-44D7-9CEE-65141ECA2CB8}",
                "STOPLOCATIONFIRSTUNIT": 1,
                "STOPLOCATIONLASTUNIT": 1,
                "ISSECTIONED": 0,
                "CIRCUITTYPE": 0,
                "ERRORMESSAGE": null,
                "CONFLICTCONTAINERSTATE": null,
                "UPPERNAME": "CIRCUITB",
                "GLOBALID": "{66274489-155C-426D-B869-969E9BD27599}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": "unadmin",
                "last_edited_date": 1767734134000
              }
            }
          ]
        ]
      }
    }
  ],
  "success": true
}