Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /ariel/taggedfieldcategories

SUMMARY Gets the list of categories for tagged fields.

Gets the list of categories for tagged fields.

Table 1: GET /ariel/taggedfieldcategories resource details:

GET /ariel/taggedfieldcategories resource details
MIME Type

application/json

Table 2: GET /ariel/taggedfieldcategories request parameter details:

GET /ariel/taggedfieldcategories request parameter details
Parameter Type Optionality Data Type MIME Type Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

sort

query

Optional

String

text/plain

Optional - This parameter is used to sort the elements in a list.
Table 3: GET /ariel/taggedfieldcategories response codes:

GET /ariel/taggedfieldcategories response codes
HTTP Response Code Unique Code Description

200

An array of categories.

422

1005

A field request parameter is not valid.

422

1010

Invalid filter criteria supplied.

422

1015

The sort field or order is not valid.

500

1025

An error occurred while retrieving the categories.

Response Description

An array of categories. A category object contains the following fields:
  • id - Long - The ID of the category for tagged fields.
  • name - String - The name of the category for tagged fields.
  • uuid - String - The ID of the category for tagged fields, represented as a UUID.
  • modified_date - Long - The time stamp that the category was last modified, specified in milliseconds since epoch.
  • creation_date - Long - The time stamp that the category was created, specified in milliseconds since epoch.

Response Sample