Schema Connection

Management of schema connections.

List schema connections

get

Returns a list of available schema connections, which can be used to define metadata synchronization configurations for schemas. The response includes connections with deleted schemas in both Collibra and the data source. Non-synchronized or Deleted schema connections can be identified by the absence of the schemaId parameter in the response.

This API only returns the connections that have already been synchronized with the catalog. If a specific schema connection is missing, you can call the /schemaConnections/refresh API to synchronize the schema connections available in Catalog with the data source.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

databaseConnectionIdstring · uuidOptional

The ID of the database connection.

schemaIdstring · uuidOptional

The ID of the Schema asset.

offsetinteger · int32Optional

The index of the first result to retrieve.

If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32 · max: 500Optional

The maximum number of results to retrieve.

If not set, the default limit (limit = 0) will be used. The maximum value for this parameter is 500.

Default: 0

Responses

200

Schema connections successfully retrieved.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

get/schemaConnections

HTTPcURLJavaScriptPython

GET /rest/catalogDatabase/v1/schemaConnections HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "customer_schema",
      "databaseConnectionId": "123e4567-e89b-12d3-a456-426614174000",
      "schemaId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Retrieve a schema connection

get

Returns a specific schema connection, even if it has been deleted in Collibra or the data source. Non-synchronized or Deleted schema connections can be identified by the absence of the schemaId parameter in the response.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

schemaConnectionIdstring · uuidRequired

The ID of the schema connection.

Responses

200

Represents a schema connection.

application/json

The connection reference to the specific schema.

idstring · uuidOptional

The ID of the schema connection.

namestringOptional

The exact name of a schema read from the source.

Example: customer_schema

databaseConnectionIdstring · uuidOptional

The ID of the database connection.

schemaIdstring · uuidOptional

The ID of the Schema asset linked with this schema connection.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

get/schemaConnections/{schemaConnectionId}

HTTPcURLJavaScriptPython

GET /rest/catalogDatabase/v1/schemaConnections/{schemaConnectionId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "customer_schema",
  "databaseConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "schemaId": "123e4567-e89b-12d3-a456-426614174000"
}

Refresh schema connections from the data source

post

Refresh the schema connections for a given database connection.

This is an asynchronous API since it needs to reach out to the data source via Edge to retrieve the list of available schema connections , which can take some time.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

databaseConnectionIdstring · uuidRequired

The ID of the database connection.

Responses

202

The schema connections synchronization job has started.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

post/schemaConnections/refresh

HTTPcURLJavaScriptPython

POST /rest/catalogDatabase/v1/schemaConnections/refresh?databaseConnectionId=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "resourceType": "View",
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "progressPercentage": 50,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "message": "Import finished in 12s."
}