Get field metadata
Your application can retrieve a list of all fields for topics, topic
templates, or work teams by calling the getFieldMetadata
method.
This method can be used to browse topics and choose a topic based on
additional information, such as the assigned user, state, or any field, or to browse
topic templates or work teams. Set the fieldContext
argument to one
of the enumeration values of FieldContext: TOPICS, TOPIC_ TEMPLATES, or WORKTEAMS. This
returns the FieldMetadata
value object with a list of field
properties.
FieldMetadata getFieldMetadata(TopicsServiceContext topicsServiceContext,
FieldContext fieldContext)
throws InvalidArgumentException, TopicsServiceException;
The FieldContext
input parameter is an enumeration for
topics, topic templates, or work team values.
enum FieldContext {
TOPICS, TOPIC_TEMPLATES, WORKTEAMS;
}
To retrieve a list of all fields for topics, topic templates, or work teams:
- FieldMetadata value object
TheFieldMetadata
value object has a list of metadata of all fields in each topic, topic template, or work team. The metadata includes the field identifier, display label, type, whether the field is required, and whether the field can be presented to the user as a filter.
Parent topic: Methods