Skip to content

API Discoverability for Workflows

Workflow is designed to work with API calls in the IFS Cloud. If you intend to use a Workflow for a specific purpose, then you need to know which APIs and their entity sets to use in the Workflow. The API Explorer page is the best place to see information about APIs. It gives an overview of all existing APIs (projections) in the system. Also, you can navigate to the API explorer page from the IFS Cloud Devtool Console.

In order to do this, enable the devtools link in the IFS cloud web and navigate to the page where you want to see the information. Let’s suppose you navigated to the “Regulatory Body” page.

After clicking the "Network" button, you will see the "Open in API Explorer" button and select the icon of the relevant API call.

When you click the "Open in API Explorer" button, it will direct you to the API Explorer page, displaying the relevant API name.

Click on the "API Doc" link to access the API documentation page, where you'll find a list of available API calls for each entity set. You can use this to identify the required attributes for each API call.

Identifying the Correct API and Entity Set Names

Assume that you want to create a "Regulatory Bodies" record from a Workflow. The following steps can help you identify the correct API name, Entity Set Name, and parameters to be used in the Workflow.

  1. Enable the devtool console in the IFS cloud.

  2. Navigate to the "Regulatory Bodies" page.

  3. Perform the same operation in the IFS cloud you intend to do in the Workflow. In this scenario, create a new record from the "Regulatory Bodies" page.

  4. In the devtool console, you will see the API call with the API name, entity set, and parameters, as shown below.

  1. Use that information in the API task of the Workflow designer page, to create the "Regulatory Bodies" from the Workflow.

Filtering Records in the Workflow by Parameters

By using a Workflow, a new "Regulatory Bodies" record was created in the above scenario. Assume that you want to read the same record just after creating it in the same Workflow.

Since it reads from the same entity object, the API name, and entity set are the same as in the previous scenario. To filter records by parameter, you can specify the "Parameters" attribute available in the IFS API task in the Workflow. You can also use the "Define a Filter" field to filter records.

Note: Both "Parameters" and "Define a Filter" options cannot be used at the same time.

For more details about how the IFS API task works in the Workflow, please refer to the IFS API task page.