ArcGIS REST Services Directory
Login
|
Get Token
Home
>
services
>
Transportation
>
NetworkAnalysis (GPServer)
>
FindRoutes
>
execute
API Reference
Execute Task (FindRoutes)
Stops:
(
GPFeatureRecordSetLayer
)
{ "features": [], "exceededTransferLimit": false, "displayFieldName": "", "spatialReference": { "latestWkid": 4326, "wkid": 4326 }, "fields": [ { "name": "OBJECTID", "alias": "OBJECTID", "type": "esriFieldTypeOID" }, { "name": "Name", "length": 500, "alias": "Name", "type": "esriFieldTypeString" }, { "name": "RouteName", "length": 1024, "alias": "Route Name", "type": "esriFieldTypeString" }, { "name": "Sequence", "alias": "Sequence", "type": "esriFieldTypeInteger" }, { "name": "AdditionalTime", "alias": "Additional Time", "type": "esriFieldTypeDouble" }, { "name": "AdditionalDistance", "alias": "Additional Distance", "type": "esriFieldTypeDouble" }, { "name": "TimeWindowStart", "length": 8, "alias": "Time Window Start", "type": "esriFieldTypeDate" }, { "name": "TimeWindowEnd", "length": 8, "alias": "Time Window End", "type": "esriFieldTypeDate" }, { "name": "CurbApproach", "alias": "Curb Approach", "type": "esriFieldTypeSmallInteger" }, { "name": "LocationType", "alias": "Location Type", "type": "esriFieldTypeInteger" }, { "name": "AdditionalCost", "alias": "Additional Cost", "type": "esriFieldTypeDouble" } ], "geometryType": "esriGeometryPoint" }
Measurement Units:
(
GPString
)
Minutes
Analysis Region:
(
GPString
)
Reorder Stops to Find Optimal Routes:
(
GPBoolean
)
false
Preserve Terminal Stops:
(
GPString
)
Preserve First
Return to Start:
(
GPBoolean
)
false
Use Time Windows:
(
GPBoolean
)
false
Time of Day:
(
GPDate
)
Time Zone for Time of Day:
(
GPString
)
Geographically Local
UTurn at Junctions:
(
GPString
)
Allowed Only at Intersections and Dead Ends
Point Barriers:
(
GPFeatureRecordSetLayer
)
{ "features": [], "exceededTransferLimit": false, "displayFieldName": "", "spatialReference": { "latestWkid": 4326, "wkid": 4326 }, "fields": [ { "name": "OBJECTID", "alias": "OBJECTID", "type": "esriFieldTypeOID" }, { "name": "Name", "length": 500, "alias": "Name", "type": "esriFieldTypeString" }, { "name": "BarrierType", "alias": "Barrier Type", "type": "esriFieldTypeInteger" }, { "name": "Additional_Time", "alias": "Additional Time", "type": "esriFieldTypeDouble" }, { "name": "Additional_Distance", "alias": "Additional Distance", "type": "esriFieldTypeDouble" }, { "name": "AdditionalCost", "alias": "Additional Cost", "type": "esriFieldTypeDouble" }, { "name": "CurbApproach", "alias": "Curb Approach", "type": "esriFieldTypeSmallInteger" }, { "name": "FullEdge", "alias": "Full Edge", "type": "esriFieldTypeInteger" } ], "geometryType": "esriGeometryPoint" }
Line Barriers:
(
GPFeatureRecordSetLayer
)
{ "features": [], "exceededTransferLimit": false, "displayFieldName": "", "spatialReference": { "latestWkid": 4326, "wkid": 4326 }, "fields": [ { "name": "OBJECTID", "alias": "OBJECTID", "type": "esriFieldTypeOID" }, { "name": "Name", "length": 500, "alias": "Name", "type": "esriFieldTypeString" }, { "name": "SHAPE_Length", "alias": "SHAPE_Length", "type": "esriFieldTypeDouble" } ], "geometryType": "esriGeometryPolyline" }
Polygon Barriers:
(
GPFeatureRecordSetLayer
)
{ "features": [], "exceededTransferLimit": false, "displayFieldName": "", "spatialReference": { "latestWkid": 4326, "wkid": 4326 }, "fields": [ { "name": "OBJECTID", "alias": "OBJECTID", "type": "esriFieldTypeOID" }, { "name": "Name", "length": 500, "alias": "Name", "type": "esriFieldTypeString" }, { "name": "BarrierType", "alias": "Barrier Type", "type": "esriFieldTypeInteger" }, { "name": "ScaledTimeFactor", "alias": "Scaled Time Factor", "type": "esriFieldTypeDouble" }, { "name": "ScaledDistanceFactor", "alias": "Scaled Distance Factor", "type": "esriFieldTypeDouble" }, { "name": "ScaledCostFactor", "alias": "Scaled Cost Factor", "type": "esriFieldTypeDouble" }, { "name": "SHAPE_Length", "alias": "SHAPE_Length", "type": "esriFieldTypeDouble" }, { "name": "SHAPE_Area", "alias": "SHAPE_Area", "type": "esriFieldTypeDouble" } ], "geometryType": "esriGeometryPolygon" }
Use Hierarchy:
(
GPBoolean
)
false
Restrictions:
(
GPMultiValue:GPString
)
["Avoid_UnpavedRoads","Oneway"]
Attribute Parameter Values:
(
GPRecordSet
)
{ "features": [ {"attributes": { "OBJECTID": 1, "ParameterValue": "AVOID_MEDIUM", "AttributeName": "Avoid_UnpavedRoads", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 2, "ParameterValue": "PROHIBITED", "AttributeName": "Oneway", "ParameterName": "Restriction Usage" }} ], "exceededTransferLimit": false, "displayFieldName": "", "fields": [ { "name": "OBJECTID", "alias": "ObjectID", "type": "esriFieldTypeOID" }, { "name": "AttributeName", "length": 255, "alias": "AttributeName", "type": "esriFieldTypeString" }, { "name": "ParameterName", "length": 255, "alias": "ParameterName", "type": "esriFieldTypeString" }, { "name": "ParameterValue", "length": 25, "alias": "ParameterValue", "type": "esriFieldTypeString" } ] }
Route Shape:
(
GPString
)
True Shape
Route Line Simplification Tolerance:
(
GPLinearUnit
)
Populate Route Edges:
(
GPBoolean
)
false
Populate Directions:
(
GPBoolean
)
true
Directions Language:
(
GPString
)
en
Directions Distance Units:
(
GPString
)
Miles
Directions Style Name:
(
GPString
)
NA Desktop
Travel Mode:
(
GPString
)
Custom
Impedance:
(
GPString
)
Drive Time
Time Zone for Time Windows:
(
GPString
)
Geographically Local
Save Output Network Analysis Layer:
(
GPBoolean
)
false
Overrides:
(
GPString
)
Save Route Data:
(
GPBoolean
)
false
Time Impedance:
(
GPString
)
Drive_Time
Distance Impedance:
(
GPString
)
Length
Output Format:
(
GPString
)
Feature Set
Accumulate Attributes:
(
GPMultiValue:GPString
)
[]
Ignore Network Location Fields:
(
GPBoolean
)
false
Ignore Invalid Locations:
(
GPBoolean
)
true
Locate Settings:
(
GPString
)
{"default": { "toleranceUnits": "esriMeters", "allowAutoRelocate": true, "sources": [{"name": "COHNetwork_Streets_line"}], "tolerance": 20000 }}
Options:
ReturnZ:
True
False
ReturnM:
True
False
Return True Curves:
True
False
Return Feature Collection:
True
False
Return Column Name:
True
False
Simplify Features:
True
False
Context:
Format:
HTML
JSON
KMZ
GeoJSON