Resource Fields
|
PII |
SI |
Field |
Description |
Format |
|---|---|---|---|---|
|
|
|
id |
The "id" refers to the identifier of a specific entity within the context of the API. It is automatically generated, does not change, and can only be accessed in read mode. It serves as a search filter to locate data based on a list of values. This field is also named “structureId“ when used as path parameter. |
|
|
|
|
code |
Short textual field identifying the entity. |
Max Lenght: 20 |
|
|
|
description |
Text field describing the entity; it's possible to define different descriptions for different languages. |
Max Lenght: 40 Multilanguage field |
|
|
|
active |
Boolean flag to indicate whether the resource is currently active or not |
|
|
|
|
order |
Numeric field that allows defining a custom sorting order for Structure entities |
|
API list