Appian RPA REST API

The exposed Appian RPA API is a REST API. This format makes it far easier to invoke the functionality available in the API from other systems, even by using commands from different operating systems.

URL

A typical URL to call the API methods matches the following format: protocol://rpa-server/rest/specific-part-for-the-method

Where:

  • protocol is "https".
  • rpa-server is the domain and the context of the Appian RPA console, for example "lab.appian.io".
  • specific-part-for-the-method is the API method to be invoked. Some methods may need parameters.

The URL shown in the API methods section of this document corresponds to <specific-part-for-the-method>.

Authentication

Authentication in Appian RPA requires an API key via a service account from Appian.

If the service account has an administrator role in Appian, it will have an administrator role in Appian RPA. If the service account has a designer role in Appian, it will have a developer role in Appian RPA.

2231016.png

If the authentication has been successful, the REST API will return a token that must be used in the following invocations to the API. This token may be considered as a session identifier.

HTTP Verbs

Every API method must be invoked using the HTTP verb described on their corresponding specifications.

The read methods will commonly use the GET verb, the update ones will use PUT or POST, those removing information DELETE, etc.

Parameters

All the parameters must be included as the HTTP GET requests do, i.e., using query parameters, with the following exceptions:

The authentication method uses the verb HTTP POST with the request body of type x-www-form-urlencoded.

The method for the execution of robots with parameters uses the verb HTTP POST with the request body of type raw (application/json).

This information is included in every method specification.

Responses

The responses to the requests will always be obtained in JSON format.

Except for the authentication method, the responses will always include the following attributes:

invocationResult

It represents the result of the call. Its possible values are:

  • OK: If the call has been successfully completed.
  • KO: If the call has not been successfully completed.
  • EXCEPTION: If the call caused a server failure. It is unusual to obtain this kind of result in the API calls. In case it occurs, contact your Appian RPA administrator.

result

It represents the functional result of the call. Its value varies depending on the request made. The details can be found in every method specification described in this document.

Open in Github

On This Page

FEEDBACK