The REST API task in Automation makes API calls internal to Avaya Experience Platform™ Public Cloud components and external to other endpoints. You can use the Properties pane to create a request to the API endpoint: choose a method, specify REST URI, and identify the header, body, and parameters. To configure an API call for internal API calls, see the Avaya Experience Platform™ Public Cloud API documentation at https://developers.avayacloud.com/. For external calls, see the API documentation that the API vendor provides.
Properties |
Description |
Method |
The HTTP verb for the request. Automation supports the following verbs:
|
Rest URI |
URI of the REST endpoint. You can set Rest URI as a variable or manually type the URI. You can also combine a URL input with a variable. For example, if REST_ADDRESS is a variable, you can type https://{{REST_ADDRESS}}/my/api to combine the URL input with a variable. |
Header |
A list of key-value pairs that you add to the request as headers. By default, Automation uses the header key Content-Type. No user input is required if you use the default key. When you change the body type, the content type in the header changes automatically. You can set a header as a variable or manually type the header values. You can also combine the header input with a variable. For example, if token is a variable, in the Name field, you can type Authentication, and in the Value field, you can type bearer {{token}} to combine the header input with a variable. |
Body |
Body of your request in the JSON format. JSON is a multiline body type and the default body type for the requests. You can use variables in the body format or manually type a request body.
You can also combine the body input with a variable. For example, if domain is a variable, in the Body field, you can type the following:
{
"domain" : "{{domain}}"
}
You can configure the Body property when you are using POST and PUT methods. |
Param |
A list of key-value pairs that you add to the request as query parameters. You can use variables as query parameter values or manually type the query parameter values. You can also combine a parameter input with a variable. For example, if search_string is a variable, in the Name field, you can type q, and in the Value field, you can type {{search_string}} to combine the parameter input with a variable. |
