Display Name: AnalyzeGeocodeInput

Description: Analyze File auto-generates a field mapping for the input table or file provided, and outputs GeocodeParameters JSON. The JSON output is a required parameter for the BatchGeocode Tool.

Category:

Help URL: https://gis.wcc.govt.nz/arcgis/rest/directories/arcgisoutput/Utilities/GeocodingTools_GPServer/Utilities_GeocodingTools/AnalyzeGeocodeInput.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: geocodeServiceURL

Data Type: GPString
Display Name geocodeServiceURL
Description: The geocode service that should geocode the input table or file. The service should support batch geocoding and have a geocodeAddresses REST endpoint. This URL should end in GeocodeServer
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: inputTable

Data Type: GPRecordSet
Display Name inputTable
Description: The portal item URL of a table in an input feature service to be geocoded. ServiceToken does not need to be rpovided if the table is on the hosting server. Example input: {"url":"<serverURL>/rest/services/Hosted/input_table/FeatureServer/0","serviceToken":"<token>"}
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Fields: None

Features: None.



Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: inputFileItem

Data Type: GPString
Display Name inputFileItem
Description: The itemid of the portal file as input to the geocoding service. The itemid should correspond to a CSV or Microsoft Excel file in the Portal. Example input: {"itemid":"b5606093e2c24851a499d6f25676e823"}
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: columnNames

Data Type: GPString
Display Name columnNames
Description: If your file does not contain a header row, then "columnNames" CANNOT be empty. Specify the column names separated by commas, like so: address,city,state,zip. You can also pass this instead of passing an inputFile or inputTable.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: inputFileParameters

Data Type: GPString
Display Name inputFileParameters
Description: Enter the JSON of input file Parameters. Example JSON:{"fileType": "xlsx","headerRowExists": "true","columnDelimiter":"","textQualifier":""}
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: locale

Data Type: GPString
Display Name locale
Description: If your data is not English, make sure to fill out your locale in order to ensure a language-specific field mapping. Enter a 2-letter or 4-letter specific locale. Examples include "en" or "ar-bh"
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: geocodeParameters

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

Supported Operations:   Submit Job

Child Resources:   Metadata