Fetch a specific terms version text for an entity. The text will have any merge fields populated with entity data.

Endpoint ID:

2111

Method:

GET

URL:

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

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

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.

textKey

The "key" of the specific text to fetch for this version.

Alternatively, the string "default" indicates the default (primary) text for this version.

entityID

dialogportal™ master key that uniquely identifies the entity

ext-key

External key that uniquely identifies the entity

ext-type

Type of external key

Request body:

None

Response body:

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

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

Status codes:

200

OK

400

Invalid request.

The following subcodes may be returned:

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

404

The entity or terms were not found.

The following subcodes may be returned:

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

Browser not supported