Magidoc

Resource
Object

Definition of an API resource.

Fields

#

_id

ID !
Non-null

Unique identifier of a resource definition.

_kind

ID !
Non-null

Record type, always Resource .

client

Non-null

Application declaring API resource

code

Non-null

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 .

name

Displayable name of an API resource

operations

Non-null

Available API operations on a resource

Interfaces

#

Also implements APIResource .

Usages

#

References

#