iMIS API

Input Output

Any (JSON)

  • Any (JSON) (Passthrough)
  • Response Data (object) (Optional)

Summary

This action allows you to make any iMIS REST API call. The correct URL and an API token are automatically generated for you, so you don’t need to handle the connection aspect.

This action supports GET, POST, PUT, and DELETE actions, and allows you to specify any API endpoint after /api/.

Support for automatic retries on failure are supported and enabled by default, to handle transient network issues.

Properties

Name Type Templatable Notes
Method Choice
  • GET
  • POST
  • PUT
  • DELETE
No Select the correct HTTP verb for your operation.
Path Text Yes The URL path after /api/. Do not include a leading slash (/) or /api/. For example, to call /api/party, simply enter party. Or, to fetch a specific panel record by its identity: myPanel/1234
Query String List Yes (Optional) The query string parameters to pass in.

Note: The query string parameters can be specified here OR in the Path parameter. If specified in both places, the values in this Query String list are appended after the Path value.

Body Text Yes (Optional) Specify the body to include. Only supported/sent if this is a POST or PUT operation.
Attempt Count Number Yes Specify the number of repeated attempts to make if the API returns an error. The action will pause for 5 seconds between each attempt. Value must be between 1 and 10. The default value is 3.
Fetch All Pages
Coming Soon
Checkbox No If checked, and if the endpoint returns a paginated result, this action will loop through each page and fetch the entire dataset, not just the first page.

Warning! Feature not available - coming soon.

Output Property Text No

To capture the API call response, specify the name of the property to write the output to. The output is in the following format, assuming that the output property name is “apiResult”:

Copy
"apiResult": {
    "statusCode": 200,
    "headers": {
        "Transfer-Encoding": "chunked",
        "Server": "Microsoft-IIS/10.0",
        "X-Powered-By": "ASP.NET",
        "Date": "Wed, 14 Aug 2024 16:02:27 GMT"
    },
    "body": { ... /* iMIS API Response here */ ... }
}