Export (Circuits)

URL:: https://<root>/<serviceName>/UtilityNetworkServer/circuits/export
Methods:: GETPOST
Version Introduced:: 11.5

The export operation on the circuits resource allows you to export feature and connectivity information about provided circuits in a telecom domain network into JSON files for consumption by external systems. Each circuit exported is output to a separate JSON file. Exporting circuits is supported both synchronously and asynchronously.

Request parameters

Parameter Details

Parameter	Details
`f`	Specifies 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 is 'sde.DEFAULT'. Syntax: `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: `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 seconds>` Example: `moment=1601505447`
`domainNetworkName` (Required)	Specifies the name of the telecom domain network containing the circuits to be exported. Syntax: `domainNetworkName=<string>` Example: `domainNetworkName=Telco`
`circuits` (Required)	The names of the circuit or circuits to be exported. Syntax: `circuits=[<string>]` Example: `circuits=[CircuitA,CircuitB]`
`exportAcknowledgement` (Optional)	Specifies whether the export is acknowledged. If true, the default version is required for `gdbVersion`. The default is `false`. Use dark colors for code blocksCopy `1 exportAcknowledgement=true \| false`
`resultTypes` (Optional)	Specifies the types of results to return. The default is `features`. Syntax: Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 [ { "type" : "features" \| "connectivity", "includeGeometry" : true \| false, "includeDomainDescriptions": true \| false, "networkAttributeNames" :["attribute1Name","attribute2Name",...], "diagramTemplateName": <value>, "resultTypeFields":[{"networkSourceId":<long>,"fieldname":<value>},...] },... ]`
`async` (Optional)	Specifies whether the request will be processed asynchronously. If `true`, the request is processed as an asynchronous job, and a URL is returned that a client can visit to check the status of the job. The default is `false`. Use dark colors for code blocksCopy `1 async=true \| false`
`outSR` (Optional)	Specifies the output spatial reference of the exported circuits. Syntax: ` Use dark colors for code blocksCopy 1 2 3 4 "spatialReference": { "wkid": <spatial reference well-known identifier>, "latestWkid": <the current wkid value associated with the wkid> }`

f

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

Syntax: 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: 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 seconds>

Example: moment=1601505447

domainNetworkName

(Required)

Specifies the name of the telecom domain network containing the circuits to be exported.

Syntax: domainNetworkName=<string>

Example: domainNetworkName=Telco

circuits

(Required)

The names of the circuit or circuits to be exported.

Syntax: circuits=[<string>]

Example: circuits=[CircuitA,CircuitB]

exportAcknowledgement

(Optional)

Specifies whether the export is acknowledged. If true, the default version is required for gdbVersion. The default is false.

Use dark colors for code blocksCopy
exportAcknowledgement=true | false

resultTypes

(Optional)

Specifies the types of results to return. The default is features.

Syntax:

Use dark colors for code blocksCopy
[
  {
    "type" : "features" | "connectivity",
    "includeGeometry" : true | false,
    "includeDomainDescriptions": true | false,
    "networkAttributeNames" :["attribute1Name","attribute2Name",...],
    "diagramTemplateName": <value>,
    "resultTypeFields":[{"networkSourceId":<long>,"fieldname":<value>},...]
  },...
]

async

(Optional)

Specifies whether the request will be processed asynchronously. If true, the request is processed as an asynchronous job, and a URL is returned that a client can visit to check the status of the job. The default is false.

Use dark colors for code blocksCopy
async=true | false

outSR

(Optional)

Specifies the output spatial reference of the exported circuits.

Syntax: `

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

JSON Response syntax (when async = false)

Use dark colors for code blocksCopy
{
	"f": "json",
	"moment": <datetime>,
	"circuits": [
		{
			"name": <string>,
			"url": "<url>",
			"circuitHasBeenDeleted": <boolean>,
			"success": <boolean>
		},
	],
	"success": <boolean>.
	“error” : {                   // only if success is false
    “extendedCode” : <HRESULT>,
    “message” : <string>,
    “details” : [ <string> ]
 }
}

JSON response (when async = true):

Use dark colors for code blocksCopy
{
  "statusUrl" : <url>
}

JSON response to the status URL (when pending or in progress):

Use dark colors for code blocksCopy
{
  "status" : "<Pending | InProgress>",
  "submissionTime" : <datetime>,
  "lastUpdatedTime" : <datetime>
 }

Use dark colors for code blocksCopy
{

  "name": <string>,
  "featureElements": [
    {
      "networkSourceId": <long>,
      "globalId": <guid>,
      "objectId": <long>,
      "terminalId": <short>,
      "assetGroupCode": <long>,
      "assetTypeCode": <long>,
      "firstUnit": <short>,  // grouped objects only
      "numUnits": <short>,  // grouped objects only
      "positionFrom": <double>,  // line features only
      "positionTo": <double>,    // line features only
      "networkSourceName": <string>,
      "assetGroupName": <string>,
      "assetTypeName": <string>,
      "terminalName": <string>,
      "networkAttributeValues": [],
      "networkAttributeDescriptions": []
    }
  ],

  "connectivity": [
    {
      "viaNetworkSourceId": <long>,
      "viaGlobalId": <guid>,
      "viaObjectId": <long>,
      "viaPositionFrom": <double>,
      "viaPositionTo": <double>,
      "viaGeometry": <geometry>,
      "viaFirstUnit": <short>,  // grouped objects only
      "fromNetworkSourceId": <long>,
      "fromGlobalId": <guid>,
      "fromObjectId": <long>,
      "fromTerminalId": <short>,
      "fromGeometry": <geometry>,
      "fromFirstUnit": <short>,  // grouped objects only
      "toNetworkSourceId": <long>,
      "toGlobalId": <guid>,
      "toObjectId": <long>,
      "toTerminalId": <short>,
      "toGeometry": <geometry>,
      "toFirstUnit": <short>,  // grouped objects only
      "numUnits": <short>,  // grouped objects only
      "viaNetworkSourceName": <string>,
      "fromNetworkSourceName": <string>,
      "fromTerminalName": <string>,
      "toNetworkSourceName": <string>,
      "toTerminalName": <string>
    }
  ],

  "sourceMapping":
    {
      "networkSourceId": "string",
          ...
    },

  "resultTypes": [
    {
      "type": "features" | "connectivity",
      "includeGeometry": true | false,
      "includePropagatedValues": true | false,
      "includeDomainDescriptions": true | false,
      "networkAttributeNames": ["<networkAttributeName1>", ...],
      "diagramTemplateName": "",
      "resultTypeFields": [
        {
          "networkSourceId": <long>,
          "fieldName": <string>
        }
      ]
    },
    {
      "type": "connectivity",
      "includeGeometry": true,
      "includePropagatedValues": false,
      "includeDomainDescriptions": true,
      "networkAttributeNames": [],
      "diagramTemplateName": "",
      "resultTypeFields": []
    }
  ],
  "spatialReference": {<spatialReference>}
}

Example usage

Export two circuits from the telecom domain network using the export operation on the Circuits resource. The resultTypes parameter includes features and connectivity values with geometry and domain descriptions included.

Request URL and parameters:

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

Use dark colors for code blocksCopy

f=json
gdbVersion=sde.default
domainNetworkName=Telco
circuits=["CIRCUITA”,”CIRCUITB"]
exportAcknowledgement=false
resultTypes=[
  {
    "type": "features",
    "includeGeometry": true,
    "includePropagatedValues": false,
"includeDomainDescriptions":true,
    "networkAttributeNames": [],
    "diagramTemplateName": "",
    "resultTypeFields": []
  },
  {
    "type": "connectivity",
    "includeGeometry": true,
    "includePropagatedValues": false,
    "networkAttributeNames": [],
    "diagramTemplateName": "",
    "resultTypeFields": []
  }
]
async=false

JSON response (async= false):

Use dark colors for code blocksCopy
{
	"f": "json",
	"moment": 1729521732377,
	"circuits": [
		{
			"name": "CIRCUITA",
			"url": "https://organization.example.com/<context>/rest/directories/arcgisoutput/MyService_MapServer/_ags9C2C5F13-346A-44B2-8E3F-6879E51048E4/CIRCUITA_2024_10_21_16_32_15.json",
			"circuitHasBeenDeleted": false,
			"success": true
		},
		{
			"name": "CIRCUITB",
			"url": "https://organization.example.com/<context>/rest/directories/arcgisoutput/MyService_MapServer/_ags9C2C5F13-346A-44B2-8E3F-5079E51048E4/CIRCUITB_2024_10_21_16_32_15.json",
			"circuitHasBeenDeleted": false,
			"success": true
		}
	],
	"success": true
}

Output JSON files created for CIRCUITA:

Use dark colors for code blocksCopy
{
	"name": "CIRCUITA",
	"featureElements": [
		{
			"networkSourceId": 20,
			"globalId": "{F081B917-499E-43FC-AEC9-7C1B313BF128}",
			"objectId": 43,
			"terminalId": 1,
			"assetGroupCode": 4,
			"assetTypeCode": 4,
			"networkSourceName": "TelcoJunctionObject",
			"assetGroupName": "Port",
			"assetTypeName": "Circuit Location",
			"terminalName": "Single Terminal"
		},
		{
			"networkSourceId": 20,
			"globalId": "{8A1B5A33-3EBA-42CC-9085-31B22DAFE5DC}",
			"objectId": 42,
			"terminalId": 1,
			"assetGroupCode": 4,
			"assetTypeCode": 4,
			"networkSourceName": "TelcoJunctionObject",
			"assetGroupName": "Port",
			"assetTypeName": "Circuit Location",
			"terminalName": "Single Terminal"
		},
		{
			"networkSourceId": 21,
			"globalId": "{9D23E5B8-0EF0-42E2-B2BD-F8DEAAA608FA}",
			"objectId": 29,
			"assetGroupCode": 1,
			"assetTypeCode": 1,
			"positionFrom": 0,
			"positionTo": 1,
			"networkSourceName": "TelcoEdgeObject",
			"assetGroupName": "Fiber",
			"assetTypeName": "Fiber"
		}
	],
	"connectivity": [
		{
			"viaNetworkSourceId": 21,
			"viaGlobalId": "{9D23E5B8-0EF0-42E2-B2BD-F8DEAAA608FA}",
			"viaObjectId": 29,
			"viaPositionFrom": 0,
			"viaPositionTo": 1,
			"viaGeometry": {},
			"fromNetworkSourceId": 20,
			"fromGlobalId": "{8A1B5A33-3EBA-42CC-9085-31B22DAFE5DC}",
			"fromObjectId": 42,
			"fromTerminalId": 1,
			"fromGeometry": {},
			"toNetworkSourceId": 20,
			"toGlobalId": "{F081B917-499E-43FC-AEC9-7C1B313BF128}",
			"toObjectId": 43,
			"toTerminalId": 1,
			"toGeometry": {},
			"viaNetworkSourceName": "TelcoEdgeObject",
			"fromNetworkSourceName": "TelcoJunctionObject",
			"fromTerminalName": "Single Terminal",
			"toNetworkSourceName": "TelcoJunctionObject",
			"toTerminalName": "Single Terminal"
		}
	],
	"sourceMapping": {
		"1": "UN_6_Associations",
		"2": "UN_6_SystemJunctions",
		"4": "StructureJunction",
		"6": "StructureBoundary",
		"7": "StructureJunctionObject",
		"5": "StructureLine",
		"8": "StructureEdgeObject",
		"9": "ElectricDistributionDevice",
		"11": "ElectricDistributionAssembly",
		"12": "ElectricDistributionJunction",
		"14": "ElectricDistributionJunctionObject",
		"10": "ElectricDistributionLine",
		"13": "ElectricDistributionSubnetLine",
		"15": "ElectricDistributionEdgeObject",
		"16": "TelcoDevice",
		"18": "TelcoAssembly",
		"19": "TelcoJunction",
		"20": "TelcoJunctionObject",
		"17": "TelcoLine",
		"21": "TelcoEdgeObject",
		"22": "TelcoCircuit",
		"23": "TelcoCircuitSection",
		"24": "TelcoSubcircuit"
	},
	"resultTypes": [
		{
			"type": "features",
			"includeGeometry": true,
			"includePropagatedValues": false,
			"includeDomainDescriptions": true,
			"networkAttributeNames": [],
			"diagramTemplateName": "",
			"resultTypeFields": []
		},
		{
			"type": "connectivity",
			"includeGeometry": true,
			"includePropagatedValues": false,
			"includeDomainDescriptions": true,
			"networkAttributeNames": [],
			"diagramTemplateName": "",
			"resultTypeFields": []
		}
	],
	"spatialReference": {
		"wkid": 3498,
		"latestWkid": 3498
	}
}