Workflow API call

The functionality to call an API Gateway is available in Workflow and contains this functionality:
  • You can use a new workflow step named “API” to model an API call at any place in the workflow.
  • You can call an API Gateway operation that is exposed through the API Gateway metadata. Reply of type JSON, XML, and Text is accepted
  • You can use both, reading and writing operations.
  • You can search for the operation to use based on the API Gateway metadata. The API Gateway applies an elastic search algorithm.
  • You can configure the security credentials for each workflow API step by importing a service account.
  • You can map between API request and API output parameters and workflow parameters.
  • You can pass workflow structures and task notes as request body for POST and PUT methods, which support these data structures.
  • You can test the API execution during modeling.
  • You can configure preferences for error handling.

These features are not supported:

  • Reply of REST Streaming Methods
  • Input parameters of type FORMDATA and input content type “multipart/form-data". Only parameters of type FORMDATA and input content type “application/x-www-form-urlencoded” are supported. If the input content type is not specified, it is assumed the type is "application/x-www-form-urlencoded".

To model a workflow that makes an API Gateway call, start ION and navigate to the workflow modeler. Add a workflow step of type API and specify its properties as described later. When the configuration is ready, save and activate the workflow.

See Specifying details for an API element.

To call an API, these configuration steps must be completed:

  • Ensure the application that exposes the API Gateway to call is registered and its endpoints are indexed.

    See “Registering the client application” in Infor ION administration documentation.

  • In the Infor Ming.le User Management UI, create service accounts for the backend application that exposes the API Gateway to call. Ensure to specify the description property of the service account, as this is required by ION.

    See “Service Accounts” in the Infor Ming.le Cloud Edition Administration Guide.

References

The workflow API step is built using the ION API metadata exposed by the API Gateway. Information about the API Gateway functionality can be found in the Infor Ming.le and Infor ION administration documentation.