HERE Batch API v7 request parameters
All parameter listed in the below table are optional. Exceptions are tagged as "Required"
Common
| Parameter | Type | Default | Definition |
|---|---|---|---|
| apiKey | String | Api Key for authentication and authorization. See Create an app in Get started. Either this or Authorization header have to be set. | |
| Authorization | String (header> | Bearer token generated with OAauth credentials. See Create an app in Get started. Either this or apiKey parameter to be set. | |
| X-Request-ID | String (header) | User-provided token that can be used to trace a request or a group of requests sent to the service |
Request parameters for listing jobs
| Parameter | Type | Default | Definition |
|---|---|---|---|
| limit | Number | 100 | Limits the number of results returned in the response |
| offset | Number | 0 | For supporting paging by offset - the result list will start at the given offset |
| status | String | 'any' | Available values: any, submitted, queued, pending, inProgress, completed, stopped, failure |
| tag | String | A user supplied string that denotes one or more Jobs. |
Request parameters for job submission
Note
The parameter names in this section are all case-sensitive.
| Parameter | Type | Default | Description |
|---|---|---|---|
| serviceHrn | String, Required | The HERE Resource Name Identifier of the Service targeted by the Job | |
| tag | String | A user supplied string that denotes one or more Jobs. Can be used to filter Job responses on delete and get operations. | |
| billingTags | String | A user supplied string that specifies the billing tags of the Job. Up to six billing tags can be concatenated with + to a long string. Duplicates will be ignored (taken as single). Must be between 4-16 characters, case-sensitive. Allowed characters are alpha/numeric ASCII characters [A-Za-z0-9] and the following special characters (not begin or end with): - _. | |
| inputDelimiter | Char | | | Field delimiter in the input data. Supported characters include any single character, but we recommend pipe, comma, semicolon, colon or tab. |
| outputDelimiter | Char | | | Character used to delimit fields in the Job Results. Supported characters include any single character, but we recommend pipe, comma, semicolon, colon or tab. |
| inputColumns | String | A format descriptor used to interpret fields in the Job Input. Every record in the input will be split by the input delimiter and compared to the supplied format descriptor during processing, if the record does not conform to the format description the record will be marked as invalid. Every record will be identified by a record identifier (called recId in the format descriptor). You can choose to have the record identifiers be auto-generated for you by leaving out recId in the header or input format descriptor. The format descriptor can be left empty if the input has a header describing the format, or is formatted as requests in the URL query format. | |
| outputColumns | String | A descriptor used to format fields in the Job Results. Every result in the output will be split by the output delimiter and formatted according to the supplied descriptor during processing. Fields supported by the API will be interpreted, those that are not will be ignored. A field is recognized by matching it to an expected name or variants of that name. Character casing (i.e. lowercase or UPPERCASE) is ignored. General response parameters (such as recId) always precede the service specific parameters in the Job's output format and need not be specified in the format descriptor. If the format descriptor is absent a default output format is used. | |
| startJob | Boolean | true | A boolean value indicating if a job should be started immediately after creation. |
| outputType | String | 'csv' | (ALPHA) A String defining the desired format of the job's output. Currently supports 'csv' and 'jsonl' as possible output formats. See Get job results for more details. |
| notificationIds | String | (BETA) The notification ids that are invoked at the end of a job. |
Request parameters for job removal
| Parameter | Type | Default | Description |
|---|---|---|---|
| status | String Required | The status of the jobs to be deleted. For all jobs use any. This is a save gard to prevent an accidental wipe of all jobs due to a spelling error. | |
| tag | String | Remove only jobs with this tag |
Updated 29 days ago