POST /ariel/taggedfieldcategories
Creates a new category for tagged fields. To use this endpoint, you must have System Administrator or Security Admin permissions.
Creates a new category for tagged fields. To use this endpoint, you must have System Administrator or Security Admin permissions.
MIME Type |
---|
application/json |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
body |
Object |
application/json |
The structure of the category. Only the name field can be set when creating a category. All other fields are ignored.
|
{ "creation_date": 42, "modified_date": 42, "name": "String", "uuid": "String" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
201 |
The category was created. |
|
409 |
8000 |
A category already exists with the specified name. |
422 |
8001 |
You must specify the name parameter. |
422 |
8002 |
The specified name must be between 1 and 255 (inclusive) characters. |
500 |
1028 |
An error occurred while creating the category. |
Response Description
201 response with the new category structure. Location header set to the URL of the new category ID.
- 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"
}