- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- RuntimeEntitySchema
- Field
- Try it!
List schema of a runtime entities filtered by entity name.
HTTP request
GET https://connectors.googleapis.com/v1/{parent=projects/*/locations/*/connections/*}/runtimeEntitySchemas
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. Parent resource of RuntimeEntitySchema Format: projects/{project}/locations/{location}/connections/{connection} Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
Page size. |
pageToken |
Page token. |
filter |
Required. Filter Format: entity="{entityId}" Only entity field is supported with literal equality operator. Accepted filter example: entity="Order" Wildcards are not supported in the filter currently. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for ConnectorsService.ListRuntimeEntitySchemas.
JSON representation | |
---|---|
{
"runtimeEntitySchemas": [
{
object ( |
Fields | |
---|---|
runtimeEntitySchemas[] |
Runtime entity schemas. |
nextPageToken |
Next page token. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
RuntimeEntitySchema
Schema of a runtime entity.
JSON representation | |
---|---|
{
"entity": string,
"fields": [
{
object ( |
Fields | |
---|---|
entity |
Output only. Name of the entity. |
fields[] |
Output only. List of fields in the entity. |
Field
Metadata of an entity field.
JSON representation | |
---|---|
{
"field": string,
"description": string,
"dataType": enum ( |
Fields | |
---|---|
field |
Name of the Field. |
description |
A brief description of the Field. |
dataType |
The data type of the Field. |
key |
The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity. |
readonly |
Specifies if the Field is readonly. |
nullable |
Specifies whether a null value is allowed. |
defaultValue |
The following field specifies the default value of the Field provided by the external system if a value is not provided. |
additionalDetails |
The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields. |