This web service returns updates a vocabulary's configuration.
| Method | Endpoint |
|---|---|
PUT |
|
| Path parameter | Type | Description |
|---|---|---|
{vocabularyId} |
String | The unique identifier of the vocabulary to be updated. |
It is necessary to provide an Ft-Calling-App value when using Fluid Topics web services. See Fluid Topics calling app.
Request example
{
"id": "new_vocabulary_id",
"usedInSearch": false,
"description": "A new description for my vocabulary",
"locales": [
"en-US",
"fr-FR"
],
"mimeType": "application/rdf+xml",
"mode": "FULL"
}
| Field | Type | Required? | Description |
|---|---|---|---|
id |
String | No | A new unique identifier for the vocabulary. |
usedInSearch |
Boolean | No | Defines whether the search engines uses the vocabulary when indexing content. |
description |
String | No | Deprecated. A new description for the vocabulary. |
locales |
Array | No | New or additional languages in which the vocabulary is available. Use "*" for a universal vocabulary. |
mimeType |
String | No | A new format of the file containing the terms of the vocabulary. |
mode |
String | No | Deprecated. The mode of the vocabulary as it appears in the Back Office. Possible values are FULL for taxonomies and LIST for synonyms. |
The value for the id field cannot contain spaces nor / or + characters.
| Return code | Description |
|---|---|
200 OK |
The request is valid and the vocabulary was updated. |
400 BAD REQUEST |
The request is invalid. |
401 UNAUTHORIZED |
The authorization header was not provided or is invalid. |
403 FORBIDDEN |
The user not have the ADMIN or KHUB_ADMIN role. |
404 NOT FOUND |
The vocabulary does not exist. |
For a list of all possible return codes, see Return codes.