Get entity definition
get_entity_definitionRead-only
Returns the field definitions of one entity type: field, searchField, name, fieldType, editable, isReference, dataSourceEntityType, isMandatory and values. Always call it before search_entity, create_entity or update_entity on an entity type you have not used yet. Read get_documentation('entity_model') for what each attribute means.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entityType | Yes | Which entity type to describe. | |
| operationType | No | Which operation the field definitions should reflect for the Editable flag - e.g. pass Create before calling create_entity, or Update before calling update_entity. Defaults to Read. | Read |