Jump to

• Request
• Response
• Examples

Update thesaurus

put

/gsadmin/v1/{appName}/thesaurus

Updates thesaurus in the specified application.

Request

Supported Media Types

• application/json
• application/zip

Path Parameters

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

Body ()

The request body represents the 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

Request Body Example

The following shows a sample request body to replace the configuration of thesaurus in its entirety. In this example, the configuration of the thesaurus contains two thesaurus-entry objects.

{
 "ecr:type" : "thesaurus",
 "auto_generated_id": 
  {
  "ecr:type" : "thesaurus-entry",
  "type": "one-way",
  "synonyms": [  "blouse"  ] 
  "searchTerms": "shirt"
  }
 "user_specified_id":
  {
  "ecr:type": "thesaurus-entry",
  "type": "multi-way",
  "synonyms": [ "converter","adapter","adapter-converter" ]
  }
}

Back to Top