2112: Get terms version text

Fetch one or more terms version texts.

Endpoint ID:

2112

Method:

GET

URL:

/permissions/terms/{termsID}/{version}/text/{textKeys}

termsID

A GUID string identifier for the terms

version

A terms version string formatted as "major.minor", i.e. "1.0" or "4.7".

Alternatively, the string "active" indicates the active version of these terms. This will result in an error if the terms have no active version defined.

textKeys

OPTIONAL: A comma-separated list of "keys" for the specific texts to fetch for this version.

When no textKeys is provided, the primary version text will be returned.

If any listed keys are not found, a 404 response will be returned.

Alternatively, the string "all" returns all texts for this version.

Request body:

None

Response body:

The JSON response contains each requested version text, identified by its "key". When no textKeys URL parameter is provided, the primary version text is returned with key "text". The value is always base64 encoded.

/permissions/terms/c8ab8a40-8cda-442e-a244-b433dab4a4f4/1.0/text

{
    "text": "<base64 encoded text>"
}

/permissions/terms/c8ab8a40-8cda-442e-a244-b433dab4a4f4/active/text/text1,text3

{
    "text1": "<base64 encoded text>",
    "text3": "<base64 encoded text>"
}

/permissions/terms/c8ab8a40-8cda-442e-a244-b433dab4a4f4/1.0/text/all

{
    "text1": "<base64 encoded text>",
    "text2": "<base64 encoded text>",
    "text3": "<base64 encoded text>",
}

Status codes:

200

OK

400

Invalid request.

The following subcode may be returned:

400.1

These terms have no active version

404

The entity or terms were not found.

The following subcodes may be returned:

404.4	Terms not found
404.7	Terms version not found
404.8	Terms version text not found