Skip to main content

6.7.3 Service APIs – Version 1

OLIVE Services - Public APIs​

The technical documentation for all public APIs of the OLIVE core services can be found in your OLIVE deployment at:

https://app.<tenant>.<cluster>.<domain>/?config=olive-docs

More information about this API documentation can be found here: API documentation

The following OLIVE core services provide public APIs. For more information about these services and where they fit into the overall OLIVE platform architecture, see OLIVE Platform Architecture.

Data Orchestrator​

The Data Orchestrator API allows you to trigger a connectable element and poll the execution state of the resulting job. It is the main entry point for invoking existing OLIVE connectivity.

Its operations are reached under the versioned path data-orchestrator/v1/:

OperationPath
Invoke a connectable elementPOST data-orchestrator/v1/invoke
Poll a job's state and resultPOST data-orchestrator/v1/poll
Download a job's result as a filePOST data-orchestrator/v1/result
Resolve an asynchronous datapointPOST data-orchestrator/v1/resolve
Cancel a running jobPOST data-orchestrator/v1/cancel
Always use the /v1/ path

The same operations also answer on an unversioned path — data-orchestrator/poll rather than data-orchestrator/v1/poll. That unversioned path tracks the newest internal version of the API and may change between releases without notice.

/v1/ is the published, stable contract and is the only form this handbook uses. Anything outside the platform — a script, an Excel workbook, a scheduled job, an API client collection, an agent application — should call /v1/.

Repository​

The Repository API can be used to read and write connectable elements from and to the OLIVE repository. It is the main alternative to the OLIVE UI editor for creating connectable elements and connectivity scenarios in OLIVE, as well as for working with existing elements and their data.

File Storage Service​

The File Storage Service can be used to read and store files. It serves as long-term memory in connectivity scenarios.

It is the right place for data that is too large to pass from one element to the next — particularly in a workflow, where the engine limits how much a single step may carry. Write the payload to the file storage and pass the file key between elements instead of the content. It is also where data lives between long-running interactions. See File Handling in Connectivity.

Session Memory​

The Session Memory service enables storing data for a single user in a key-value format. It serves as short-term memory in connectivity scenarios for small amounts of data.

Its main purpose is to remember data from one point in an interaction for later use, or to collect small chunks of data from various independent connectivity elements for subsequent processing.

Changed in OLIVE 1.3

The session ID is generated by the service when you store the first item, and returned to you. Use that ID for every subsequent read and write — a session ID supplied by the caller is no longer accepted. Entries can also be flagged as sensitive, in which case they are bound to the user who created them and checked on every access.