Chapter 7. Common Features
7.1. Element Property Icons
Note
Throughout this guide, the elements of each resource are detailed in tables. These tables include a properties column, displaying icons depicting element properties. The meaning of these icons is shown in Table 7.1, “Element property icons”.
Property | Description | Icon |
---|---|---|
Required for creation | These elements must be included in the client-provided representation of a resource on creation, but are not mandatory for an update of a resource. | |
Non-updatable | These elements cannot have their value changed when updating a resource. Include these elements in a client-provided representation on update only if their values are not altered by the API user. If altered, the API reports an error. | |
Read-only | These elements are read-only. Values for read-only elements are not created or modified. |