Jump to

• Request
• Response
• Examples

View thesaurus

get

/gsadmin/v1/{appName}/thesaurus

Returns the thesaurus configuration for the specified application. Returns metadata about the thesaurus (e.g. who created it and when) along with a list of thesaurus entries. 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".

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

Thesaurus.

Body ()

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

Back to Top

Examples

The following examples show how to export the entire thesaurus for the cloud application:

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

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

Back to Top