Create (Circuits) | ArcGIS REST APIs

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

The create operation on the circuits resource allows you to create a circuit in a telecom domain network.

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 in which the circuit will be created. 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 circuit and circuit information to be created. 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 { "circuits":[ { "name": <string>, "globalId": <guid>, "isSectioned": <boolean>, "sectionOrder": <string>, "circuitType": "Physical" \| "Virtual", // Default is Physical "startLocation" : // Only when isSectioned is false { "sourceId" : <short>, "globalId" : <guid>, "terminalId" : <short>, "firstUnit" : <short>, "lastUnit" : <short> }, "stopLocation" : // Only when isSectioned is false { "sourceId" : <short>, "globalId" : <guid>, "terminalId" : <short>, "firstUnit" : <short>, "lastUnit" : <short> }, "sections": [ { "sectionId": <long>, "role": "Start and end"\| "Start" \| "End" \| "Midspan", // Default is Start and end "sectionType": "Physical" \| "Virtual", // Default is Physical "startLocation": { "sourceId" : <short>, "globalId" : <guid>, "terminalId" : <short>, "firstUnit" : <short>, "lastUnit" : <short> }, "stopLocation": { "sourceId" : <short>, "globalId" : <guid>, "terminalId" : <short>, "firstUnit" : <short>, "lastUnit" : <short> }, } ], "subcircuits": [ { "name": <string>, "globalId": <guid>, "providerID": <guid>, "consumerId": <guid>, "isReserved": "true" \| "false", // Default is false "attributes": { // Optional, used when user-defined attributes are configured for the Subcircuit "subCircuitUserField1": <value>, "subCircuitUserField2": <value> } ], "attributes": { // Optional, used when user-defined attributes are configured for the Circuit "circuitUserField1": <value>, "circuitUserField2": <value> } }

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 in which the circuit will be created.

Syntax:

Use dark colors for code blocksCopy

domainNetworkName=<string>

Example:

Use dark colors for code blocksCopy

domainNetworkName=Telco

circuits

(Required)

The circuit and circuit information to be created.

Syntax:

Use dark colors for code blocksCopy
{
"circuits":[
  {
    "name": <string>,
    "globalId": <guid>,
    "isSectioned": <boolean>,
    "sectionOrder": <string>,
    "circuitType": "Physical" | "Virtual",               // Default is Physical
    "startLocation" :              // Only when isSectioned is false
      {
        "sourceId"   : <short>,
        "globalId"   : <guid>,
        "terminalId" : <short>,
        "firstUnit"  : <short>,
        "lastUnit"   : <short>
      },
    "stopLocation" :              // Only when isSectioned is false
      {
        "sourceId"   : <short>,
        "globalId"   : <guid>,
        "terminalId" : <short>,
        "firstUnit"  : <short>,
        "lastUnit"   : <short>
      },
    "sections": [
      {
        "sectionId": <long>,
        "role": "Start and end"| "Start" | "End" | "Midspan",               // Default is Start and end
        "sectionType": "Physical" | "Virtual",               // Default is Physical
        "startLocation": {
          "sourceId"   : <short>,
          "globalId"   : <guid>,
          "terminalId" : <short>,
          "firstUnit"  : <short>,
          "lastUnit"   : <short>
          },
        "stopLocation": {
          "sourceId"   : <short>,
          "globalId"   : <guid>,
          "terminalId" : <short>,
          "firstUnit"  : <short>,
          "lastUnit"   : <short>
          },
        }
      ],
    "subcircuits": [
      {
          "name": <string>,
          "globalId": <guid>,
          "providerID": <guid>,
          "consumerId": <guid>,
          "isReserved": "true" | "false",               // Default is false
          "attributes": {               // Optional, used when user-defined attributes are configured for the Subcircuit
            "subCircuitUserField1": <value>,
            "subCircuitUserField2": <value>
        }
      ],
    "attributes": {               // Optional, used when user-defined attributes are configured for the Circuit
      "circuitUserField1": <value>,
      "circuitUserField2": <value>
    }
}

JSON Response syntax

Use dark colors for code blocksCopy
{
  "moment": <epochtime>,
  "exceededTransferLimit": <true | false>,
  "serviceEdits": [
    {
      "id": <layerId>,
      "editedFeatures": {
        "adds": [<currentFeature1>, <currentFeature2>]
      }
    }
  ],
  "success": <boolean>,
  "error" : {                   // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <string>,
    "details" : [ <string> ]
  }
}

Example usage

Request URL and parameters:

Use dark colors for code blocksCopy

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

Use the create operation to create a non-sectioned circuit named B21/T3U/99472809/00072653 in a telecom domain network named Telco.

Use dark colors for code blocksCopy

f=json
gdbVersion=sde.Default
domainNetworkName=Telco
circuit={
  "name": "B21/T3U/99472809/00072653",
  "isSectioned": false,
  "circuitType": "Physical",
  "startLocation": {
    "sourceId": 20,
    "globalId": "{8A1B5A33-3EBA-42CC-9085-31B22DAFE5DC}",
    "terminalId": 1,
    "firstUnit": 1,
    "lastUnit": 3
  },
  "stopLocation": {
    "sourceId": 20,
    "globalId": "{F081B917-499E-43FC-AEC9-7C1B313BF128}",
    "terminalId": 1,
    "firstUnit": 1,
    "lastUnit": 3
  },
  "subcircuits": [],
  "attributes": {
      "Band": 100
    }
}

JSON response:

Use dark colors for code blocksCopy
{
  "success": true
}

Use the create operation to create a virtual circuit named A32/T3U/79232211/82256420 composed of two physical sections and one virtual section, with a subcircuit in a telecom domain network named Telco.

Use dark colors for code blocksCopy

f=json
gdbVersion=sde.Default
domainNetworkName=Telco
circuit={
  "name": "A32/T3U/79232211/82256420",
  "isSectioned": true,
  "isDeleted": false,
  "sectionOrder": {
    "1": [2],
    "2": [3],
    "3": []
  },
  "circuitType": "Physical",
  "sections": [
    {
      "sectionId": 1,
      "role": "Start",
      "sectionType": "Physical",
      "startLocation": {
        "sourceId": 20,
        "globalId": "{665803BB-258E-4BAE-A5B2-27DBD8A83C30}",
        "terminalId": 1,
        "firstUnit": 1,
        "lastUnit": 1
      },
      "stopLocation": {
        "sourceId": 20,
        "globalId": "{58CB492A-1992-4518-A60F-6119B1317E89}",
        "terminalId": 1,
        "firstUnit": 1,
        "lastUnit": 1
      }
    },
    {
      "sectionId": 2,
      "role": "Midspan",
      "sectionType": "Virtual",
      "startLocation": {
        "sourceId": 20,
        "globalId": "{D301D944-E45F-4A7B-AF33-0A4C066DDD18}",
        "terminalId": 1,
        "firstUnit": 2,
        "lastUnit": 2
      },
      "stopLocation": {
        "sourceId": 20,
        "globalId": "{98B511E7-E53A-42E4-A886-C56C54E48A47}",
        "terminalId": 1,
        "firstUnit": 1,
        "lastUnit": 1
      }
    },
    {
      "sectionId": 3,
      "role": "End",
      "sectionType": "Physical",
      "startLocation": {
        "sourceId": 20,
        "globalId": "{EE9A69F2-F4BB-4B66-A331-9864704EF073}",
        "terminalId": 1,
        "firstUnit": 2,
        "lastUnit": 2
      },
      "stopLocation": {
        "sourceId": 20,
        "globalId": "{21F77D19-3A54-4253-AFA1-40B5C4B22477}",
        "terminalId": 1,
        "firstUnit": 1,
        "lastUnit": 1
      }
    }
  ],
  "subcircuits": [
    {
      "name": "S1A32/T3U/79232211/82256420A",
      "isReserved": "false"
    }
  ],
  "attributes": {
    "Private": "Yes"
  }
}

JSON response:

Use dark colors for code blocksCopy
{
  "moment": 1751470178333,
  "exceededTransferLimit": false,
  "serviceEdits": [
    {
      "id": 24,
      "editedFeatures": {
        "adds": [
          {
            "attributes": {
              "objectid": 22,
              "name": "S1A32/T3U/79232211/82256420A",
              "providerid": "{8DF1DB16-4731-415F-B340-A46F927321F0}",
              "consumerid": null,
              "globalid": "{E1130666-91AC-449D-8707-29A1ED5AA62C}",
              "created_user": "unadmin",
              "created_date": 1751470178000,
              "last_edited_user": "unadmin",
              "last_edited_date": 1751470178000
            }
          }
        ]
      }
    },
    {
      "id": 22,
      "editedFeatures": {
        "adds": [
          {
            "attributes": {
              "objectid": 845,
              "name": "A32/T3U/79232211/82256420",
              "sectionorder": "{\"1\":[2],\"2\":[3],\"3\":[]}",
              "status": 1,
              "isdeleted": 0,
              "lastverified": null,
              "lastexported": null,
              "startlocationsourceid": null,
              "startlocationid": null,
              "startlocationterminalid": null,
              "startlocationfirstunit": null,
              "startlocationlastunit": null,
              "stoplocationsourceid": null,
              "stoplocationid": null,
              "stoplocationterminalid": null,
              "stoplocationfirstunit": null,
              "stoplocationlastunit": null,
              "issectioned": 1,
              "circuittype": 1,
              "conflictcontainerstate": null,
              "globalid": "{8DF1DB16-4731-415F-B340-A46F927321F0}",
              "created_user": "unadmin",
              "created_date": 1751470178000,
              "last_edited_user": "unadmin",
              "last_edited_date": 1751470178000
            }
          }
        ]
      }
    },
    {
      "id": 23,
      "editedFeatures": {
        "adds": [
          {
            "attributes": {
              "objectid": 432,
              "circuitid": "{8DF1DB16-4731-415F-B340-A46F927321F0}",
              "sectionid": 1,
              "startlocationsourceid": 20,
              "startlocationid": "{665803BB-258E-4BAE-A5B2-27DBD8A83C30}",
              "startlocationterminalid": 1,
              "startlocationfirstunit": 1,
              "startlocationlastunit": 1,
              "stoplocationsourceid": 20,
              "stoplocationid": "{58CB492A-1992-4518-A60F-6119B1317E89}",
              "stoplocationterminalid": 1,
              "stoplocationfirstunit": 1,
              "stoplocationlastunit": 1,
              "role": 1,
              "sectiontype": 0,
              "globalid": "{FBFEC8EB-D043-4E6F-AF30-CCBD28BFF564}",
              "created_user": "unadmin",
              "created_date": 1751470178000,
              "last_edited_user": "unadmin",
              "last_edited_date": 1751470178000
            }
          },
          {
            "attributes": {
              "objectid": 433,
              "circuitid": "{8DF1DB16-4731-415F-B340-A46F927321F0}",
              "sectionid": 2,
              "startlocationsourceid": 20,
              "startlocationid": "{D301D944-E45F-4A7B-AF33-0A4C066DDD18}",
              "startlocationterminalid": 1,
              "startlocationfirstunit": 2,
              "startlocationlastunit": 1,
              "stoplocationsourceid": 20,
              "stoplocationid": "{98B511E7-E53A-42E4-A886-C56C54E48A47}",
              "stoplocationterminalid": 1,
              "stoplocationfirstunit": 1,
              "stoplocationlastunit": 1,
              "role": 3,
              "sectiontype": 1,
              "globalid": "{C16DDB5F-43CE-44B7-988B-ED1F919C5159}",
              "created_user": "unadmin",
              "created_date": 1751470178000,
              "last_edited_user": "unadmin",
              "last_edited_date": 1751470178000
            }
          },
          {
            "attributes": {
              "objectid": 434,
              "circuitid": "{8DF1DB16-4731-415F-B340-A46F927321F0}",
              "sectionid": 3,
              "startlocationsourceid": 20,
              "startlocationid": "{EE9A69F2-F4BB-4B66-A331-9864704EF073}",
              "startlocationterminalid": 1,
              "startlocationfirstunit": 2,
              "startlocationlastunit": 1,
              "stoplocationsourceid": 20,
              "stoplocationid": "{21F77D19-3A54-4253-AFA1-40B5C4B22477}",
              "stoplocationterminalid": 1,
              "stoplocationfirstunit": 1,
              "stoplocationlastunit": 1,
              "role": 2,
              "sectiontype": 0,
              "globalid": "{71824EE7-1A8C-4F00-8775-0C2D08D25E4E}",
              "created_user": "unadmin",
              "created_date": 1751470178000,
              "last_edited_user": "unadmin",
              "last_edited_date": 1751470178000
            }
          }
        ]
      }
    }
  ],
  "success": true
}

Use the create operation to create a circuit named A33/T3U/79233987/64456498 composed of two sections with a subcircuit serving the role of the first section in a telecom domain network named Telco.

Use dark colors for code blocksCopy

f=json
gdbVersion=sde.Default
domainNetworkName=Telco
circuit={
  "name": "A33/T3U/79233987/64456498",
  "isSectioned": true,
  "sectionOrder": {
    "1": [2],
    "2": []
  },
  "circuitType": "Physical",
  "sections": [
    {
      "sectionId": 1,
      "role": "Start",
      "sectionType": "Physical",
      "subcircuit": {
        "name": "SUB_64456498",
        "globalId": "{43CAA972-8679-424B-923A-D524BB8887A1}",
        "providerId": "{133A63F6-10F5-4EC7-8124-101278348CE7}",
        "consumerId": "",
        "isReserved": false
      }
    },
    {
      "sectionId": 2,
      "role": "End",
      "sectionType": "Physical",
      "startLocation": {
        "sourceId": 20,
        "globalId": "{728C3E4A-DA4B-4766-9CA5-AF19B9E3F89C}",
        "terminalId": 1,
        "firstUnit": 1,
        "lastUnit": 1
      },
      "stopLocation": {
        "sourceId": 20,
        "globalId": "{0E3D7C20-E74D-482F-AE40-4319BCF0EA74}",
        "terminalId": 1,
        "firstUnit": 1,
        "lastUnit": 1
      }
    }
  ],
  "subcircuits": [],
  "attributes": {}
}

JSON response:

Use dark colors for code blocksCopy
{
  "moment": 1751470880842,
  "exceededTransferLimit": false,
  "serviceEdits": [
    {
      "id": 24,
      "editedFeatures": {
        "updates": [
          [
            {
              "attributes": {
                "objectid": 3,
                "name": "SUB_64456498",
                "providerid": "{133A63F6-10F5-4EC7-8124-101278348CE7}",
                "consumerid": null,
                "globalid": "{43CAA972-8679-424B-923A-D524BB8887A1}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": "unadmin",
                "last_edited_date": 1751470760000
              }
            },
            {
              "attributes": {
                "objectid": 3,
                "name": "SUB_64456498",
                "providerid": "{133A63F6-10F5-4EC7-8124-101278348CE7}",
                "consumerid": "{90F03922-9E99-4B42-BF35-D8515698E823}",
                "globalid": "{43CAA972-8679-424B-923A-D524BB8887A1}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": "unadmin",
                "last_edited_date": 1751470880000
              }
            }
          ]
        ]
      }
    },
    {
      "id": 22,
      "editedFeatures": {
        "adds": [
          {
            "attributes": {
              "objectid": 846,
              "name": "A33/T3U/79233987/64456498",
              "sectionorder": "{\"1\":[2],\"2\":[]}",
              "status": 1,
              "isdeleted": 0,
              "lastverified": null,
              "lastexported": null,
              "startlocationsourceid": null,
              "startlocationid": null,
              "startlocationterminalid": null,
              "startlocationfirstunit": null,
              "startlocationlastunit": null,
              "stoplocationsourceid": null,
              "stoplocationid": null,
              "stoplocationterminalid": null,
              "stoplocationfirstunit": null,
              "stoplocationlastunit": null,
              "issectioned": 1,
              "circuittype": 0,
              "conflictcontainerstate": null,
              "globalid": "{90F03922-9E99-4B42-BF35-D8515698E823}",
              "created_user": "unadmin",
              "created_date": 1751470880000,
              "last_edited_user": "unadmin",
              "last_edited_date": 1751470880000
            }
          }
        ]
      }
    },
    {
      "id": 23,
      "editedFeatures": {
        "adds": [
          {
            "attributes": {
              "objectid": 435,
              "circuitid": "{90F03922-9E99-4B42-BF35-D8515698E823}",
              "sectionid": 1,
              "startlocationsourceid": 24,
              "startlocationid": "{43CAA972-8679-424B-923A-D524BB8887A1}",
              "startlocationterminalid": null,
              "startlocationfirstunit": null,
              "startlocationlastunit": null,
              "stoplocationsourceid": null,
              "stoplocationid": null,
              "stoplocationterminalid": null,
              "stoplocationfirstunit": null,
              "stoplocationlastunit": null,
              "role": 1,
              "sectiontype": 0,
              "globalid": "{6B7CF250-50DE-4568-B03F-0EF35F30C082}",
              "created_user": "unadmin",
              "created_date": 1751470880000,
              "last_edited_user": "unadmin",
              "last_edited_date": 1751470880000
            }
          },
          {
            "attributes": {
              "objectid": 436,
              "circuitid": "{90F03922-9E99-4B42-BF35-D8515698E823}",
              "sectionid": 2,
              "startlocationsourceid": 20,
              "startlocationid": "{728C3E4A-DA4B-4766-9CA5-AF19B9E3F89C}",
              "startlocationterminalid": 1,
              "startlocationfirstunit": 1,
              "startlocationlastunit": 1,
              "stoplocationsourceid": 20,
              "stoplocationid": "{0E3D7C20-E74D-482F-AE40-4319BCF0EA74}",
              "stoplocationterminalid": 1,
              "stoplocationfirstunit": 1,
              "stoplocationlastunit": 1,
              "role": 2,
              "sectiontype": 0,
              "globalid": "{ACAB6DB7-2BCA-400E-93D4-41C81B67DDF5}",
              "created_user": "unadmin",
              "created_date": 1751470880000,
              "last_edited_user": "unadmin",
              "last_edited_date": 1751470880000
            }
          }
        ]
      }
    }
  ],
  "success": true
}