Jump to

• Request
• Response
• Examples

Partial update thesaurus

patch

/gsadmin/v1/{appName}/thesaurus

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

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".

Body ()

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.

Show Source

• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: thesaurus

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"thesaurus"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents the thesaurus in the ECR. Child nodes should represent thesaurus entries that conform to ThesaurusEntry JSON schema."
}

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Thesaurus successfully updated.

Body ()

Root Schema : Response

Type: object

Show Source

• message(optional): string
• status(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Back to Top

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"  ] 
 	}
}

Back to Top