Template information
Use these calls to read what a logic file offers before you create documents: its online documents, its texts and their keywords, and the version of the engine. You can use the answers to build a list of templates in your own application.
The common parts of every call, such as the path, the token and the response codes, are on Calling the Pages API. Paths on this page leave out the optional environment group.
Online documents
GET /{customerEnvironment}/onlinedocuments/{metaFile}Lists the documents in the logic file that are marked as online documents, with their keywords. See Editor integration.
Texts
POST /{customerEnvironment}/texts/{metaFile}Returns the texts in the logic file. The body is a filter, and every field in it is optional:
| Field | Meaning |
|---|---|
FolderPath | The folder path to filter on. |
KeyWords | A list of keywords to filter on. |
Description | The description to filter on. |
{ "FolderPath": "", "KeyWords": [ "Nordlys" ], "Description": "" }The response has a list Texts. Each text has a TextId, a Description, a FolderPath and its KeyWords.
Text keywords
GET /{customerEnvironment}/textkeywords/{metaFile}Returns one list, KeyWords, with every keyword that is used in the texts of the logic file. Use it to fill a keyword picker.
Engine information and version
| Call | Returns |
|---|---|
GET /{customerEnvironment}/getinfo | Information about the document engine, such as its fonts. |
GET /{customerEnvironment}/version | The version of the document engine (InteractEngineVersion), of the logic (InteractLogicVersion) and of Pages (Version). |
Mention these versions when you contact support about a document that looks wrong.