2111: Get terms version text
- Nick Jensen
Fetch a specific terms version text.
There are 3 url formats for this endpoint. The first, "raw" url is only allowed for static, non-dynamic texts. If the text contains merge fields, an entity must be given, using one of the other url formats.
| 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} | |||||||||||
| 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 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:
| |||||||||||
| 404 | The entity or terms were not found. The following subcodes may be returned:
| |||||||||||