API overview

The Infor ION suite offers several API endpoints. This table sows the relevant API endpoints in this context:

Endpoint Function
/connect/model

Modeling for ION Connect:

  • Data flows
  • Connection points
  • File templates
  • Mappings
  • Enterprise Locations
/scriptingservice/model

Modeling for ION Scripting (Cloud Edition only):

  • Scripts
  • Libraries
/process/model Modeling for ION Process:
  • Monitors
  • Workflows
  • Activation policies
  • Alarm templates
  • Business rules
/datacatalog Modeling for metadata:
  • Objects
  • Nouns, for BODs
  • Schema extensions, for BODs
  • Locale selections, Cloud Edition only
/configuration/model Various configuration settings:
  • Codes
  • Workflow authorizations
  • Email templates
/usage/model Checking the usage of a model in other models. For example, which scripts use a specific library, or which activation policies use a specific workflow.

For these resources, several methods are available. As an example, this list shows the operations for workflows:

  • GET /process/model/v1/workflows

    Get a list of existing workflows. Optionally, apply a filter to find specific workflows.

  • GET /process/model/v1/workflows/{name}

    Get all details of a workflow.

  • POST /process/model/v1/workflows

    Add a new workflow.

  • PUT /process/model/v1/workflows/{name}

    Update an existing workflow. This overwrites the existing model.

  • PUT /process/model/v1/workflows/{name}/activate

    Activate a workflow.

  • PUT /process/model/v1/workflows/{name}/deactivate

    Deactivate a workflow.

  • PUT /process/model/v1/workflows/activate

    Activate multiple workflows in one go.

  • PUT /process/model/v1/workflows/deactivate

    Deactivate multiple workflows in one go.

  • DELETE /process/model/v1/workflows/{name}

    Delete a workflow.

  • GET /usage/model/v1/workflows/{name}

    Get the list of monitors, activation policies, data flows and workflows that use a workflow.

Which methods are available depends on the resource involved. For example, connection points do not have activation and deactivation methods. That is handled through the data flows.

For an overview of specific operations, see Available operations.

As a rule of thumb, processes you can start through the user interface can also be started through the API. Export and import are not available, because GET, POST and PUT methods for each individual resource are used instead.

The processes you cannot start through the user interface are also not allowed through the API. For example, changes on an active monitor are limited through API and through the ION user interface.

In this example workflows and business rules, which have versioning, are discussed. The objects that were updated in the last sprint must be placed on the development tenant. The objects are stored in a configuration management system. Next, the test tenant is updated with this new content.

Configuration management diagram

After approval, the testing can start on the test tenant. This can consist of integration testing, performance testing and so on.

When the test content is approved, it is copied in a similar way to the production tenant.