GET /ariel/taggedfieldcategories/{id}
Gets a category for tagged fields.
Gets a category for tagged fields.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
id |
path |
Required |
Number (Integer) |
text/plain |
The ID of the category that you want to get. |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The category with the specified ID. |
|
404 |
6000 |
The specified category ID does not exist. |
422 |
1005 |
A field request parameter is not valid. |
500 |
1026 |
An error occurred while retrieving the category. |
Response Description
The category with the specified ID. 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
{
"creation_date": 42,
"id": 42,
"modified_date": 42,
"name": "String",
"uuid": "String"
}