20220310 15324200 1.0 TRUE 20260111 210637 GetToolInfo 20220310 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. 005 ArcToolbox Tool 20220316 Environmental Systems Research Institute, Inc. (Esri) 380 New York Street Redlands California 92373-8100 info@esri.com United States 909-793-2853 909-793-5953 http://www.esri.com 007

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.

GetToolInfo _naservice 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. 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. 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 service SolveLocationAllocation for the asyncLocationAllocation service FindRoutes for the Route service GenerateServiceAreas for the asyncServiceArea service SolveVehicleRoutingProblem for the asyncVRP service EditVehicleRoutingProblem for the syncVRP service GenerateOriginDestinationCostMatrix for the asyncODCostMatrix service The default value is FindRoutes. 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 service SolveLocationAllocation for the asyncLocationAllocation service FindRoutes for the Route service GenerateServiceAreas for the asyncServiceArea service SolveVehicleRoutingProblem for the asyncVRP service EditVehicleRoutingProblem for the syncVRP service GenerateOriginDestinationCostMatrix for the asyncODCostMatrix service The default value is FindRoutes. 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. 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. This is the default. 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. The tool is meant to be used before executing other tools in the geoprocessing service. For example, if you need to identify the maximum number of stops supported by the FindRoutes tool, you can run GetToolInfo to determine the limit. The following Python script demonstrates how to use the GetToolInfo tool in a script. ''' The script shows how to use the GetToolInfo tool to get the maximum number of stops that can be used as inputs with FindRoutes tool. ''' import sys import json import arcpy #Change the username and password applicable to your own ArcGIS Online account username = "<your user name>" password = "<your password>" utility_service = "https://logistics.arcgis.com/arcgis/services;World/Utilities;{0};{1}".format(username, password) #Add the geoprocessing service as a toolbox. arcpy.ImportToolbox(utility_service) #Call the tool to get the limits for the FindRoutes tool result = arcpy.Utilities.GetToolInfo("asyncRoute", "FindRoutes") #Print any warning or error messages returned from the tool result_severity = arcpy.GetMaxSeverity() if result_severity == 2: arcpy.AddMessage("An error occured when running the tool") arcpy.AddMessage(arcpy.GetMessages(2)) sys.exit(2) elif result_severity == 1: arcpy.AddMessage("Warnings were returned when running the tool") arcpy.AddMessage(arcpy.GetMessages(1)) #Retrieve the tool info and convert it to a dictionary output_tool_info_json = result.getOutput(0) output_tool_info_dict = json.loads(output_tool_info_json) #Retrieve the maximum number of stops allowed by the service max_stops = int(output_tool_info_dict["serviceLimits"]["maximumStops"]) arcpy.AddMessage("The maximum number of stops supported by the FindRoutes tool: {}" .format(max_stops)) Provides information such as the description of the network dataset used for the analysis and execution limits for a tool available in the geoprocessing service. withheld