Data Export Connectors API Code Samples

Selection of code samples that demonstrate the use of the Data Export Connectors API. Copy and edit these code samples to suit your needs.

When using the code samples, remember to replace:

  • {vanity_name} with your tenant name
  • {api_key} with your API key
  • {security_token} with a valid security token

These code samples may not include all available parameters and request body fields for each endpoint. For the endpoint's full request schema, see "Data Export Connectors" in API Reference.

Retrieve data export connectors

Use this sample request to retrieve all the data export connectors in your Visier tenant.

Copy
cURL sample request: Retrieve data export connectors
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/data/export-connectors/connectors' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns the details of all data export connectors.

Copy 
{
  "connectors": [
    {
      "id": "16222f34-0507-4d63-8f18-e36c39d91f30",
      "objectName": "ConnectorConfiguration",
      "basicInformation": {
        "displayName": "Data Connector Configuration",
        "description": "Data Connector Configuration Description"
      },
      "links": [
        {
          "linkedDataExport": {
            "dataExportId": "8d558939-17b0-4341-a43b-1f9f9e7d2c9c",
            "tableName": "headcount_by_department"
          }
        }
      ],
      "credentialIds": [
        "61054d4c-df70-460c-b294-2330353b2699"
      ]
    }
  ]
}

Retrieve data export connector credentials

Use this sample request to retrieve all the data export connector credentials in your Visier tenant.

Copy
cURL sample request: Retrieve data export connector credentials
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/data/export-connectors/connectors/credentials' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns the details of all data export connector credentials with masked sensitive values.

Copy 
{
  "credentials": [
    {
      "id": "61054d4c-df70-460c-b294-2330353b2699",
      "basicInformation": {
        "displayName": "Databricks Credential",
        "description": "Databricks data export connector credential"
      },
      "parameters": {
        "databricks": {
          "workspaceUrl": "https://example.cloud.databricks.com",
          "catalog": "example_catalog",
          "schema": "example_schema",
          "clientId": "{client_id}",
          "clientSecret": "********"
        }
      }
    }
  ]
}

Retrieve a data export connector credential

Use this sample request to retrieve a specific credential.

Copy
cURL sample request: Retrieve a data export connector credential
curl -X GET --location "https://{vanity_name}.api.visier.io/v1alpha/data/export-connectors/credentials/61054d4c-df70-460c-b294-2330353b2699" \
-H "apikey: {api_key}" \
-H "Cookie: VisierASIDToken={security_token}"

The response returns the credential values with masked sensitive values.

Copy 
{
  "id": "61054d4c-df70-460c-b294-2330353b2699",
  "basicInformation": {
    "displayName": "Databricks Credential",
    "description": "Databricks data export connector credential"
  },
  "parameters": {
    "databricks": {
      "workspaceUrl": "https://example.cloud.databricks.com",
      "catalog": "example_catalog",
      "schema": "example_schema",
      "clientId": "{client_id}",
      "clientSecret": "********"
    }
  }
}

Create a data export connector credential

Use this sample request to create a new credential.

Copy
cURL sample request: Create a data export connector credential
curl -X POST --url "https://{vanity_name}.api.visier.io/v1alpha/data/export-connectors/connectors/credentials/61054d4c-df70-460c-b294-2330353b2699" \
-H "apikey: {api_key}" \
-H "Cookie: VisierASIDToken={security_token}" \
-H "Content-Type: application/json" \
-d '{
    "id": "61054d4c-df70-460c-b294-2330353b2699",
    "basicInformation": {
        "displayName": "Databricks Credential",
        "description": "Databricks data export connector credential"
    },
    "parameters": {
        "databricks": {
        "workspaceUrl": "https://example.cloud.databricks.com",
        "catalog": "example_catalog",
        "schema": "example_schema",
        "clientId": "{client_id}",
        "clientSecret": "{client_secret}"
        }
    }
}'

The response returns the credential values with masked sensitive values.

Copy 
{
  "id": "61054d4c-df70-460c-b294-2330353b2699",
  "basicInformation": {
    "displayName": "Databricks Credential",
    "description": "Databricks data export connector credential"
  },
  "parameters": {
    "databricks": {
      "workspaceUrl": "https://example.cloud.databricks.com",
      "catalog": "example_catalog",
      "schema": "example_schema",
      "clientId": "{client_id}",
      "clientSecret": "********"
    }
  }
}

Update a data export connector credential

Use this sample request to update a credential. You must provide the full credential definition in the PUT request body.

Copy
cURL sample request: Update a data export connector credential
curl -X PUT --url "https://{vanity_name}.api.visier.io/v1alpha/data/export-connectors/connectors/credentials/61054d4c-df70-460c-b294-2330353b2699" \
-H "apikey: {api_key}" \
-H "Cookie: VisierASIDToken={security_token}" \
-H "Content-Type: application/json" \
-d '{
    "id": "61054d4c-df70-460c-b294-2330353b2699",
    "basicInformation": {
        "displayName": "Updated Databricks Credential",
        "description": "Updated Databricks data export connector credential"
    },
    "parameters": {
        "databricks": {
        "workspaceUrl": "https://example.cloud.databricks.com",
        "catalog": "updated_example_catalog",
        "schema": "updated_example_schema",
        "clientId": "{client_id}",
        "clientSecret": "{client_secret}"
        }
    }
}'

The response returns the updated credential values with masked sensitive values.

Copy 
{
  "id": "61054d4c-df70-460c-b294-2330353b2699",
  "basicInformation": {
    "displayName": "Updated Databricks Credential",
    "description": "Updated Databricks data export connector credential"
  },
  "parameters": {
    "databricks": {
      "workspaceUrl": "https://example.cloud.databricks.com",
      "catalog": "updated_example_catalog",
      "schema": "updated_example_schema",
      "clientId": "{client_id}",
      "clientSecret": "********"
    }
  }
}

Validate a data export connector credential

Use this sample request to validate an existing connector credential. Validation confirms that the credentials can authenticate with an external system, that the credentials can perform the actions required to export data, and that the network connection works.

Copy
cURL sample request: Validate a data export connector credential using a credential ID
curl -X POST --url "https://{vanity_name}.api.visier.io/v1alpha/data/export-connectors/connectors/credentials/validations" \
-H "apikey: {api_key}" \
-H "Cookie: VisierASIDToken={security_token}" \
-H "Content-Type: application/json" \
-d '{
    "id": "61054d4c-df70-460c-b294-2330353b2699"
}'

Use this sample request to validate a new connector credential. The credential values are not persisted.

Copy
cURL sample request: Validate a data export connector credential using new credentials
curl -X POST --url "https://{vanity_name}.api.visier.io/v1alpha/data/export-connectors/connectors/credentials/validations" \
-H "apikey: {api_key}" \
-H "Cookie: VisierASIDToken={security_token}" \
-H "Content-Type: application/json" \
-d '{
    "parameters": {
        "databricks": {
            "workspaceUrl": "https://example.cloud.databricks.com",
            "catalog": "example_catalog",
            "schema": "example_schema",
            "clientId": "{client_id}",
            "clientSecret": "{client_secret}"
        }
    }
}'

The response returns the validation ID. Use the ID to retrieve the validation results.

Copy 
{
  "id": "bb2ddfc2-411b-4cf6-94b1-2faaf06e4e83"
}

Retrieve a data export connector credential's validation result

Use this sample request to retrieve the result for a particular credential validation.

Copy
cURL sample request: Retrieve a data export connector credential's validation result
curl -X GET --url "https://{vanity_name}.api.visier.io/v1alpha/data/export-connectors/connectors/credentials/validations/bb2ddfc2-411b-4cf6-94b1-2faaf06e4e83" \
-H "apikey: {api_key}" \
-H "Cookie: VisierASIDToken={security_token}"

The response returns an empty response if validation is still in progress and whether validation was successful when finished.

Copy 
{
    "success": true,
    "errors": []
}

Delete a data export connector credential

Use this sample request to delete a credential.

Copy
cURL sample request: Delete a data export connector credential
curl -X DELETE --url "https://{vanity_name}.api.visier.io/v1alpha/data/export-connectors/connectors/credentials/61054d4c-df70-460c-b294-2330353b2699" \
-H "apikey: {api_key}" \
-H "Cookie: VisierASIDToken={security_token}"

The response returns an empty object.

Copy 
{}

Run a data export connector job

Use this sample request to run a job for a particular data export connector.

Copy
cURL sample request: Run a data export connector job
curl -X POST --url "https://{vanity_name}.api.visier.io/v1alpha/data/export-connectors/connectors/16222f34-0507-4d63-8f18-e36c39d91f30/jobs" \
-H "apikey: {api_key}" \
-H "Cookie: VisierASIDToken={security_token}"

The response returns the job ID.

Copy 
{
  "jobId": "910f6499-c554-47e0-99c3-28a9803f1c94"
}