Get field metadata

Your application can retrieve a list of all fields for topics, topic templates, work teams, or actions by using the getFieldMetadata task.

This task 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.

The fieldContext path values must be one of these: topics, topicTemplates, workteams, or actions.

This task returns the FieldMetadata value object with a list of field properties. The TopicServiceContext returns the total number of fields in the totalRows attribute.

FieldMetadata JSON

{
    "topicsServiceContext": {
	TopicServiceContext object
    },
    "fields": [
        {
            Field object
        }
     ]
}

Field value object

The Field value object describes a single field, which 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.

The field types are as follows.

STRING, DATE, INTEGER, LONG, PROJECT, STATE, ACTION_TYPE

Field JSON

        {
            "id": "string",
            "label": "string",
            "type": "string",
            "filterable": “boolean”,
            "required": “boolean”
        }