Class CustomAttributeConfigResourceAttributes

Attributes of a custom attribute configuration, defining an organization-specific metadata field that can be added to cases of a given type.

Hierarchy

  • CustomAttributeConfigResourceAttributes

Constructors

constructor

Properties

additionalProperties? caseTypeId description? displayName isMulti key type

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

caseTypeId

caseTypeId: string

The UUID of the case type this custom attribute belongs to.

Optional description

description?: string

A description explaining the purpose and expected values for this custom attribute.

displayName

displayName: string

The human-readable label shown in the Case Management UI for this custom attribute.

isMulti

isMulti: boolean

If true, this attribute accepts an array of values. If false, only a single value is allowed.

key

key: string

The programmatic key used to reference this custom attribute in search queries and API calls.

type

type: CustomAttributeType

The data type of the custom attribute, which determines the allowed values and UI input control.

Settings

Member Visibility

Theme

Generated using TypeDoc