Jump to

• Request
• Response
• Examples

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

Supported Media Types

• application/json

Path Parameters

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

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

Thesaurus entry.

Body ()

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

Back to Top

Examples

The following example shows how to view a single record in the specified collection using the record 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)

Back to Top