View thesaurus entry

get

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

Returns the thesaurus entry configuration for the specified thesaurus entry id. Returns metadata about the thesaurus entry (e.g. who created it and when). If zip extension is specified (add ".zip" at the end of the path), the thesaurus configuration is exported as a zip file.

• 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.

thesaurusEntryId

Type: string

Required: true

Specifies the id of the thesaurus entry.

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json
• application/zip

200 Response

Thesaurus entry.

Body

Represents the thesaurus entry in the ECR.

Root Schema : ThesaurusEntry

Type: object

Represents the thesaurus entry in the ECR.

Properties

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Default Value: thesaurus-entry

searchTerms

Type: string

synonyms

Type: array synonyms

Additional Properties Allowed:

type

Type: string

Nested Schema : synonyms

Type: array

Items

• Type: string

Examples

The following examples show how to export a thesaurus entry configuration using the specified thesaurus entry ID:

curl -H "Authorization:Bearer <token>" -X GET http://host:port/gsadmin/v1/cloud/thesaurus/user_specified_id -o OUTPUT_FILE (JSON format)

curl -H "Authorization:Bearer <token>" -X GET http://host:port/gsadmin/v1/cloud/thesaurus/user_specified_id.zip -o OUTPUT_FILE (ZIP format)