ArcGIS REST Services Directory
Login
Home
>
services
>
Routing
>
NetworkAnalysis (GPServer)
>
FindRoutes
>
submitJob
Help
|
API Reference
Submit Job (FindRoutes)
Stops:
(
GPFeatureRecordSetLayer
)
{ "displayFieldName": "", "geometryType": "esriGeometryPoint", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "Route Name", "length": 1024 }, { "name": "Sequence", "type": "esriFieldTypeInteger", "alias": "Sequence" }, { "name": "AdditionalTime", "type": "esriFieldTypeDouble", "alias": "Additional Time" }, { "name": "AdditionalDistance", "type": "esriFieldTypeDouble", "alias": "Additional Distance" }, { "name": "TimeWindowStart", "type": "esriFieldTypeDate", "alias": "Time Window Start", "length": 8 }, { "name": "TimeWindowEnd", "type": "esriFieldTypeDate", "alias": "Time Window End", "length": 8 }, { "name": "CurbApproach", "type": "esriFieldTypeSmallInteger", "alias": "Curb Approach" }, { "name": "LocationType", "type": "esriFieldTypeInteger", "alias": "Location Type" }, { "name": "AdditionalCost", "type": "esriFieldTypeDouble", "alias": "Additional Cost" } ], "features": [], "exceededTransferLimit": false }
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
)
null
Time Zone for Time of Day:
(
GPString
)
Geographically Local
UTurn at Junctions:
(
GPString
)
Allowed Only at Dead Ends
Point Barriers:
(
GPFeatureRecordSetLayer
)
{ "displayFieldName": "", "geometryType": "esriGeometryPoint", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "BarrierType", "type": "esriFieldTypeInteger", "alias": "Barrier Type" }, { "name": "Additional_Time", "type": "esriFieldTypeDouble", "alias": "Additional Time" }, { "name": "Additional_Distance", "type": "esriFieldTypeDouble", "alias": "Additional Distance" }, { "name": "AdditionalCost", "type": "esriFieldTypeDouble", "alias": "Additional Cost" }, { "name": "CurbApproach", "type": "esriFieldTypeSmallInteger", "alias": "Curb Approach" }, { "name": "FullEdge", "type": "esriFieldTypeInteger", "alias": "Full Edge" } ], "features": [], "exceededTransferLimit": false }
Line Barriers:
(
GPFeatureRecordSetLayer
)
{ "displayFieldName": "", "geometryType": "esriGeometryPolyline", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "SHAPE_Length", "type": "esriFieldTypeDouble", "alias": "SHAPE_Length" } ], "features": [], "exceededTransferLimit": false }
Polygon Barriers:
(
GPFeatureRecordSetLayer
)
{ "displayFieldName": "", "geometryType": "esriGeometryPolygon", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "BarrierType", "type": "esriFieldTypeInteger", "alias": "Barrier Type" }, { "name": "ScaledTimeFactor", "type": "esriFieldTypeDouble", "alias": "Scaled Time Factor" }, { "name": "ScaledDistanceFactor", "type": "esriFieldTypeDouble", "alias": "Scaled Distance Factor" }, { "name": "ScaledCostFactor", "type": "esriFieldTypeDouble", "alias": "Scaled Cost Factor" }, { "name": "SHAPE_Length", "type": "esriFieldTypeDouble", "alias": "SHAPE_Length" }, { "name": "SHAPE_Area", "type": "esriFieldTypeDouble", "alias": "SHAPE_Area" } ], "features": [], "exceededTransferLimit": false }
Use Hierarchy:
(
GPBoolean
)
true
Restrictions:
(
GPMultiValue:GPString
)
["Bus Lanes","Fords","Gated Communities","Non Legal Roads","One Way","Private Roads","Restricted Roads","Restricted Turns","Rough Surface Roads","State Highway","Vehicles on Cycleways","Vehicles on Walkways"]
Attribute Parameter Values:
(
GPRecordSet
)
{ "displayFieldName": "", "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "AttributeName", "type": "esriFieldTypeString", "alias": "AttributeName", "length": 255 }, { "name": "ParameterName", "type": "esriFieldTypeString", "alias": "ParameterName", "length": 255 }, { "name": "ParameterValue", "type": "esriFieldTypeString", "alias": "ParameterValue", "length": 25 } ], "features": [ {"attributes": { "OBJECTID": 1, "AttributeName": "Bus Lanes", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 2, "AttributeName": "Cycles on Motorways", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 3, "AttributeName": "Cycles on Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PREFER_HIGH" }}, {"attributes": { "OBJECTID": 4, "AttributeName": "Fords", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_LOW" }}, {"attributes": { "OBJECTID": 5, "AttributeName": "Gated Communities", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_HIGH" }}, {"attributes": { "OBJECTID": 6, "AttributeName": "Non Legal Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_LOW" }}, {"attributes": { "OBJECTID": 7, "AttributeName": "One Way", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 8, "AttributeName": "Private Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_LOW" }}, {"attributes": { "OBJECTID": 9, "AttributeName": "Restricted Height", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 10, "AttributeName": "Restricted Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 11, "AttributeName": "Restricted Turns", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 12, "AttributeName": "Restricted Weight", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 13, "AttributeName": "Rough Surface Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_HIGH" }}, {"attributes": { "OBJECTID": 14, "AttributeName": "State Highway", "ParameterName": "Restriction Usage", "ParameterValue": "PREFER_MEDIUM" }}, {"attributes": { "OBJECTID": 15, "AttributeName": "Trucks Allowed", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 16, "AttributeName": "Trucks Allowed with Permit", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 17, "AttributeName": "Vehicles on Cycleways", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 18, "AttributeName": "Vehicles on Walkways", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 19, "AttributeName": "Walking on Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }} ], "exceededTransferLimit": false }
Route Shape:
(
GPString
)
True Shape
Route Line Simplification Tolerance:
(
GPLinearUnit
)
{ "distance": 5, "units": "esriMeters" }
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
)
TravelTimeByVehicle
Distance Impedance:
(
GPString
)
Length
Output Format:
(
GPString
)
Feature Set
Accumulate Attributes:
(
GPMultiValue:GPString
)
[]
Ignore Network Location Fields:
(
GPBoolean
)
false
Options:
Output Spatial Reference:
Process Spatial Reference:
ReturnZ:
True
False
ReturnM:
True
False
Return True Curves:
True
False
Context:
Format:
HTML
JSON
KMZ
GeoJSON