Magidoc

ResourceRequest
Input Object

A request to create or update an API resource definition. For an update operation, not specifying a field in the request means that it's value will not be updated.

Fields

#

_id

ID

Unique identifier of a resource. Used to refer to a resource for update or delete.

_kind

ID !
Non-null

Record type, always Resource .

code

String

Unique code of a resource definition. Format: urn:{vendor}/{component}:{namespace}/{name} , e.g. urn:cx/meetings:data/events or urn:cx/tenants:data/oAuth2Clients/fields/credentials/clientSecret . This value cannot be changed after resource is created, i.e. specifying a code means that either a resource is being referenced by it for update/delete instead of _id or a new resource has to be created.

name

String

Displayable name of an API resource.

operations

[ ResourceOperationRequest ]

Available API operations on a resource. For update operation this list has replaceMerge semantics, i.e. existing operations omitted from the list will be deleted. See PatchStrategy#replaceMerge .