6d091bc86a33
Find Database assets
Finds Databases based on the provided criteria.
The response can include Databases whose underlying connection has been soft-deleted in Collibra or removed from the data source. These are flagged with edgeConnectionStatus = DELETED in the response.
Use the edgeConnectionStatus query parameter to filter them out (ACTIVE) or to retrieve only the deleted ones (DELETED).
Query parameters
The ID of the parent System asset.
The ID of the Edge connection.
The ID of the database connection
Status of the connection used by a Database.
Known values (additional values may be introduced in future API versions; clients should treat unknown values as opaque strings):
- ACTIVE: the database connection and its parent Edge connection are both available.
- DELETED: the database connection or its parent Edge connection has been soft-deleted in Collibra or removed from the data source.
Filter Databases by the status of their underlying connection.
Only ACTIVE and DELETED are accepted (case-insensitive). Any other value results in a 400 Bad Request.
- ACTIVE: returns only Databases whose database connection and parent Edge connection are still active.
- DELETED: returns only Databases whose database connection or parent Edge connection has been soft-deleted in Collibra or removed from the data source.
If not provided, Databases are returned regardless of their connection status.
The index of the first result to retrieve.
If not set (offset = 0), results will be retrieved starting from row 0.
This is the maximum number of results that may be returned. Fewer may be returned than the value of <code>limit</code>.
Do not depend on the number of results being fewer than the <code>limit</code> value to indicate that your query reached the end of the list of data, use the absence of <code>after</code> (see Cursors) instead. For example, if you set <code>limit</code> to 10 and 9 results are returned, there may be more data available.
If not set, the default limit (limit = <code>25</code>) will be used. The maximum value for this parameter is <code>500</code>.
Response
Databases successfully retrieved.