Adding a REST API

About this task

Icon for the Rest API activity

Use the REST API activity in workflows that require REST APIs.

Procedure

  1. In the Workflow Canvas, open the Project tab.
  2. Select the Workflow dropdown. The Workflow Designer opens.
  3. Open the Activities tab.
  4. Drag the REST API workflow activity onto the Workflow Designer.
  5. In the Properties panel, enter a name for the activity in the Display Text field. The name appears on the icon in the workflow.
  6. In the Service menu, select the appropriate REST API from the rules created in the Data Connection Rule > REST API tab.
    Tip: Select next to the dropdown to create a Rest API rule. For details, see REST API: Creating a REST API Rule.
  7. Select Map Fields to open the Set Fields Mapping dialog box. Then, select Start Mapping.
  8. Optional: Select Add to create a new workflow variable. From the Add Workflow Variable dialog box, enter the following:
    1. Variable Name: Enter a name for the workflow variable.
    2. Description: Enter a description for the workflow variable.
    3. Value: Enter the value for the workflow variable.
  9. Map SOTI Snap App Fields to the selected REST API's request parameters. Once you have finished mapping, select Next. Then, select Next again.
    Restriction: When mapping, each request parameter can receive up to a single app field. However, you can assign app field to as many request parameters as you like.
    Remember: When you map a workflow variable to a request parameter, SOTI Snap copies the workflow variable's value and pastes it into the request parameter value when SOTI Snap makes the REST API query.
  10. Map the selected REST API's response parameters to SOTI Snap Workflow Variables. Once you have finished mapping, select Finish.
    Restriction: When mapping, each workflow variable can receive up to a single response parameter. However, you can assign each response parameter to as many workflow variables as you like.
    Remember: When you map a response parameter to a workflow variable, SOTI Snap copies the response parameter value and pastes it into the workflow variable value when SOTI Snap makes the REST API query.