Metadata

Configuration and execution of metadata synchronization.

Synchronize metadata for a Database asset

post

Triggers the database synchronization job for a list of schema connections.

This API executes the metadata synchronization as an asynchronous job and returns the job ID of the triggered job in the response.

To monitor the status of a job, use the Jobs resource of the REST Core API: GET /jobs/{jobId}.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

databaseIdstring · uuidRequired

The ID of the Database asset.

Body

schemaConnectionIdsstring · uuid[]Optional

The list of the schemas identified by the schema connection ID for which you want to synchronize metadata. If left empty all schemas with rules defined are synchronized.

Responses

202

The database metadata 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

404

Resource not found.

application/json

409

Conflict.

application/json

post/databases/{databaseId}/synchronizeMetadata

POST /rest/catalogDatabase/v1/databases/{databaseId}/synchronizeMetadata HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "schemaConnectionIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "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."
}

List schema metadata synchronization configurations

get

Returns the schema metadata configurations defined for the given criteria.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

schemaConnectionIdstring · uuidOptional

The ID of the schema connection.

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

The schema metadata configuration defined for the given criteria.

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/schemaMetadataConfigurations

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

{
  "results": [
    {
      "schemaConnectionId": "123e4567-e89b-12d3-a456-426614174000",
      "synchronizationRules": [
        {
          "include": "customers_*",
          "exclude": "customers_very_big_one_causing_troubles, customers_another_one_I_dont_want_to_ingest",
          "targetDomainId": "123e4567-e89b-12d3-a456-426614174000",
          "skipViews": true,
          "registerSourceTags": true
        }
      ]
    }
  ]
}

Add a schema metadata synchronization configuration

post

Creates a schema metadata configuration.

Only a single configuration can be created for a single schema connection id.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

schemaConnectionIdstring · uuidRequired

Responses

201

The schema metadata configuration has been created succesfully. The created configuration is included in the response.

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

404

Resource not found.

application/json

post/schemaMetadataConfigurations

POST /rest/catalogDatabase/v1/schemaMetadataConfigurations HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 308

{
  "schemaConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "synchronizationRules": [
    {
      "include": "customers_*",
      "exclude": "customers_very_big_one_causing_troubles, customers_another_one_I_dont_want_to_ingest",
      "targetDomainId": "123e4567-e89b-12d3-a456-426614174000",
      "skipViews": true,
      "registerSourceTags": true
    }
  ]
}

{
  "schemaConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "synchronizationRules": [
    {
      "include": "customers_*",
      "exclude": "customers_very_big_one_causing_troubles, customers_another_one_I_dont_want_to_ingest",
      "targetDomainId": "123e4567-e89b-12d3-a456-426614174000",
      "skipViews": true,
      "registerSourceTags": true
    }
  ]
}

Add multiple schema metadata synchronization configurations

post

Adds multiple schema metadata synchronization configurations.

This operation is executed in a single transaction, that creates all the configurations. In case the operation fails, none of the configurations are created.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Bodyobject · SchemaMetadataConfiguration[]

schemaConnectionIdstring · uuidRequired

Responses

201

The schema metadata configurations have been created succesfully. The created schema metadata configurations are included in the response.

application/json

schemaConnectionIdstring · uuidRequired

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

post/schemaMetadataConfigurations/batch

POST /rest/catalogDatabase/v1/schemaMetadataConfigurations/batch HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 310

[
  {
    "schemaConnectionId": "123e4567-e89b-12d3-a456-426614174000",
    "synchronizationRules": [
      {
        "include": "customers_*",
        "exclude": "customers_very_big_one_causing_troubles, customers_another_one_I_dont_want_to_ingest",
        "targetDomainId": "123e4567-e89b-12d3-a456-426614174000",
        "skipViews": true,
        "registerSourceTags": true
      }
    ]
  }
]

[
  {
    "schemaConnectionId": "123e4567-e89b-12d3-a456-426614174000",
    "synchronizationRules": [
      {
        "include": "customers_*",
        "exclude": "customers_very_big_one_causing_troubles, customers_another_one_I_dont_want_to_ingest",
        "targetDomainId": "123e4567-e89b-12d3-a456-426614174000",
        "skipViews": true,
        "registerSourceTags": true
      }
    ]
  }
]

Retrieve a schema metadata synchronization configuration

get

Returns the schema metadata configuration defined for the given criteria.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

schemaConnectionIdstring · uuidRequired

The ID of the schema connection.

Responses

200

The schema metadata configuration defined for the given database and optionally schema.

application/json

schemaConnectionIdstring · uuidRequired

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/schemaMetadataConfigurations/{schemaConnectionId}

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

{
  "schemaConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "synchronizationRules": [
    {
      "include": "customers_*",
      "exclude": "customers_very_big_one_causing_troubles, customers_another_one_I_dont_want_to_ingest",
      "targetDomainId": "123e4567-e89b-12d3-a456-426614174000",
      "skipViews": true,
      "registerSourceTags": true
    }
  ]
}

Update schema metadata synchronization configuration

put

Updates a schema metadata synchronization configuration.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

schemaConnectionIdstring · uuidRequired

The ID of the schema connection.

Body

schemaConnectionIdstring · uuidRequired

Responses

200

The schema metadata configuration was updated succesfully.

application/json

schemaConnectionIdstring · uuidRequired

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

put/schemaMetadataConfigurations/{schemaConnectionId}

PUT /rest/catalogDatabase/v1/schemaMetadataConfigurations/{schemaConnectionId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 308

{
  "schemaConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "synchronizationRules": [
    {
      "include": "customers_*",
      "exclude": "customers_very_big_one_causing_troubles, customers_another_one_I_dont_want_to_ingest",
      "targetDomainId": "123e4567-e89b-12d3-a456-426614174000",
      "skipViews": true,
      "registerSourceTags": true
    }
  ]
}

{
  "schemaConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "synchronizationRules": [
    {
      "include": "customers_*",
      "exclude": "customers_very_big_one_causing_troubles, customers_another_one_I_dont_want_to_ingest",
      "targetDomainId": "123e4567-e89b-12d3-a456-426614174000",
      "skipViews": true,
      "registerSourceTags": true
    }
  ]
}

Delete schema metadata synchronization configuration

delete

Deletes a given schema metadata synchronization configuration.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

schemaConnectionIdstring · uuidRequired

The ID of the schema connection.

Responses

204

The schema metadata configuration was succesfully deleted.

No content

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

delete/schemaMetadataConfigurations/{schemaConnectionId}

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

No content

PreviousDatabase NextProfiling

Last updated 22 days ago

Was this helpful?