Invoke Web API: Configure Web API

You can configure the Web APIs in the Web API Activity Configuration window. This window lists all the Web APIs configured for the application or workflow.

Note: The Web Server and the Web API hosted Server communicate through secure TLS channels. To ensure seamless communication, verify that appropriate TLS versions are enabled. It is recommended to configure the highest common TLS version supported by both servers for optimal security.

Http Method

The Invoke Web API activity supports the following HTTP request methods:

• GET: The GET method retrieves information from the given server using a given URI. Requests using GET should only retrieve data and should have no other effect on the data.

• POST: A POST request sends data to the server, for example customer information, file upload, using HTML forms.

• PUT: A PUT request replaces all current representations of the target resource with the uploaded content.

• DELETE: A DELETE request removes all current representations of the target resource given by the URI.

• PATCH: A PATCH request updates an existing resource. It specifies only the changes and does not replace the entire resource.

Web API

Web APIs are frameworks to build HTTP services for browsers and mobile devices.

If the Web API is Windows authenticated, then the status of the Windows Authentication must be set to Enabled for the EnterpriseConsole site under AVEVAWorkTasksSites site in the IIS Manager.

If the Web API requires ArchestrA Security Token Service (ASTS) access token authentication, then the Workflow Engine Service must first be registered as a client in the ASTS server through Central Configuration site. Web API with the Access Token enabled Authentication gets listed in the Web API drop-down list, so that it can be used within the workflow.

Request URI

The Request URI is a Uniform Resource Identifier and identifies the resource upon which to apply the request.

Example:

• Request URI without parameters: api/product/1 for http://localhost/MySite/api/product/1

• Request URI with parameters: api/{product}/{ID} for http://localhost/MySite/api

Content Type

You can configure the content type of the Http Message body. The available options are JSON, XML, and URL ENCODED.

This field is displayed only when the value of Http Method is set to POST, PUT, or PATCH.

Encoding

You can configure the encoding type while configuring the Web API activity. The supported encoding types are UTF-7, UTF-8, and UTF-16. The Default encoding type is used for backward compatibility.

POST Data

Passing data to POST and PUT Methods

You can pass data to POST and PUT methods either through parameters or through the request body. If you pass data through request body, use the adjacent text box for the body content. If web API method uses [FromBody] attribute, select the Yes option for the FromBody Attribute property.

Output Settings

Save Output In

Use the options in this field to save the return value from the Web Method so that you can use it in subsequent activities. You can save the return value as either a Variable or as an XML Variable.

To save the output as a Variable, select the variable that you created in the Start activity. To save the output as an XML variable, select the XML Variable that you created in the Start activity. You can also create the XML variable using the Create New option.

Note: Create XML variable will work only if the web API returns valid data. Therefore, for Delete, Put, and Post, use an existing variable.