Overview

Infor Optiva REST API is a separate programming interface. It provides external software packages with the ability to read and alter information in the Optiva database. Setting up RestAPI is only necessary for Single Tenant and On-Prem.

API consumers can use the Optiva RestAPI Test UI or Optiva API Swagger Documentation to learn specific common functions and to analyze the available data points.

Calls to the Optiva RestAPIs can be developed in any language (e.g. Java,C#,JavaScript) that can generate HTTP requests such as .Net, Java, or JavaScript.

API consumers can perform these tasks:
  • Search for objects and modify those objects.
  • Create objects and import them to Optiva in one step.
  • Retrieve a subset of information for an Optiva object by using detail codes or filters.
  • Simulate calculations for formulas.
  • Launch workflows and process workflow events.
  • Use pre-configured Xi Home Page gadgets to retrieve data:
    • Recently saved lists
    • Recently viewed lists
    • Wizards
    • Pending Tasks

The API calls are made to the Optiva App Server database using either JSON messages or XML messages.

Here is a simple diagram that shows how the API calls can be made between an external application and Optiva.

RestAPI Overview

Optiva RESTAPI can be installed using the Optiva installation wizard. See the Infor PLM for Process Installation Guide.