Alemba API Architecture

The API fits within the ASM Core architecture, and typically looks as illustrated in the diagram below.

Included with the Installation

• Alemba.Web, containing:

  • Authorization service – allows you to login and provides a token to use for all subsequent API calls

  • The API Explorer which is an interactive UI for understanding the API, including live search facilities as well as detailed technical information regarding all the available entities and actions

• Alemba.API – the main API

• The Alemba API also provides many new tables of metadata in the ASM database.

ASM version 10.6.8 API Enhancements

The Alemba API for HERMES 10.6.8 supports all previous API capabilities and also supports:

1. Custom Fields/Extension Fields

2. Attachments

   • Attachments in Base64 Format to simplify the process and support via Logic Apps (As of Build 13255).

   • Attachments can be serialized in and embedded in a response so that separate calls are not necessary (As of Build 14379).

3. Data

   • Returning the HTML versions of the Abstract, Solution or Additional Information fields from Knowledge Articles (As of Build 13283).

   • See also Webhook Payload: The ActionHistoryId ref can be used to retrieve a history item via the Alemba API. Eg. api/v2/call/404/history?$select=Order,ActionTitle,ActionDescription&$Filter=Order=18

4. SLM

   • The Alemba API can stop the SLA Clock based on configured Call Statuses (As of Build 13368).

5. Closure Methods/Rules

   • All Closure Methods inc Immediate, Comments and Rules (As of Build 13498).

6. Call, Task, Request History Search

   • End Point: api/v2/[entity]/history

   • API Explorer

     • Permissions are based on existing IPK or Workflow Roles

     • Optional Query String: showSystemActions

     • No Private Entries will be returned