ON THIS PAGE
POST /ariel/taggedfieldcategories/{id}
SUMMARY Updates a category for tagged fields. To use this endpoint, you must have System Administrator or Security Admin permissions.
Updates a category for tagged fields. To use this endpoint, you must have System Administrator or Security Admin permissions.
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 update. |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
body |
Object |
application/json |
The updated structure for the category. Only the name field can be set when updating a category. All other fields are ignored.
|
{ "name": "String" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The category was updated. |
|
404 |
7000 |
The specified ID does not exist. |
409 |
7001 |
A category already exists with the specified name. |
422 |
7002 |
The specified name must be between 1 and 255 (inclusive) characters. |
500 |
1027 |
An error occurred while updating the category. |
Response Description
- 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" }