Modify API Call in Workflow Instance

During processing a Workflow Instance can make one or many API Calls that send or retrieve data between your applications. Errors occur for several reasons such as when data is improperly formatted or incomplete. The ERP can contain errors as well.

If one API Call fails, the workflow instance stops and the API is marked as Unsuccessful in the Workflow Instance page.

View Error Message

When you receive notice of an error in the workflow instance, go to the Workflow Instance page, where an API error appears in the sections Attempts at the top and Response Body in the API Calls Details at the bottom. The Attempts section also designates the Error Type as API Call.

API Errors in Workflow Instance Page

Edit API Call from Workflow Log

1. To edit the API Call, first verify the value you are about to enter correct on the source application.
   Note: The new values must be added to the source application for future workflow instances contain the correct data.

2. From the Cloudsnap Platform, click Workflow Logs then API Calls.

3. Under Re-Run API call, enter the new value, or values, under API Call Parameters (A) or in the JSON code (B).

API Call Parameters and JSON Code

API Call Parameters (A)

If you chose to add the new values in the API Call Parameters (A), scroll to find the field name, then type in the correct replacement value. As you type, the replacement value appears in the JSON code in section B.

Changes must be in the JSON code for the API Call to run correctly on a retry.

JSON Code (B)

The JSON code (B) is the actual code the runs the API Call.

JSON Field Names and Values

• Place the value inside the double quotation marks in the right column next to the correct field.

• Ignore that brackets ({ }), which indicate the beginning and end of the API Call code, and other formatting symbols, such as the colon between columns.

• If you enter the replacement value in the JSON code(B), section A does not contain the replacement value until the changes are submitted.

Test and Run Edited API Call

Click the Submit button.

• If the API call is successful, the workflow instance resumes automatically.

• If the API call fails, check error, make necessary correction(s), then Submit again