Start Connector

Starts a connector.

Connectors allow you to retrieve information from external systems and update it through Haven OnDemand APIs. You can use it to create an index of the data in the external repository, automate workflows, for notifications, or to facilitate migration to other locations.

The Start Connector API starts a run of a cloud flavor connector according to the configuration that you created with the Create Connector API.

By default, the connector runs with its normal configuration, and sends content to the configured destination. You can override the connector destination when you start the run. For example, if the connector is configured to index into one Haven OnDemand text index, you can trigger a run to output the data to a different index.

Quick Start

The Start Connector API has a single required parameter, connector, to specify the name of the connector to start.

Note: This API is available only for cloud flavor connectors, such as the Web Cloud Connector.

/1/api/[async|sync]/startconnector/v1?connector=myconnector

{
  "connector": "myconnector",
  "token": "MTI3LjAuMS4xOjcyMDA6RkVUQ0g6LTE5NzM4NzcxNg=="
}

The connector status then switches to QUEUED. When the connector starts processing the request, the status switches to PROCESSING until the job is complete. You can check the status and further information upon job completion by using the Connector Status API.

The token property in the response is a unique identifier for the connector run that starts when you send the Start Connector request. You can use it to filter the Connector History API to a specific connector run.

Synchronous
https://api.havenondemand.com/1/api/sync/startconnector/v1
Asynchronous
https://api.havenondemand.com/1/api/async/startconnector/v1
Authentication

This API requires an authentication token to be supplied in the following parameter:

Parameter Description
apikey The API key to use to authenticate the API request.
Parameters

This API accepts the following parameters:

Required
Name Type Description
connector
resource The name of the connector to start. Maximum length of 100 characters.
Optional
Name Type Description
destination
json A JSON object defining the destination to which the connector must send retrieved data. Currently it can send data only to a text index. This value overrides the currently configured destination. For details of the available properties, see the individual connector flavor documentation. See Connectors.
ignore_previous_state
boolean Set to true to ignore the state of previous connector runs. Default value: false.
token
string The decryption token to use for decrypting connector credentials and credentials_policy (you receive the token by email). This parameter applies only to connectors with credentials. It is required only if you modify the destination parameter when you start the connector. If the token that you provide is not valid, Haven OnDemand sends a new token to the configured email address for the connector credentials policy.

This API returns a JSON response that is described by the model below. This single model is presented both as an easy to read abstract definition and as the formal JSON schema.

Asynchronous Use

Additional requests are required to get the result if this API is invoked asynchronously.

You can use /1/job/status/<job-id> to get the status of the job, including results if the job is finished.

You can also use /1/job/result/<job-id>, which waits until the job has finished and then returns the result.

Model
This is an abstract definition of the response that describes each of the properties that might be returned.
Start Connector Response {
connector ( string ) The name of the connector.
token ( string ) Unique identifier for this specified connector run. Can be used with Connector History API to filter for the status of this connector run.
}
Model Schema
This is a JSON schema that describes the syntax of the response. See json-schema.org for a complete reference.
{
    "properties": {
        "connector": {
            "type": "string"
        },
        "token": {
            "type": "string"
        }
    },
    "required": [
        "connector",
        "token"
    ],
    "type": "object"
}


If you would like to provide us with more information then please use the box below:

We will use your submission to help improve our product.