Get field readability for a collection
GET /collections/{id}/field-composition
Lists every collection field that isn’t archived, with its id, its
code and whether you may read its values. It returns no values; use
it with GET /collections/{id}/fields to tell a value you may not
see from one that was never set.
A field without a read_capability is readable by any signed-in
user; otherwise you need that capability granted globally.
Collections have no team, so a capability granted for a team doesn’t
count here. The collection isn’t looked up, so every id, including
one that matches no collection, gets the same answer. Entries are
sorted by code, and they say nothing about whether you may edit a
value.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The collection’s id.
Responses
Section titled “ Responses ”One entry per collection field that isn’t archived, sorted by code. No values are included.
Whether you may read one field’s values on the asset or collection you asked about. It never carries a value.
object
The field definition’s id.
The field’s code, which display_condition terms use to name it.
true if you may read this field’s values here: the field has no
read_capability, or you hold it globally, or, on an asset with a
team, you hold it for that team. When it is false, a form can’t
evaluate display conditions that depend on this field.
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Resource not found
object
Human-readable error summary
Example
the request could not be completed