Jump to

• Request
• Response
• Examples

Update thesaurus entry

put

/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}

Updates thesaurus entry 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".
• thesaurusEntryId: string
  Specifies the id of the thesaurus entry.

Body ()

The request body represents the updated thesaurus.

Root Schema : ThesaurusEntry

Type: object

Represents the thesaurus entry in the ECR.

Show Source

• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: thesaurus-entry
• searchTerms(optional): string
• synonyms(optional): array synonyms
• type(optional): string

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"thesaurus-entry"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "searchTerms":{
            "type":"string"
        },
        "synonyms":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Represents the thesaurus entry in the ECR."
}

Nested Schema : synonyms

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Thesaurus entry 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 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",
 	"type": "one-way",
  	"synonyms": [  "jersey"  ] 
 	"searchTerms": "shirt"
}

Back to Top