1.1 Schemas and Examples

The RESTful web services provide schema information and sample code that you can access with a web browser. To access the information, point your browser to the Workflow Automation Web Service computer as follows:

  • For the Integration web service:

    • http://WebServiceComputer:Port/Aegis/Integration/RESTful/help
    • http://WebServiceComputer:Port/Aegis/Integration/WindowsRESTful/help (Windows authentication)

  • For the IQConnect web service:

    • http://WebServiceComputer:Port/Aegis/IQConnect/RESTful/help
    • http://WebServiceComputer:Port/Aegis/IQConnect/WindowsRESTful/help (Windows authentication)

WebServiceComputer is the Workflow Automation web server computer name. Port is the web service HTTP port number, by default 8092.

NOTE:

  • The RESTful web services support both secure (https) and standard (http) addresses.

  • The WindowsRestful web service URL is only for callers using Windows authentication. All other callers should use the Restful web service URL.

  • The Workflow Automation web services schema is produced by a tool that does not allow a particular parameter or property to be marked as required. This user guide correctly indicates whether a parameter or property is required or optional.

For example, if the Workflow Automation web server computer is houidae002v and the configured HTTP port number is the default 8092, the URL http://houidae002v:8092/Aegis/Integration/RESTful/help displays the following top-level help page for the Workflow Automation Integration web service:

To view the top-level help page for the IQConnect web service, replace “Integration” with “IQConnect” in the URL.