Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add error status code description

Fetch a specific terms version text.

...

Endpoint ID:2111
Method:

GET

URL:

/permissions/terms/{termsID}/{version}/text/{textKey}/raw

/permissions/terms/{termsID}/{version}/text/{textKey}/entity/id/{entityID}

/permissions/terms/{termsID}/{version}/text/{textKey}/entity/ext-key/{ext-key}/{ext-type}


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


textKeyThe "key" of the specific text to fetch for this version.
Alternatively, the string "default" indicates the default text for this version.

entityID

dialogportalâ„¢ master key that uniquely identifies the entity

ext-keyExternal key that uniquely identifies the entity

ext-typeType of external key

Request body:

None

Response body:

The JSON response contains a single property, "text". The value is always base64 encoded.

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


Status codes:200Terms were acceptedOK

400

Invalid request.

The following subcodes may be returned:


400.1These terms have no active version
400.2This text contains merge fields, and requires an entity reference



404

The entity or terms were not found.

The following subcodes may be returned:


404.1Entity not found
404.2External entity reference could not be found
404.4Terms not found
404.7Terms version not found
404.8Terms version text not found