Display Name: ConnectOriginsToDestinations

Description: Calculates routes between pairs of points.

Category:

Help URL: https://spatialags.vhb.com/arcgis/rest/directories/arcgisoutput/System/SpatialAnalysisTools_GPServer/System_SpatialAnalysisTools/ConnectOriginsToDestinations.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: originsLayer

Data Type: GPFeatureRecordSetLayer
Display Name originsLayer
Description: The routes start from points in the origins layer.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None

Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: destinationsLayer

Data Type: GPFeatureRecordSetLayer
Display Name destinationsLayer
Description: The routes end at points in the destinations layer.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None

Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: measurementType

Data Type: GPString
Display Name measurementType
Description: The routes can be determined by measuring travel distance or travel time along street network using different travel modes or by measuring straight line distance.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: DrivingTime
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: originsLayerRouteIDField

Data Type: GPString
Display Name originsLayerRouteIDField
Description: The field in the origins layer containing the IDs that are used to match an origin with a destination.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: destinationsLayerRouteIDField

Data Type: GPString
Display Name destinationsLayerRouteIDField
Description: The field in the destinations layer containing the IDs that are used to match an origin with a destination.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: timeOfDay

Data Type: GPDate
Display Name timeOfDay
Description: When measurementType is DrivingTime, this value specifies the time of day to be used for driving time calculations based on traffic. WalkingTime and TruckingTime measurementType do not support calculations based on traffic.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: timeZoneForTimeOfDay

Data Type: GPString
Display Name timeZoneForTimeOfDay
Description: Determines if the value specified for timeOfDay is specified in UTC or in a time zone that is local to the location of the origins.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: GeoLocal
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ GeoLocal, UTC ]

Parameter: outputName

Data Type: GPString
Display Name outputName
Description: Additional properties such as output feature service name.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: context

Data Type: GPString
Display Name context
Description: Additional settings such as processing extent and output spatial reference.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: includeRouteLayers

Data Type: GPBoolean
Display Name includeRouteLayers
Description:
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: pointBarrierLayer

Data Type: GPFeatureRecordSetLayer
Display Name pointBarrierLayer
Description: Specify one or more points to act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None

Features: None.



Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: lineBarrierLayer

Data Type: GPFeatureRecordSetLayer
Display Name lineBarrierLayer
Description: Specify one or more lines that prohibit travel anywhere the lines intersect the streets.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None

Features: None.



Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: polygonBarrierLayer

Data Type: GPFeatureRecordSetLayer
Display Name polygonBarrierLayer
Description: Specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None

Features: None.



Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: routeShape

Data Type: GPString
Display Name routeShape
Description: Specify the shape of the line connecting origins to their destinations.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: FollowStreets
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ FollowStreets, StraightLine ]

Parameter: routesLayer

Data Type: GPString
Display Name routesLayer
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: unassignedOriginsLayer

Data Type: GPString
Display Name unassignedOriginsLayer
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: unassignedDestinationsLayer

Data Type: GPString
Display Name unassignedDestinationsLayer
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: routeLayerItems

Data Type: GPString
Display Name routeLayerItems
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:

Supported Operations:   Submit Job

Child Resources:   Metadata