REST API developer guide

Introduction

This topic describes how to register workflows as REST APIs and run them from an external program using REST API calls. The examples are simple workflows that convert input parameters into output datasets. The REST API calls are performed using Postman, which may be downloaded here. This guide assumes that you are familiar with Postman.

Prerequisites

You should make sure that LiveCompare is configured to register workflows as REST APIs by following the instructions here. You should also make sure LiveCompare is configured not to delete REST API workspaces, as described here.

Create a workspace

The examples in this guide use a LiveCompare workspace named REST_API. Before you begin, create a workspace named REST_API.

REST API examples

• EchoInteger REST API example

• EchoFloat REST API example

• EchoString REST API example

• EchoBoolean REST API example

• EchoTable REST API example