Documentation

Input Required File in API Request: REQ_FILE_DATA

The Input Required File in API Request command is used to send file-type data in an API request. This is useful when an API requires a file upload as part of the request payload such as documents, images, or other data files.

Example: Suppose you are automating a document management process where you need to upload a PDF file using an API request. The API requires the file key name to be documentUpload, and the file you want to upload is located at C:\Reports\FinancialReport.pdf.

Steps to Configure:

1. Select Input Required File in API Request from the Action dropdown.
2. Leave the Screen Name field blank.
3. In the Element Key field, enter the file key name expected by the API (e.g., documentUpload).
4. In the Parameters section, specify the full file path (e.g., C:\Documents\sample.pdf).
5. Click Save.

When executed, this command will attach the specified file to the API request, ensuring it is uploaded successfully.

Note: While the steps for adding an action command are identical in both views, the display of the steps changes:

Expected Outcome on Execution:

• The API request includes the specified file as part of the request payload.