Create a catalogue
Header Parameters
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Body Parameters
Locale-keyed names, e.g. {"en": "Provisions", "de": "Verpflegung"}. The en value is what ?ordering=name sorts on, whatever language the key's user has.
Show child attributes
Legal entity ids. Must belong to this company.
Show child attributes
Response
Created. The body is the read shape, with relations nested.
Response Attributes
Locale-keyed names, e.g. {"en": "Provisions", "de": "Verpflegung"}. The en value is what ?ordering=name sorts on, whatever language the key's user has.
Show child attributes
Read-only. Together with assignedDepartmentsNotAllowed this decides which people see the catalogue; the flag inverts the gate, so a key must not rewrite it.
Show child attributes
Read-only. true means the departments listed are the ones excluded.
Legal entities the catalogue applies to.
Show child attributes
When the row was created.
When the row itself last changed.
null on a live row; the timestamp of the soft delete otherwise. Read-only everywhere.
Validation failed. attr names the field, in snake_case.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Missing, invalid, or expired API key, or a session credential was used instead of an API key.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError