Creates a connector

post deprecated

https://tracking.hereapi.com/c2c/v4/connectors

Registers a cloud-to-cloud connector between the HERE Tracking project projectId and an external cloud using the cloud-to-cloud driver driverId and the external cloud access credentials.

Query Params

projectId

string

length between 1 and 50

Project ID. Any HERE Tracking user must be a member of a Tracking project. The project ID can be implicitly resolved if the user calling the API is a member of a single project. If the user is a member of multiple projects, the projectId query parameter needs to be specified explicitly.

Body Params

name

string

required

length between 1 and 100

Name of the connector.

description

string

length ≤ 200

Brief description of the connector.

externalCloudInfo

object

required

An external cloud-specific object that the driver will use to login to the external cloud. The structure of this object varies per driver implementation. It is recommended to have dedicated credentials for logging in to the external cloud in order not to violate possible concurrent users policies of the external cloud. In case of the HERE Tracking loopback driver, the maximum allowed concurrent user account tokens is 3 per account, therefore it is recommended to create a separate HERE account and grant it the required privilege to update the connector's project, and use that account in externalCloudInfo.

driverId

string

required

length between 1 and 50

Identifier of the driver.

refreshIntervalS

integer

≥ 60

This is the interval (in seconds) to execute the sync process between the connector's external cloud and HERE Tracking project. The maximum and at the same time default value for callback-type connectors is 900 seconds. The default value for other type of connectors is 3600 seconds and there is no maximum value set.

enabled

boolean

required

Enabled state of the connector. If set to false then the connector will not execute periodically.

status

string

enum

Status of the connector creation. When the status is started, re-check the status later again. The actual connector can be used only when the creation status is 'completed'.

Allowed:

Headers

X-Request-Id

uuid

ID used for correlating requests within HERE Tracking. Used for logging and error reporting.

Must be a valid UUIDv4.

Responses

200Successful

202Accepted

400Bad request The request object is in an incorrect format or has values that are invalid or out of range. If available, further error details are provided in the response body.

401Unauthorized The request did not provide correct authentication details

403Forbidden The account does not have the correct privileges

404Not Found The specified resource was not found

409Conflict The specified resource already exists

429Too Many Requests User has sent too many requests in a given amount of time.