Console
    Contact Us Start free

    RuntimeEntitySchema

    Schema of a runtime entity.

    JSON representation 
     { 
 "entity" 
 : 
 string 
 , 
 "fields" 
 : 
 [ 
 { 
 object (  Field 
 
) 
 } 
 ] 
 , 
 "jsonSchema" 
 : 
 { 
 object (  JsonSchema 
 
) 
 } 
 , 
 "operations" 
 : 
 [ 
 enum (  Operation 
 
) 
 ] 
 }
    Fields
    entity

    string

    Output only. Name of the entity.
    fields[]

    object ( Field )

    Output only. List of fields in the entity.
    jsonSchema

    object ( JsonSchema )

    Output only. JsonSchema representation of this entity's metadata
    operations[]

    enum ( Operation )

    List of operations supported by this entity

    Field

    Metadata of an entity field.

    JSON representation 
     { 
 "field" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "dataType" 
 : 
 enum (  DataType 
 
) 
 , 
 "key" 
 : 
 boolean 
 , 
 "readonly" 
 : 
 boolean 
 , 
 "nullable" 
 : 
 boolean 
 , 
 "defaultValue" 
 : 
 value 
 , 
 "additionalDetails" 
 : 
 { 
 object 
 } 
 , 
 "jsonSchema" 
 : 
 { 
 object (  JsonSchema 
 
) 
 } 
 }
    Fields
    field

    string

    Name of the Field.
    description

    string

    A brief description of the Field.
    dataType

    enum ( DataType )

    The data type of the Field.
    key

    boolean

    The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.
    readonly

    boolean

    Specifies if the Field is readonly.
    nullable

    boolean

    Specifies whether a null value is allowed.
    defaultValue

    value ( Value format)

    The following field specifies the default value of the Field provided by the external system if a value is not provided.
    additionalDetails

    object ( Struct format)

    The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
    jsonSchema

    object ( JsonSchema )

    JsonSchema representation of this entity's schema

    Operation

    Operation values

    Enums
    OPERATION_UNSPECIFIED Operation unspecified.
    LIST This operation means entity type supports LIST entities.
    GET This operation means entity type supports GET entity.
    CREATE This operation means entity type supports CREATE entity.
    UPDATE This operation means entity type supports UPDATE entity.
    DELETE This operation means entity type supports DELETE entity.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: