openapi: 3.2.0
info:
title: Visier Data Out Data Export Connectors API API
description: Visier APIs for getting data out of Visier, such as aggregate data and data version information.
license:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: 22222222.99201.3040
security:
- ApiKeyAuth: []
BearerAuth: []
- ApiKeyAuth: []
CookieAuth: []
- ApiKeyAuth: []
OAuth2Auth: []
tags:
- name: DataExportConnectorsAPI
x-displayName: Data Export Connectors
description: 'Manage data export connectors and credentials, and run data export connector jobs. Data export connectors send Visier data to external systems, such as Databricks or Snowflake. Use these APIs to manage the credentials for authenticating with destinations, validate that credentials work, list available data export connectors, and dispatch connector jobs.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>'
paths:
/v1alpha/data/export-connectors/connectors:
get:
tags:
- DataExportConnectorsAPI
summary: Retrieve data export connectors
description: "Retrieve a list of data export connectors. Each data export connector defines the Data Exports it runs and the credentials it uses.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: DataExportConnectorsAPI_ListConnectors
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorListResponse'
/v1alpha/data/export-connectors/connectors/{connectorId}/jobs:
post:
tags:
- DataExportConnectorsAPI
summary: Run a data export connector job
description: "Dispatch a job for the specified data export connector. The job runs the connector's exports using the production version. The response returns an `id` that you can use to monitor the job's progress with `GET /v1alpha/data/export-connectors/jobs/{jobId}`.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: DataExportConnectorsAPI_DispatchJob
parameters:
- name: connectorId
in: path
description: The unique identifier of the data export connector to run a job for.
required: true
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorJobDispatched'
/v1alpha/data/export-connectors/credentials:
get:
tags:
- DataExportConnectorsAPI
summary: Retrieve data export connector credentials
description: "Retrieve a list of data export connector credentials. The response returns each credential's identifying fields and authentication parameters. Sensitive fields, such as secrets and private keys, are masked.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: DataExportConnectorsAPI_ListCredentials
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredentialListResponse'
post:
tags:
- DataExportConnectorsAPI
summary: Create a data export connector credential
description: "Create a data export connector credential. Credentials authenticate with external systems, such as Databricks or Snowflake. When creating a credential, do not provide an `id`. Visier generates the credential ID automatically.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: DataExportConnectorsAPI_CreateCredential
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredential'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredential'
/v1alpha/data/export-connectors/credentials/validations:
post:
tags:
- DataExportConnectorsAPI
summary: Validate a data export connector credential
description: "Validate that a data export connector credential can connect to its destination. Validation runs asynchronously. The response returns an `id` that you can use to poll for the validation result with `GET /v1alpha/data/export-connectors/credentials/validations/{id}`.\n\n Specify an `id` to validate an existing credential or `parameters` to validate a new set of credential values without persisting the credentials.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: DataExportConnectorsAPI_CreateCredentialValidation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredentialValidationRequest'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredentialValidationCreated'
/v1alpha/data/export-connectors/credentials/validations/{id}:
get:
tags:
- DataExportConnectorsAPI
summary: Retrieve a data export connector credential's validation result
description: "Retrieve the validation results for a credential. Use the `id` returned by `POST /v1alpha/data/export-connectors/credentials/validations`.\n\n Validation runs asynchronously. Poll this endpoint until the result is available.\n * While validation is still in progress, the response is `200 OK` with a `null` body. Continue polling.\n * After validation completes, the response is `200 OK` with a body indicating whether the validation succeeded and listing any errors.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: DataExportConnectorsAPI_GetCredentialValidation
parameters:
- name: id
in: path
description: The unique identifier of the credential validation request.
required: true
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredentialValidationResponse'
/v1alpha/data/export-connectors/credentials/{id}:
get:
tags:
- DataExportConnectorsAPI
summary: Retrieve a data export connector credential
description: "Retrieve a specific data export connector credential by its unique identifier. Sensitive fields, such as secrets and private keys, are masked.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: DataExportConnectorsAPI_GetCredential
parameters:
- name: id
in: path
description: The unique identifier of the data export connector credential.
required: true
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredential'
put:
tags:
- DataExportConnectorsAPI
summary: Update a data export connector credential
description: "Update an existing data export connector credential. The definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. Provide sensitive fields, such as secrets and private keys, in plain text.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: DataExportConnectorsAPI_UpdateCredential
parameters:
- name: id
in: path
description: The unique identifier of the data export connector credential to update.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredential'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredential'
delete:
tags:
- DataExportConnectorsAPI
summary: Delete a data export connector credential
description: "Delete a data export connector credential.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: DataExportConnectorsAPI_DeleteCredential
parameters:
- name: id
in: path
description: The unique identifier of the data export connector credential.
required: true
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content: {}
/v1alpha/data/export-connectors/jobs/{id}:
get:
tags:
- DataExportConnectorsAPI
summary: Retrieve a data export connector job's status
description: "Retrieve the status of a data export connector job. Use the `id` returned by `POST /v1alpha/data/export-connectors/connectors/{connectorId}/jobs`. The response returns the job's status, any error message, and the statuses of its spawned sync jobs. A sync job sends the data from Visier to the target system, such as Databricks or Snowflake.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice, functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: DataExportConnectorsAPI_GetJobStatus
parameters:
- name: id
in: path
description: The unique identifier of the data export connector job.
required: true
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorJobStatus'
components:
schemas:
servicing.dataexportconnector.BigQueryServiceAccountCredentialParameters:
type: object
properties:
datasetId:
type: string
description: The BigQuery dataset that holds the destination tables.
projectId:
type: string
description: The Google Cloud Project that owns the data and is billed for the export.
privateKeyId:
type: string
description: The unique identifier of the private key.
privateKey:
type: string
description: The private key to authenticate with Google BigQuery. Returned as the string `********`. The actual value is never returned. To update the value, provide the value in plain text.
clientEmail:
type: string
description: The Google BigQuery service account email address.
clientId:
type: string
description: The OAuth client ID to authenticate with Google BigQuery.
servicing.dataexportconnector.DataExportConnectorCredentialValidationRequest:
type: object
properties: {}
oneOf:
- title: DataExportConnectorCredentialValidationRequest with id
required:
- id
properties:
id:
type: string
description: The unique identifier of an existing credential to validate.
- title: DataExportConnectorCredentialValidationRequest with parameters
required:
- parameters
properties:
parameters:
allOf:
- $ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredentialParameters'
description: A new set of credential values to validate without persisting the credentials.
servicing.dataexportconnector.SnowflakeCredentialParameters:
type: object
properties:
accountUrl:
type: string
description: The Snowflake account URL.
database:
type: string
description: The Snowflake database name.
schema:
type: string
description: The Snowflake schema name.
user:
type: string
description: The Snowflake user name.
warehouse:
type: string
description: The Snowflake warehouse name.
privateKey:
type: string
description: The private key to authenticate with Snowflake. Returned as the string `********`. The actual value is never returned. To update the value, provide the value in plain text.
privateKeyPassphrase:
type: string
description: The passphrase that protects the private key if the private key is encrypted. Returned as the string `********`. The actual value is never returned. To update the value, provide the value in plain text.
role:
type: string
description: The Snowflake role to use for the connection.
servicing.SynonymListDTO:
type: object
properties:
synonyms:
type: array
items:
type: string
description: Alternative words or phrases for the object.
description: The object's synonyms.
servicing.dataexportconnector.DataExportConnectorCredentialParameters:
type: object
properties: {}
oneOf:
- title: DataExportConnectorCredentialParameters with Databricks
required:
- databricks
properties:
databricks:
allOf:
- $ref: '#/components/schemas/servicing.dataexportconnector.DatabricksCredentialParameters'
description: Credentials for Databricks.
- title: DataExportConnectorCredentialParameters with Snowflake
required:
- snowflake
properties:
snowflake:
allOf:
- $ref: '#/components/schemas/servicing.dataexportconnector.SnowflakeCredentialParameters'
description: Credentials for Snowflake.
- title: DataExportConnectorCredentialParameters with BigQueryServiceAccount
required:
- bigQueryServiceAccount
properties:
bigQueryServiceAccount:
allOf:
- $ref: '#/components/schemas/servicing.dataexportconnector.BigQueryServiceAccountCredentialParameters'
description: Credentials for Google BigQuery using a service account key.
servicing.dataexportconnector.DataExportConnectorCredentialValidationError:
type: object
properties:
rci:
type: string
description: An optional Visier internal error identifier. Reference this when contacting Visier support to help diagnose the issue.
message:
type: string
description: A description of the validation error.
servicing.dataexportconnector.LinkedDataExport:
type: object
properties:
dataExportId:
type: string
description: The unique identifier of the linked Data Export.
tableName:
type: string
description: The name of the destination table that the Data Export writes to.
servicing.dataexportconnector.DataExportConnectorCredential:
type: object
properties:
id:
type: string
description: "The unique identifier for the credential. This identifier is a UUID generated automatically when the credential is created and cannot be changed.\n Do not provide a value when creating a new credential. When updating a credential, this field is required and must match the `id` path parameter."
basicInformation:
allOf:
- $ref: '#/components/schemas/servicing.BasicInformationDTO'
description: Fields that identify and describe the credential, such as its display name, description, and explanation.
parameters:
allOf:
- $ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredentialParameters'
description: The parameters for the credential. Sensitive fields are masked when retrieved.
servicing.dataexportconnector.DataExportConnectorCredentialValidationResponse:
type: object
properties:
success:
type: boolean
description: If `true`, the validation was successful. If `false`, see `errors` for details.
errors:
type: array
items:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredentialValidationError'
description: The list of errors encountered during validation. Empty if the validation succeeded.
servicing.dataexportconnector.DataExportConnectorCredentialValidationCreated:
type: object
properties:
id:
type: string
description: The unique identifier of the credential validation request. Use this ID to retrieve the validation result.
servicing.dataexportconnector.DataExportConnectorLink:
type: object
properties:
linkedDataExport:
allOf:
- $ref: '#/components/schemas/servicing.dataexportconnector.LinkedDataExport'
description: A Data Export linked to the connector.
servicing.dataexportconnector.DataExportConnector:
type: object
properties:
id:
type: string
description: The unique identifier of the data export connector. This identifier is a UUID generated automatically when the connector is created and cannot be changed.
objectName:
type: string
description: The unique name of the data export connector to identify the connector programmatically. The `objectName` is distinct from the human-readable `displayName`.
basicInformation:
allOf:
- $ref: '#/components/schemas/servicing.BasicInformationDTO'
description: Fields that identify and describe the data export connector, such as its display name, description, and explanation.
links:
type: array
items:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorLink'
description: The list of data exports linked to the connector.
credentialIds:
type: array
items:
type: string
description: The unique identifiers of the credentials that this data export connector uses to authenticate.
servicing.dataexportconnector.DataExportConnectorJobDispatched:
type: object
properties:
id:
type: string
description: The unique identifier of the job.
description: Identifies a dispatched data export connector job.
servicing.dataexportconnector.DatabricksCredentialParameters:
type: object
properties:
workspaceUrl:
type: string
description: The Databricks workspace URL.
catalog:
type: string
description: The Databricks catalog name.
schema:
type: string
description: The Databricks schema name.
clientId:
type: string
description: The OAuth client ID to authenticate with Databricks.
clientSecret:
type: string
description: The OAuth client secret to authenticate with Databricks. Returned as the string `********`. The actual value is never returned. To update the value, provide the value in plain text.
servicing.dataexportconnector.DataExportConnectorJobStatus:
type: object
properties:
id:
type: string
description: The unique identifier of the export job.
status:
type: string
description: The current status of the data export connector job (e.g., Pending, Succeeded, Failed).
errorMessage:
type: string
description: The error message if the job failed. Empty for other job statuses.
syncJobs:
type: array
items:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorSyncJobStatus'
description: The status of each sync job spawned by this data export connector job.
description: The status of a data export connector job and its spawned sync jobs.
servicing.dataexportconnector.DataExportConnectorSyncJobStatus:
type: object
properties:
id:
type: string
description: The unique identifier of the sync job.
status:
type: string
description: The current status of the sync job (e.g., Pending, Succeeded, Failed).
errorMessage:
type: string
description: The error message if the sync job failed. Empty for other job statuses.
description: The status of a sync job.
Status:
type: object
properties:
localizedMessage:
type: string
description: Localized error message describing the root cause of the error.
code:
type: string
description: Error classification.
message:
type: string
description: Not used.
rci:
type: string
description: Optional root cause identifier.
userError:
type: boolean
description: Indicates whether the error is a user error.
description: The response structure for errors.
servicing.dataexportconnector.DataExportConnectorListResponse:
type: object
properties:
connectors:
type: array
items:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnector'
description: The list of data export connectors.
servicing.BasicInformationDTO:
type: object
properties:
displayName:
type: string
description: The user-friendly name for the object.
shortDisplayName:
type: string
description: A shortened version of the display name. If the object is visible in the solution experience, this name is displayed in visualization titles.
description:
type: string
description: A short description of the object. Descriptions provide in-context help for your users while working in Visier.
explanation:
type: string
description: A longer description of the object that typically includes a definition, calculation details, and other guidance about how to use the object.
designerNotes:
type: string
description: An admin-only description of the object that provides design-specific information or considerations.
synonymList:
allOf:
- $ref: '#/components/schemas/servicing.SynonymListDTO'
description: Alternative words or phrases for the object.
description: Fields that identify and describe the object, such as its display name, description, and explanation.
servicing.dataexportconnector.DataExportConnectorCredentialListResponse:
type: object
properties:
credentials:
type: array
items:
$ref: '#/components/schemas/servicing.dataexportconnector.DataExportConnectorCredential'
description: The list of data export connector credentials.
securitySchemes:
CookieAuth:
type: apiKey
name: VisierASIDToken
in: cookie
ApiKeyAuth:
type: apiKey
name: apikey
in: header
BearerAuth:
type: http
scheme: bearer
OAuth2Auth:
type: oauth2
flows:
authorizationCode:
authorizationUrl: /v1/auth/oauth2/authorize
tokenUrl: /v1/auth/oauth2/token
scopes:
read: Grants read access
write: Grants write access
password:
tokenUrl: /v1/auth/oauth2/token
scopes:
read: Grants read access
write: Grants write access
x-tagGroups:
- name: data out
tags:
- DataQuery
- DataVersionExport
- VeeV1
- VeeV2
- Search
- SourceFilesDownload
- Reporting
- DataExportConnectorsAPI