Display Name: GetToolInfo

Description: Get information such as the description of the network dataset used for the analysis and the execution limits for a tool in the geoprocessing service.

Category:

Help URL: https://gis.noaca.org/arcgis/rest/directories/arcgisoutput/OSMArouting/NetworkAnalysisUtilities_GPServer/OSMArouting_NetworkAnalysisUtilities/GetToolInfo.htm

Execution Type: esriExecutionTypeSynchronous

Parameters:

Parameter: serviceName

Data Type: GPString
Display Name Service Name
Description: The service name containing the tool. The parameter value should be specified using one of the following keywords that reference a particular geoprocessing service: asyncClosestFacility—The asynchronous geoprocessing service used to perform the closest facility analysis. asyncLocationAllocation—The asynchronous geoprocessing service used to perform the location-allocation analysis. asyncRoute—The asynchronous geoprocessing service used to perform the route analysis. asyncServiceArea—The asynchronous geoprocessing service used to perform the service area analysis. asyncVRP—The asynchronous geoprocessing service used to perform the vehicle routing problem analysis. syncVRP—The synchronous geoprocessing service used to perform the vehicle routing problem analysis.asyncODCostMatrix—The asynchronous geoprocessing service used to perform the origin destination cost matrix analysis. The default value is asyncRoute.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: asyncRoute
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ asyncClosestFacility, asyncLocationAllocation, asyncODCostMatrix, asyncRoute, asyncServiceArea, asyncVRP, syncVRP, asyncFleetRouting ]


Parameter: toolName

Data Type: GPString
Display Name Tool Name
Description: The tool name in the geoprocessing service. The parameter value should be a valid tool name in the geoprocessing service specified by the serviceName parameter. Valid tool names are as follows:FindClosestFacilities for the asyncClosestFacility serviceSolveLocationAllocation for the asyncLocationAllocation serviceFindRoutes for the Route serviceGenerateServiceAreas for the asyncServiceArea serviceSolveVehicleRoutingProblem for the asyncVRP serviceEditVehicleRoutingProblem for the syncVRP serviceGenerateOriginDestinationCostMatrix for the asyncODCostMatrix serviceThe default value is FindRoutes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: FindRoutes
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ EditVehicleRoutingProblem, FindClosestFacilities, FindRoutes, GenerateOriginDestinationCostMatrix, GenerateServiceAreas, SolveLocationAllocation, SolveVehicleRoutingProblem, SolveLastMileDelivery ]


Parameter: toolInfo

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


Parameter: includeNetworkSourceInfo

Data Type: GPBoolean
Display Name Include Network Source Info
Description: Specify whether the information of all the source feature classes that participate in the network dataset will be included. Checked—Information such as the name, type, id, and the schema for all the source feature classes that participate in the network dataset will be included.Unchecked—The information will not be included. This is the default.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:

Supported Operations:   Execute Task

Child Resources:   Metadata