Utility Network Layer | ArcGIS REST APIs

URL:: https://<LinearReferencingService-url>/utilityNetworkLayers/<layerId>
Methods:: GET
Required Capability:: The ArcGIS Location Referencing license is required to use this resource.
Version Introduced:: 10.8

Description

This operation represents utility network layers in a linear referencing geodatabase. The Utility Network Pipeline Line layer is registered as the centerline layer in the linear referencing geodatabase while the Pipeline Device and Pipeline Junction layers contain point features.

Request parameters

Parameter Details

Parameter	Details
`f` (Optional)	Specifies the response format. The default response format is `html`. Values: `html` \| `json`

f

(Optional)

Specifies the response format. The default response format is html.

Values: html | json

Example usage

URL for utility network layer ID 0.

Use dark colors for code blocksCopy
https://organization.example.com/server/rest/services/MyLRS/MapServer/exts/LRServer/utilityNetworkLayers/0

JSON Response syntax

Use dark colors for code blocksCopy
// Pipeline Line response
{
  "id": <layerId>,
  "name": "<layerName>",
  "type": "esriLRSUtilityNetworkLayer",
  "featureClassName" : "<featureClassName>",
  "isDataVersioned": <true | false>,
  "isBranchVersioned": <true | false>,
  "versionName": "<versionName>",
  "dateFormat": "<sqlDateFormat>",    // one of: esriLRSDateFormatStandard, esriLRSDateFormatFileGDB, esriLRSDateFormatOracle
  "lrs": {
    "id": "<id>",
    "name": "<name>"
  },
  "routeIdFieldName": "<routeIdFieldName>",
  "fromMeasureFieldName": "<fromMeasureFieldName>",
  "toMeasureFieldName": "<toMeasureFieldName>",
  "fields": [
    {
      "name": "<fieldName1>",
      "type": "<fildType1>",
      "alias": "<fieldAlias1>",
      "editable": <true | false>,
      "nullable": <true | false>,
      "defaultValue": <defaultValue1>,
      "domain": <domain1>
    },
    {
      "name": "<fieldName2>",
      "type": "<fildType2>",
      "alias": "<fieldAlias2>",
      "editable": <true | false>,
      "nullable": <true | false>,
      "defaultValue": <defaultValue2>,
      "domain": <domain2>
    },
    ...
  ]
}

Use dark colors for code blocksCopy
{
 // Pipeline Device response
  "id": <layerId>,
  "name": "<layerName>",
  "type": "esriLRSUtilityNetworkLayer",
  "featureClassName" : "<featureClassName>",
  "isDataVersioned": <true | false>,
  "isBranchVersioned": <true | false>,
  "versionName": "<versionName>",
  "dateFormat": "<sqlDateFormat>",    // one of: esriLRSDateFormatStandard, esriLRSDateFormatFileGDB, esriLRSDateFormatOracle
  "lrs": {
    "id": "<id>",
    "name": "<name>"
  },
  "routeIdFieldName": "<routeIdFieldName>",
  "fromMeasureFieldName": "<fromMeasureFieldName>",
  "fields": [
    {
      "name": "<fieldName1>",
      "type": "<fildType1>",
      "alias": "<fieldAlias1>",
      "editable": <true | false>,
      "nullable": <true | false>,
      "defaultValue": <defaultValue1>,
      "domain": <domain1>
    },
    {
      "name": "<fieldName2>",
      "type": "<fildType2>",
      "alias": "<fieldAlias2>",
      "editable": <true | false>,
      "nullable": <true | false>,
      "defaultValue": <defaultValue2>,
      "domain": <domain2>
    },
    ...
  ]
}

Use dark colors for code blocksCopy
{
 // Pipeline Junction response
  "id": <layerId>,
  "name": "<layerName>",
  "type": "esriLRSUtilityNetworkLayer",
  "featureClassName" : "<featureClassName>",
  "isDataVersioned": <true | false>,
  "isBranchVersioned": <true | false>,
  "versionName": "<versionName>",
  "dateFormat": "<sqlDateFormat>",    // one of: esriLRSDateFormatStandard, esriLRSDateFormatFileGDB, esriLRSDateFormatOracle
  "lrs": {
    "id": "<id>",
    "name": "<name>"
  },
  "routeIdFieldName": "<routeIdFieldName>",
  "fromMeasureFieldName": "<fromMeasureFieldName>",
  "fields": [
    {
      "name": "<fieldName1>",
      "type": "<fildType1>",
      "alias": "<fieldAlias1>",
      "editable": <true | false>,
      "nullable": <true | false>,
      "defaultValue": <defaultValue1>,
      "domain": <domain1>
    },
    {
      "name": "<fieldName2>",
      "type": "<fildType2>",
      "alias": "<fieldAlias2>",
      "editable": <true | false>,
      "nullable": <true | false>,
      "defaultValue": <defaultValue2>,
      "domain": <domain2>
    },
    ...
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "id": 4,
  "name": "Centerline",
  "type": "esriLRSUtilityNetworkLayer",
  "featureClassName" : "dbo.centerline",
  "isDataVersioned": true,
  "isBranchVersioned": true,
  "versionName": "sde.DEFAULT",
  "dateFormat": "esriLRSDateFormatStandard",
  "centerlineIdFieldName": "CenterlineId",
  "lrs": {
    "id": "1D4BBF68-DF27-4B6F-AF4B-C20B132F980E",
    "name": "MyLRS"
  },
  "routeIdFieldName": "RouteId",
  "fromMeasureFieldName": "FromMeasure",
  "toMeasureFieldName": "ToMeasure",
  "fields": [
    {
      "name": "OBJECTID",
      "type": "esriFieldTypeOID",
      "alias": "OBJECT ID",
      "editable": false,
      "nullable": false,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "CenterlineId",
      "type": "esriFieldTypeGUID",
      "alias": "Centerline ID",
      "length": 38,
      "editable": true,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "GlobalID",
      "type": "esriFieldTypeGlobalID",
      "alias": "Global ID",
      "length": 38,
      "editable": false,
      "nullable": false,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Creator",
      "type": "esriFieldTypeString",
      "alias": "Creator",
      "length": 255,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Date_Created",
      "type": "esriFieldTypeDate",
      "alias": "Date Created",
      "length": 8,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Editor",
      "type": "esriFieldTypeString",
      "alias": "Editor",
      "length": 255,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Date_Edited",
      "type": "esriFieldTypeDate",
      "alias": "Date Edited",
      "length": 8,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "RouteId",
      "type": "esriFieldTypeString",
      "alias": "RouteId",
      "length": 255,
      "editable": true,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "FromMeasure",
      "type": "esriFieldTypeDouble",
      "alias": "FromMeasure",
      "editable": true,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "ToMeasure",
      "type": "esriFieldTypeDouble",
      "alias": "ToMeasure",
      "editable": true,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "SHAPE",
      "type": "esriFieldTypeGeometry",
      "alias": "Shape",
      "editable": true,
      "nullable": true,
      "domain": null
    },
    {
      "name": "SHAPE.STLength()",
      "type": "esriFieldTypeDouble",
      "alias": "Shape Length",
      "editable": false,
      "nullable": false,
      "defaultValue": null,
      "domain": null
    }
  ]
}

Use dark colors for code blocksCopy
{
  "id": 5,
  "name": "Devices",
  "type": "esriLRSUtilityNetworkLayer",
  "featureClassName": "dbo.devices",
  "isDataVersioned": true,
  "isBranchVersioned": true,
  "versionName": "sde.DEFAULT",
  "dateFormat": "esriLRSDateFormatStandard",
  "lrs": {
      "id": "1D4BBF68-DF27-4B6F-AF4B-C20B132F980E",
      "name": "MyLRS"
   },
  "routeIdFieldName": "RouteId",
  "fromMeasureFieldName": "Measure",
"fields": [
    {
      "name": "OBJECTID",
      "type": "esriFieldTypeOID",
      "alias": "OBJECT ID",
      "editable": false,
      "nullable": false,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "GlobalID",
      "type": "esriFieldTypeGlobalID",
      "alias": "Global ID",
      "length": 38,
      "editable": false,
      "nullable": false,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Creator",
      "type": "esriFieldTypeString",
      "alias": "Creator",
      "length": 255,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Date_Created",
      "type": "esriFieldTypeDate",
      "alias": "Date Created",
      "length": 8,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Editor",
      "type": "esriFieldTypeString",
      "alias": "Editor",
      "length": 255,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Date_Edited",
      "type": "esriFieldTypeDate",
      "alias": "Date Edited",
      "length": 8,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "RouteId",
      "type": "esriFieldTypeString",
      "alias": "RouteId",
      "length": 255,
      "editable": true,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Measure",
      "type": "esriFieldTypeDouble",
      "alias": "Measure",
      "editable": true,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "SHAPE",
      "type": "esriFieldTypeGeometry",
      "alias": "Shape",
      "editable": true,
      "nullable": true,
      "domain": null
    }
  ]
}

Use dark colors for code blocksCopy
{
  "id": 6,
  "name": "Junctions",
  "type": "esriLRSUtilityNetworkLayer",
  "featureClassName": "dbo.junctions",
  "isDataVersioned": true,
  "isBranchVersioned": true,
  "versionName": "sde.DEFAULT",
  "dateFormat": "esriLRSDateFormatStandard",
  "lrs": {
       "id": "1D4BBF68-DF27-4B6F-AF4B-C20B132F980E",
       "name": "MyLRS"
  },
  "routeIdFieldName": "RouteId",
  "fromMeasureFieldName": "Measure",
  "fields": [
    {
      "name": "OBJECTID",
      "type": "esriFieldTypeOID",
      "alias": "OBJECT ID",
      "editable": false,
      "nullable": false,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "GlobalID",
      "type": "esriFieldTypeGlobalID",
      "alias": "Global ID",
      "length": 38,
      "editable": false,
      "nullable": false,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Creator",
      "type": "esriFieldTypeString",
      "alias": "Creator",
      "length": 255,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Date_Created",
      "type": "esriFieldTypeDate",
      "alias": "Date Created",
      "length": 8,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Editor",
      "type": "esriFieldTypeString",
      "alias": "Editor",
      "length": 255,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Date_Edited",
      "type": "esriFieldTypeDate",
      "alias": "Date Edited",
      "length": 8,
      "editable": false,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "RouteId",
      "type": "esriFieldTypeString",
      "alias": "RouteId",
      "length": 255,
      "editable": true,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "Measure",
      "type": "esriFieldTypeDouble",
      "alias": "Measure",
      "editable": true,
      "nullable": true,
      "defaultValue": null,
      "domain": null
    },
    {
      "name": "SHAPE",
      "type": "esriFieldTypeGeometry",
      "alias": "Shape",
      "editable": true,
      "nullable": true,
      "domain": null
    }
  ]
}