Activities1

Aggregated Data1

Application1

apply-console-export1

Assessments2

Asset Types1

Assets1

Assignments1

Attachments1

Attribute Types1

Attributes1

Authentication (Sessions)1

backup1

backup-schedule1

Classification Data Category1

Classification Data Migration Process1

Classification Process1

Classification Rule1

Client Management1

Client Registration1

Comments1

Communities1

Complex Relation Types1

Complex Relations1

Connections1

console-configuration1

console-export1

console-export-schedule1

console-saml1

Custom Maskings1

Data Class1

Data Class Group1

Data Classification1

Data contract1

Data Egress1

Data Quality Rules1

Data Sources1

Database1

Database Connection1

Derived Relation Types1

dgc-configuration1

dgc-license1

dgc-logger1

dgc-saml1

Diagram Pictures1

Domain Types1

Domains1

DQ Alert API1

DQ Auth API1

DQ Dataset Definitions API1

DQ Job API1

DQ Report API1

DQ Rule API1

DriverArtifacts1

EdgeArtifacts1

environment1

Files1

GENERIC1

Groups1

Import1

Import Results1

Issues1

JDBC Driver1

JDBC Schema Ingestion1

Job Runs1

Jobs2

JobServer Instance configuration1

jobserver-configuration1

jvm1

License1

managed-services1

Mappings1

Metadata1

post/databases/{databaseId}/synchronizeMetadataSynchronize metadata for a Database asset

Navigation Statistics1

node1

node-configuration1

OAuth 2 Authorization1

OOTB Data Class1

OUTBOUND1

Output Module1

Popularity1

Prescriptive Paths1

Profiling2

Ratings1

Relation Types1

Relations1

Reporting1

Responsibilities1

restore1

Roles1

S31

SAML1

Samples1

Schema Connection1

Scopes1

Search1

service-provider1

Settings1

Sites1

Statuses1

support1

Synchronizations1

Tags1

Technical Lineage1

Templates1

TraitAssignments1

Traits1

user1

User Groups1

Users1

Validation1

Vaults1

View Permissions1

Workflow Definitions1

Workflow Instances1

Workflow Tasks1

Metadata

Synchronize metadata for a Database asset

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

post/databases/{databaseId}/synchronizeMetadata

Request

Base URL
/rest/2.0 (relative, and the document’s source URL is not known)
Auth
- HTTP basic
- or HTTP bearer
- or OAuth 2
  Client credentials
  Token URL/rest/oauth/v2/token
  Scopessys.admin
- or OAuth 2
  Client credentials
  Token URL/rest/oauth/v2/token
TypeScript
https://skmtc.dev/collibra/apis/collibra-data-governance-center-core-api/docs/databases/:databaseId/synchronizeMetadata/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

databaseIdstring uuid required

The ID of the Database asset.

Request body

schemaConnectionIdsstring[]

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.

Response

The database metadata synchronization job has started.

idstring uuid required

createdBystring uuid required

createdOnstring date-time required

startDatestring date-time required

endDatestring date-time

status'Waiting' | 'Running' | 'Completed' | 'Failed' required

reportobject

Changes

No recorded changes to this operation across all 1 revision of this API.