RESTful service

A new TotalAgility REST service provides greater interoperability between TotalAgility and external systems, as it makes it easier to invoke the available functionality from another system.

This Rest API provides endpoints that enable you to integrate with TotalAgility. The endpoints available are a streamlined version of the functionality available on the existing .NET SDK.

The service is documented using Swagger and is available via the TotalAgility Designer at Integration > TotalAgility Rest API. Restful Service Swagger Documentation

When making a REST call to TotalAgility, a valid Session ID is required in the Authorization header to authenticate with the TotalAgility Rest API.

The documentation details the request body, including any required parameters for each endpoint.

Responses are in JSON format and vary based on the request made. The documentation includes details about what results are contained in the response body and what the status code indicates.

See the following example of creating a job.RestFul Service Example: Creating a Job

When you debug a process or form action that makes a REST service call and then view the information for the completed activity, you can see the details such as URL, Headers, Request, and Response.

See the following example of the Response body when debugging a form.RestFul Service Example: Debugging