Sign in
latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

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

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