v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1341173209.0 KB
projects

Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.

get/v1/{+conversionWorkspace}:describeDatabaseEntities

Path parameters

conversionWorkspacestring required

Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

Query parameters

commitIdstring

Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.

filterstring

Optional. Filter the returned entities based on AIP-160 standard.

pageSizeinteger

Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.

pageTokenstring

Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.

tree'DB_TREE_TYPE_UNSPECIFIED' | 'SOURCE_TREE' | 'DRAFT_TREE' | 'DESTINATION_TREE'

Required. The tree to fetch.

uncommittedboolean

Optional. Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.

view'DATABASE_ENTITY_VIEW_UNSPECIFIED' | 'DATABASE_ENTITY_VIEW_BASIC' | 'DATABASE_ENTITY_VIEW_FULL' | 'DATABASE_ENTITY_VIEW_ROOT_SUMMARY' | 'DATABASE_ENTITY_VIEW_FULL_COMPACT'

Optional. Results view based on AIP-157

Response

Successful response