GetToolInfo operation | ArcGIS REST APIs

The /GetToolInfo direct request can only be published using configure routing services dialog box from ArcGIS Enterprise portal website, or publish using publish routing services command line utility. Use the following endpoint to access the /GetToolInfo direct request. The {{folderName}} represents the folder in which the services are being published.

GET

POST

Use dark colors for code blocksCopy
GET https://{{machineName}}/{{serverWebAdaptorName}}/rest/services/{{folderName}}/NetworkAnalysisUtilities/GPServer/GetToolInfo/execute

The Utilities service contains operations that provide auxiliary information for working with routing services available with ArcGIS Online. Currently, the Utilities service contains two operations, GetTravelModes and GetToolInfo . The GetToolInfo operation provides additional information such as the description of the network dataset used for the analysis and execution limits for an operation available as part of the routing services.

Parameters

Name	Type	Default	Description
`f`	`string`		The request response format, either `json` or `pjson`
`token`	`string`		An access token with the required privileges.
`serviceName`	`string`	`asyncRoute`	The service name containing the tool.
`toolName`	`string`	`FindRoutes`	The tool name in the geoprocessing service.
`includeNetworkSourceInfo`	`boolean`	`false`	Include information of all the source feature classes.

Required parameters

f

stringrequired

Values: json | pjson

The response format.

Use dark colors for code blocksCopy
f=json

token

stringrequired

Specify a token that provides the identity of a user that has the permissions to access the service. The security and authentication page provides more information about how an access token can be obtained.

Use dark colors for code blocksCopy
"token=<yourToken>"

serviceName

stringoptional

Default value: asyncRoute

Allowed values: asyncClosestFacility, asyncLocationAllocation, asyncRoute, asyncServiceArea,asyncODCostMatrix, asyncVRP, syncVRP

Specify 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 job request of the geoprocessing service used to perform the closest facility analysis.
asyncLocationAllocation —The job request of the geoprocessing service used to perform the location-allocation analysis.
asyncRoute —The job request of the geoprocessing service used to perform the route analysis.
asyncServiceArea —The job request of the geoprocessing service used to perform the service area analysis.
asyncODCostMatrix —The job request of the geoprocessing service used to perform the travel cost matrix analysis.
asyncVRP —The job request of the geoprocessing service used to perform the fleet routing analysis.
syncVRP —The direct request of the geoprocessing service used to perform the fleet routing analysis.

toolName

stringoptional

Default value: FindRoutes

Allowed values: FindClosestFacilities, SolveLocationAllocation, FindRoutes, GenerateServiceAreas, GenerateOriginDestinationCostMatrix, SolveVehicleRoutingProblem, EditVehicleRoutingProblem

Specify 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. The following are the valid tool names:

FindClosestFacilities for asyncClosestFacility service
SolveLocationAllocation for asyncLocationAllocation service
FindRoutes for asyncRoute service
GenerateServiceAreas for asyncServiceArea service
SolveVehicleRoutingProblem for asyncVRP service
EditVehicleRoutingProblem for syncVRP service
GenerateOriginDestinationCostMatrix for asyncODCostMatrix service

includeNetworkSourceInfo

booleanoptional

Default value: false

Specify whether the information of all the source feature classes that participate in the network dataset will be included.

true— 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.
false— The information will not be included.

Response details

The request to the GetToolInfo operation returns a JSON response that contains any warning messages from the service execution as well a value for the output parameter toolInfo. If the request fails to execute, the response only contains the error property that contains the error messages.

For a list of error codes and details, go to Direct request error codes

You can make a request to the GetToolInfo operation from the Utilities service using the URL of the following form

POST
Use dark colors for code blocksCopy
https://{{machineName}}/{{serverWebAdaptorName}}/rest/services/Routing/NetworkAnalysisUtilities/GPServer/GetToolInfo/execute

Use dark colors for code blocksCopy
{
  "results": [
    {
      "paramName": "<paramName1>",
      "dataType": "<dataType1>",
      "value": "<valueLiteralOrObject1>"
    }
  ],
  "messages": [
    {
      "type": "<type1>",
      "description": "<description1>"
    },
    {
      "type": "<type2>",
      "description": "<description2>"
    }
  ]
}

Use dark colors for code blocksCopy
{
  "error": {
    "code": "<code>",
    "message": "<message>",
    "details": ["<details>"]
  }
}

Upon successful completion, the service returns the tool info, which contains the network dataset and the service limits for the given tool.

toolInfo

type:string

Use this parameter to a get a description of the network dataset used for the analysis and service limits for a tool available in the geoprocessing service.

The following shows an example of the toolInfo parameter.

Example:

Use dark colors for code blocksCopy
{
  "paramName": "toolInfo",
  "dataType": "GPString",
  "value": {
    "networkDataset": {
      "attributeParameterValues": [
        {
          "attributeName": "Avoid Limited Access Roads",
          "parameterName": "Restriction Usage",
          "parameterType": "Double",
          "value": "AVOID_MEDIUM"
        },
        {
          "attributeName": "Avoid Ferries",
          "parameterName": "Restriction Usage",
          "parameterType": "Double",
          "value": "AVOID_MEDIUM"
        },
        {
          "attributeName": "Avoid Unpaved Roads",
Expand

Examples

Get the tool information for an example tool

In this example you will get the tool information for the SolveVehicleRoutingProblem tool.

Use dark colors for code blocksCopy
POST https://route-api.arcgis.com/arcgis/rest/services/World/Utilities/GPServer/GetToolInfo/execute?serviceName=asyncVRP&toolName=SolveVehicleRoutingProblem HTTP/1.1
Content-Type: application/x-www-form-urlencoded

token=<ACCESS_TOKEN>
&f=json

Use dark colors for code blocksCopy
{
  "results": [
    {
      "paramName": "toolInfo",
      "dataType": "GPString",
      "value": {
        "networkDataset": {
          "attributeParameterValues": [
            {
              "attributeName": "Avoid Limited Access Roads",
              "parameterName": "Restriction Usage",
              "parameterType": "Double",
              "value": "AVOID_MEDIUM"
            },
            {
              "attributeName": "Avoid Ferries",
              "parameterName": "Restriction Usage",
              "parameterType": "Double",
              "value": "AVOID_MEDIUM"
            },
Expand