v1

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

Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.

get/v2/{+parent}/entities

Path parameters

parentstring required

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}

Query parameters

conditionsstring

Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported.

executionConfig.headersstring

headers to be used for the request. For example: headers:'{"x-integration-connectors-managed-connection-id":"conn-id","x-integration-connectors-runtime-config":"runtime-cfg"}'

pageSizeinteger

Number of entity rows to return. Defaults page size = 25. Max page size = 200.

pageTokenstring

Page token value if available from a previous request.

sortBystring[]

List of 'sort_by' columns to use when returning the results.

sortOrderstring[]

List of 'sort_order' columns to use when returning the results.

Response

Successful response