Partial update thesaurus

patch

/gsadmin/v1/{appName}/thesaurus

Partial updates one or more thesaurus entries in the specified application.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json

Path Parameters

appName

Type: string

Required: true

Specifies the name of your application, for example, Discover.

Body Parameter

The request body represents the partially updated thesaurus.

Root Schema : Thesaurus

Type: object

Represents the thesaurus in the ECR. Child nodes should represent thesaurus entries that conform to ThesaurusEntry JSON schema.

Properties

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Default Value: thesaurus

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json

202 Response

Thesaurus successfully updated.

Body

Root Schema : Response

Type: object

Properties

message

Type: string

status

Type: integer (int32)

Examples

A PATCH endpoint cannot access an object through its parent object. Thus, you cannot use this endpoint to modify the thesaurus entries contained in the thesaurus. The following request generates an error:

PATCH /gsadmin/v1/cloud/thesaurus

Request Body

{
 "ecr:type" : "thesaurus", 
 "auto_generated_id":
  {
  	"ecr:type" : "thesaurus-entry",
 	"synonyms": [  "jersey"  ] 
 	}
}