Welcome to the OL Connect REST API Cookbook

This guide is aimed at technically experienced users who wish to learn and use the REST API available in OL Connect version 2023.2.

The OL Connect REST API consists of many services that expose access to a number of areas including workflow, data entity management and file store operations.

These services can be used to perform various interactions with the OL Connect server such as:

• Upload and manage data files, data mapping configurations and templates in the file store
• Create, manage and find data entities internal to the OL Connect server
• Create and monitor processing operations within the workflow

The REST API also supports added security to restrict unauthorized access to the services.

For information about the server configuration, see the OL Connect Help.

This guide is broken down into three sections:

• Technical Overview – Overview of the concepts and structures used in OL Connect and the REST API
• Working Examples – Working examples of the OL Connect REST API in action (HTML5 & JavaScript/jQuery)
• REST API Reference – A complete reference to the OL Connect REST API and services

It is recommended that the technical overview section be read first, followed by the working examples, using the REST API reference for greater detail on implementing any specific example.