Available API Methods

This table shows the API methods available in the /scriptingservice/engine endpoint.

Method Type Description
/v1/scripts/ GET Returns a list of all scripts with at least one approved version.
/v1/scripts/{name} GET Returns:
  • Script Name.
  • Last Approved Version Date Time.
  • Last Approved Version Details.
  • Last Approved Version number.

  • Last Approved Version Description.

  • Last Approved Version Documentation in HTML format.

  • Last Approved Version Library Dependencies: Array of library name, library version.

  • Last Approved Version Input Variables: list of names, data type, description.

  • Last Approved Version Output Variables: list of names, data type, description.

For specified script name.

Note: Only details of script with at least one approved version can be retrieved.
/v1/scripts/{name}/execute POST Use this API to execute script.

In request body provide the JSON input body with key/value pairs representing the input variables and their values.

For ‘Binary’ input variables provide a base64 encoded string. When executing the base64 value is decoded and set in the script’s variable with the decoded value.

The response provides the output of key/value pairs for the output variables.

For ‘Binary’ output variables their value is base64 encoded in the response.

Variables with NULL values can be omitted in the input request and is omitted in the response.