Jump to

• Request
• Response
• Examples

Create thesaurus entry

post

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

Creates thesaurus entry in the specified application.

Request

Supported Media Types

• application/json
• application/zip

Path Parameters

• appName(required): string
  Specifies the name of your application. For example, "cloud".
• thesaurusEntryId(required): string
  Specifies the id of the thesaurus entry.

Body ()

The thesaurus entry to create.

Root Schema : ThesaurusEntry

Type: object

Represents the thesaurus entry in the ECR.

Show Source

• ecr:createDate: string
• ecr:lastModified: string
• ecr:lastModifiedBy: string
• ecr:type: string
  Default Value: thesaurus-entry
• searchTerms: string
• synonyms: array synonyms
• type: 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

201 Response

Thesaurus entry successfully created.

Body ()

Root Schema : Response

Type: object

Show Source

• message: string
• status: 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 add a thesaurus entry with a user-specified ID to the thesaurus:

{
	"ecr:type" : "thesaurus-entry",
 	"type": "one-way",
  	"synonyms": [  "blouse"  ] 
 	"searchTerms": "shirt"
}

Back to Top