Skip To Content ArcGIS for Developers Sign In Dashboard

Utility Network Layer

Description

License:

The ArcGIS Pipeline Referencing for Server extension is required to use this resource.

The utilityNetworkLayers service represents a utility network layer that is registered as a centerline layer in a linear referencing geodatabase.

Request parameters

ParameterDetails
f

Description: Optional parameter to specify the response format. The default response format is html.

Values: html | json

Example usage

Example

URL for utility network layer ID 0.

https://sampleserver/arcgis/rest/services/MyLRS/MapServer/exts/LRServer/utilityNetworkLayers/0

JSON Response syntax

{
    "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>
        },
        ...
    ]
}

JSON Response example

{
    "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
        }
    ]
}