Partial update thesaurus entry
patch
/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Partial updates thesaurus entry in the specified application.
Request
Supported Media Types
- application/json
Path Parameters
- appName
-
Type:
stringRequired:trueSpecifies the name of your application, for example, Discover.- thesaurusEntryId
Type:stringRequired:trueSpecifies the id of the thesaurus entry.
Body Parameter
The request body represents the partially updated thesaurus entry.
Root Schema : ThesaurusEntry
Type:
objectRepresents the thesaurus entry in the ECR.
- ecr:createDate
-
Type:
string - ecr:lastModified
-
Type:
string - ecr:lastModifiedBy
-
Type:
string - ecr:type
-
Type:
stringDefault Value:thesaurus-entry - searchTerms
-
Type:
string - synonyms
-
Type:
arraysynonymsAdditional Properties Allowed: - type
-
Type:
string
Nested Schema : synonyms
Type:
array-
Type:
string
Security
- basicAuth
-
Type:
basicDescription:Basic username/password authentication.
Response
Supported Media Types
- application/json
202 Response
Thesaurus entry successfully updated.
Body
Root Schema : Response
Type:
object- message
-
Type:
string - status
-
Type:
integer(int32)
Examples
Request Body Example
The following example shows how to modify the value of existing thesaurus entries. In this example, the synonym is changed from blouse to jersey.
{
"ecr:type" : "thesaurus-entry",
"synonyms": [ "jersey" ]
}