Describe Entity
GET …/wms/lgfapi/v10/entity/{entity_name}/describe/
The describe operation is unique in that it is common and can be used on any entity. It returns a formatted representation of the entity’s metadata including any filterable “parameters” and all field definitions. This is the primary tool for obtaining details about a specific entity.
Response Components
- parameters – A list of fields that can be used for filtering of the entity.
- fields – Field definitions and metadata for the entity.
- type – The field data type
- allow_blank – String fields only. Is an empty string value permitted?
- max_length – String fields only. Max string length permitted.
- required – Does the field require data.Note: Note about Required fields - X or Y indicates the field is required. N indicates the field is not required. C indicates that the field is conditional.
- default – If the fields is not required, the default value when no value is provided.