entityRef

entityRef
entityRef

Represents a reference to an entity defined somewhere in the suite.

JSON Example
{
    "classId": "string",
    "componentId": "string",
    "id": "string",
    "label": "string"
}
string
classId
Optional

The identifier of the type or category to which the referenced entity belongs.

string
componentId
Optional

The durable identifier of a component registered in the suite component registry that owns and manages the referenced entity. This can be omitted if this component can be derived from the context within which this entity reference occurs. It must be specified, if no such context exists or if the component differs from that defined by the context.

string
id
Optional

The unique identifier of the referenced entity, encoded as a string

string
label
Optional

label