Developer
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Classes
Enumerations
Interfaces
TypeAliases

CompassCustomFieldDefinition

Defines a custom field that may be applied to multiple component types. A custom field must be applied to at least one component type.

Property NameTypeDescription
componentTypeIdsMaybe<Array<String>>The component types the custom field applies to.
componentTypesMaybe<Array<CompassComponentType>>The component types the custom field applies to.
descriptionMaybe<String>The description of the custom field.
idStringThe ID of the custom field definition.
nameMaybe<String>The name of the custom field.

Rate this page: