# RESTAPICLIENT ## Overview The **RESTAPICLIENT** workflow application allows you to call REST API endpoints to exchange information with other applications through HTTP requests, and can be used to build integrations with extendable applications (such as Azure Services and Slack). It also allows you to call a REST API endpoint using `application/json`, `application/x-www-form-urlencoded`, or `multipart/form-data` payloads. RESTAPICLIENT will then receive and process the response from the external API by mapping the response content with defined OUT parameters. ## How it works * The RESTAPICLIENT application requires the `APP_URL` parameter, which corresponds to the REST API endpoint.
* The default request payload content type (`APP_REQUEST_CONTENT_TYPE`) is `application/json`. `application/x-www-form-urlencoded` and `multipart/form-data` are also supported. Use `multipart/form-data` for file uploads (see the [`multipart/form-data` parameters](#multipart-form-data-parameters) section).
* The default HTTP request method (`APP_METHOD`) is `GET`. Other request methods (`POST`, `PUT`, `DELETE`, etc.) are also supported.
* In case of error, when the `APP_RESPONSE_IGNORE_ERROR` IN parameter is defined and has `Y` as its value, the error will be ignored and defined OUT parameters (`APP_RESPONSE_STATUS` or `APP_RESPONSE_CONTENT`) will be mapped. Otherwise, an exception will be thrown.
* Since the application parameters are case sensitive, parameters must use the API’s accepted notation.
* The default request timeout is 30,000 milliseconds (30 seconds); this default value can be modified by setting the `RestApiClientRequestTimeout` parameter value in the `web.config` file. The request timeout can also be defined in the `APP_TIMEOUT` IN parameter; the maximum timeout is 3,600,000 milliseconds (1 hour).
✏️ **Note:** This timeout value must be less than the IIS request timeout value.
* The HTTP request headers can be defined with the `APP_HEADER_xxx` parameters, where `xxx` is the header field name. For more information, see the [Header parameters](#header-parameters) section.
* The request payload can be defined in the `APP_REQUEST_CONTENT_FILE` or `APP_REQUEST_CONTENT` IN parameters. When both parameters are defined, the `APP_REQUEST_CONTENT_FILE` parameter has priority. For more information on these parameters, see the [Request payload](#request-payload) section.
* The response from the REST API can be mapped to the `APP_RESPONSE_CONTENT_FILE` or `APP_RESPONSE_CONTENT` OUT parameters. Both parameters can be defined at the same time. For more information on these parameters, see the [Response payload](#response-payload) section.
* Besides the optional parameters listed below, you can also add additional custom IN and OUT parameters to send and receive custom user-defined data to and from the external API. For more information on and examples of these custom IN and OUT parameters, see the [Request payload](#request-payload) and [Response payload](#response-payload) sections.
* The application supports the JSONPath query language (see [https://github.com/json-path/JsonPath](https://github.com/json-path/JsonPath/)), which allows extraction of specific data from a JSON response (similar to XPath expressions in XML). For information on how to use this with the application along with examples, see the [Response payload](#response-payload) section.
* Application logs are available and can be specified by setting the `RestApiClientLogLevel` parameter value in the `web.config` file to `0` to disable logging (default), `2` for simple logs, or `3` for debug logs.
* The default maximum response length is 4194304 characters (4 MB); this default value can be modified by setting the `RestApiClientMaxResponseLength` parameter value in the `web.config` file.
* Automatic deletion of temporary files can be disabled by setting the `RestApiClientEnableFilesCleanUp` parameter value to `N` in the `web.config` file; the default value is `Y`. * The `APP_RESPONSE_CONTENT_FILE` parameter automatically detects binary content types (PDF, images, ZIP, etc.) and saves them correctly without corruption. Use `APP_RESPONSE_CONTENT_FILENAME` to specify a custom filename. * Authorization headers are automatically masked in log files for security (displays `***` followed by the last 4 characters of the token). * Binary response content is summarized in logs (e.g. `[Binary content, 37228 bytes, application/octet-stream]`) to prevent log file bloat and ensure readability. ## Required parameter
ParameterTypeDirectionDescription
ParameterTypeDirectionDescription
APP_URLTEXTINExternal API URL
## Optional parameters ### General
ParameterTypeDirectionDescription
ParameterTypeDirectionDescription
APP_TIMEOUTNUMERICIN

Maximum time interval between sending the request and receiving the response

The default is 30,000 milliseconds (30 seconds) and the maximum is 3,600,000 milliseconds (1 hour); the default can be modified by setting the RestApiClientRequestTimeout parameter value in the web.config file.

✏️ Note: This timeout value must be less than the IIS request timeout value.

APP_METHODTEXTIN

API method

The default is GET. Supports POST, PUT, DELETE, HEAD, PATCH

APP_REQUEST_CONTENT_TYPETEXTIN

Request content type supported by the external API

The application supports application/json, application/x-www-form-urlencoded, and multipart/form-data; the default is application/json. Use multipart/form-data for file uploads to APIs.

APP_RESPONSE_IGNORE_ERRORTEXTINWhen set to Y, the application will ignore the error when a WebException occurs or the external API returns a response status equal to or greater than 300; the default is N.
### `APP_URL` optional parameters
ParameterTypeDirectionDescription
ParameterTypeDirectionDescription
APP_URL_xxxTEXTIN

API URL optional parameter where xxx is the URL parameter name

It must be defined in the APP_URL parameter value between brackets (e.g. APP_URL_subscriptionId for the URL https://management.azure.com/subscriptions/{subscriptionId})

📌 **Example**
ParameterTypeDirectionValue
ParameterTypeDirectionValue
APP_URLTEXTINhttps://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
APP_URL_subscriptionIdTEXTIN457a2a46-7a7f-4afa-940d-8779e1425fa8
APP_URL_resourceGroupNameTEXTINdev-group-advantys
APP_URL_topicNameTEXTINdev-topic
The parameters defined above will generate the following URL in `APP_URL`: ```http https://management.azure.com/subscriptions/457a2a46-7a7f-4afa-940d-8779e1425fa8/resourceGroups/dev-group-advantys/providers/Microsoft.EventGrid/topics/dev-topic ``` ### Header parameters
ParameterTypeDirectionDescription
ParameterTypeDirectionDescription
APP_HEADER_xxxTEXTINExternal API header parameters where xxx is the header field name
#### 📌 Example
ParameterTypeDirectionValue
ParameterTypeDirectionValue
APP_HEADER_AuthorizationTEXTINBearer AbCdEf123456
APP_HEADER_locationTEXTINcanadaeast
The parameters defined above will generate two headers in the request payload: ``` Authorization: Bearer AbCdEf123456 location: canadaeast ``` ### Authorization parameters The application also supports some predefined authorization header parameters in order to avoid adding these HTTP header parameters with the `APP_HEADER_xxx` parameter name.
ParameterTypeDirectionDescription
ParameterTypeDirectionDescription
APP_AUTH_BASIC_USERNAMETEXTINAPI authorization Basic username
APP_AUTH_BASIC_PASSWORDTEXTINAPI authorization Basic password; must be used with APP_AUTH_BASIC_USERNAME parameter
APP_AUTH_BEARER_TOKENTEXTINAPI authorization Bearer token
APP_AUTH_AZ_SAS_TOKENTEXTINAPI authorization Azure SAS token
{% hint style="info" %} * Only one authorization header can be defined, otherwise an exception is thrown.
* `APP_AUTH_BEARER_TOKEN` is equivalent to defining the header parameter `APP_HEADER_Authorization`. {% endhint %} #### `multipart/form-data` parameters When `APP_REQUEST_CONTENT_TYPE` is set to `multipart/form-data`, use the following parameters to upload files and send form data to APIs.
ParameterTypeDirectionDescription
APP_FORMFILE_xxxFILEINFile to upload where xxx is the form field name expected by the API (e.g. APP_FORMFILE_file creates a form field named file)
APP_FORMDATA_xxxTEXT, NUMERIC, or DATETIMEINForm data field where xxx is the field name (e.g. APP_FORMDATA_purpose creates a field named purpose)
#### **Supported data types for `APP_FORMDATA_xxx`**
TypeFormat
TEXTSent as-is
NUMERICFormatted with invariant culture (e.g. 1234.56)
DATETIMEFormatted as ISO 8601 (e.g. 2026-01-09T12:30:00Z)
**📌 Example: Upload file to OpenAI Files API**
ParameterTypeDirectionValue
APP_URLTEXTINhttps://api.openai.com/v1/files
APP_METHODTEXTINPOST
APP_REQUEST_CONTENT_TYPETEXTINmultipart/form-data
APP_AUTH_BEARER_TOKENTEXTINsk-xxx
APP_FORMFILE_fileFILEIN(file to upload)
APP_FORMDATA_purposeTEXTINassistants
idTEXTOUTDATA_FILE_ID
The parameters defined above will generate a multipart request equivalent to: ```bash curl https://api.openai.com/v1/files \ -H "Authorization: Bearer sk-xxx" \ -F "file=@myfile.pdf" \ -F "purpose=assistants" ``` **📌 Example: Upload file to Mistral Files API (OCR)**
ParameterTypeDirectionValue
APP_URLTEXTINhttps://api.mistral.ai/v1/files
APP_METHODTEXTINPOST
APP_REQUEST_CONTENT_TYPETEXTINmultipart/form-data
APP_AUTH_BEARER_TOKENTEXTINMistral API key
APP_FORMFILE_fileFILEINPDF or image file
APP_FORMDATA_purposeTEXTINocr
idTEXTOUTDATA_FILE_ID
{% hint style="info" %} Mistral OCR supports PDF, images, Word (`.docx`), PowerPoint (`.pptx`), and EPUB files. HTML is not supported. {% endhint %} {% hint style="warning" %} * When `APP_REQUEST_CONTENT_TYPE` is set to `multipart/form-data`, standard IN parameters (not prefixed with `APP_FORMFILE_` or `APP_FORMDATA_`) are not included in the request. * The file's original filename and content type are preserved in the upload. * Multiple files can be uploaded by defining multiple `APP_FORMFILE_xxx` parameters with different field names. {% endhint %} ### Request payload {% hint style="info" %} The request payload parameters described in this section apply to `application/json` and `application/x-www-form-urlencoded` content types. For `multipart/form-data` requests (file uploads), see the [`multipart/form-data` parameters](#multipart-form-data-parameters) section. {% endhint %} There are two different ways to prepare the request payload. The first way is when you have access to the whole request payload (see [Set the whole request payload via a parameter](#set-the-whole-request-payload-via-a-parameter) below); the second way is by building the JSON or URL encoded payload via IN parameters (see [URL encoded request payload](#url-encoded-request-payload) and [JSON request payload](#json-request-payload) below). #### Set the whole request payload via a parameter The following parameters can be used when you have access to the whole request payload, or the request content type is neither `application/json` nor `application/x-www-form-urlencoded`. You can set this request payload in a file/text data or directly in the text value.
ParameterTypeDirectionDescription
ParameterTypeDirectionDescription
APP_REQUEST_CONTENT_FILEFILEINRequest payload in a file
APP_REQUEST_CONTENTTEXTINRequest payload
{% hint style="info" %} * `APP_REQUEST_CONTENT_FILE` has priority over `APP_REQUEST_CONTENT`.
* `APP_REQUEST_CONTENT` has priority over IN parameters used to build a JSON or an URL encoded payload. {% endhint %} #### URL encoded request payload The following examples show how to build a request payload with `application/x-www-form-urlencoded` as content type. **Standard URL encoded request payload** The following parameters are used to build a standard URL encoded request payload:
ParameterTypeDirectionDescription
ParameterTypeDirectionDescription
param1TEXTINvalue1
param2TEXTINvalue2
The parameters defined above will generate the following request payload: ``` param1=value1¶m2=value2 ``` **JSON request payload encoded into a key name** The following parameters are used to build a JSON payload encoded into a key name:
ParameterTypeDirectionDescription
ParameterTypeDirectionDescription
param1TEXTINvalue1
param2TEXTINvalue2
APP_REQUEST_CONTENT_PAYLOAD_NAMETEXTINpayload
The parameters defined above will generate the following request payload: ``` payload: { param1: "value1", "param2": "value2" } ``` {% hint style="info" %} The `APP_REQUEST_CONTENT_PAYLOAD_NAME` parameter is only supported with the `application/x-www-form-urlencoded` request content type. {% endhint %} #### JSON request payload The following examples show how to build a request payload with `application/json` as content type. **Standard JSON request payload** The following parameters are used to build a simple JSON request payload:
ParameterTypeDirectionValue
ParameterTypeDirectionValue
person.address.streetTEXTIN160 Guy Street
person.address.zipcodeTEXTINJ4G 1U4
person.ageTEXTIN30
person.nameTEXTINJohn
The parameters defined above will generate the following request payload: ```json { "person": { "address": { "street": "160 Guy Street", "zipcode": "J4G 1U4" }, "age": 30, "name": "John" } } ``` If you want to convert this JSON into an array, you have to set the `APP_REQUEST_CONTENT_IS_ARRAY` parameter value to `Y`.
ParameterTypeDirectionDescription
ParameterTypeDirectionDescription
APP_REQUEST_CONTENT_IS_ARRAYTEXTIN

When set to Y, the application will convert the JSON request payload into an array; the default is N

Only supported when building JSON request payload with IN parameters.

Setting the `APP_REQUEST_CONTENT_IS_ARRAY` parameter to `Y` will generate the following request payload: ```json [{ "person": { "address": { "street": "160 Guy Street", "zipcode": "J4G 1U4" }, "age": 30, "name": "John" } }] ``` To see how to build more complex JSON, see [Setting a JSON array into a JSON property](#setting-a-json-array-into-a-json-property) and [Setting a JSON object/array into a JSON property using the `__JSON` suffix parameter](#setting-a-json-object-array-into-a-json-property-using-the-__json-suffix-parameter) sections below. #### **Setting a JSON array into a JSON property** To set an array into a JSON property, you have to define the property path (e.g. `person.spokenlanguages`) followed by the `__X` suffix, where `X` is the array index number. The following parameters are used to set a JSON array into a JSON property:
ParameterTypeDirectionValue
ParameterTypeDirectionValue
person.spokenlanguages__0TEXTINfrench
person.spokenlanguages__1TEXTINenglish
person.spokenlanguages__2TEXTINchinese
The parameters defined above will generate the following request payload: ```json { "person": { "spokenlanguages": ["french", "english", "chinese"] } } ``` If you want to set a JSON array of JSON objects (e.g. `"spokenlanguages": [{"spokenlanguage":"french"}, {"spokenlanguage":"english"}]`) into a JSON property, see the next section. {% hint style="warning" %} * The array parameters will be ordered depending on their index number.
* Index numbers have no limit (e.g. `person.spokenlanguages__9999`).
* A correct index sequence is not mandatory (e.g. `person.spokenlanguages__90`, `person.spokenlanguages__30`). The `__30` parameter value will be the first array parameter, and `__90` the second one.
* An exception will be thrown if there is more than one JSON property specified in the IN parameters (e.g. `person.spokenlanguages` and `person.spokenlanguages__0`).
* The `__X` suffix uses **two** underscore characters.
* The parameter value can only be a text value. {% endhint %} #### **Setting a JSON object/array into a JSON property using the `__JSON` suffix parameter** To set a JSON object/array into a JSON property, you have to define the property path (e.g. `person.children`) followed by the `__JSON` suffix with the JSON object/array as the parameter value. The following parameters are used to set a JSON object/array into a JSON property:
ParameterTypeDirectionValue
ParameterTypeDirectionValue
person.children__JSONTEXTIN[{"name": "child 1"}, {"name": "child 2"}]
The parameters defined above will generate the following request payload: ```json { "person": { "children": [{ "name": "child 1" }, { "name": "child 2" }] } } ``` {% hint style="warning" %} * An exception will be thrown if there is more than one JSON property specified in the IN parameters. (e.g. `person.children` and `person.children__JSON`).
* The `__JSON` suffix uses **two** underscore characters. {% endhint %} ### Response payload The application supports OUT parameters to be mapped with the HTTP response:
ParameterTypeDirectionDescription
ParameterTypeDirectionDescription
APP_RESPONSE_STATUSTEXT/NUMERICOUTResponse status code
APP_RESPONSE_CONTENT_TYPETEXTOUTResponse content type
APP_RESPONSE_CONTENT_FILEFILEOUT

Response payload saved as a file


Automatically detects binary content types (PDF, images, ZIP, etc.) and saves them correctly without corruption. Text content types (JSON, XML, HTML) are saved as UTF-8 text.

APP_RESPONSE_CONTENT_FILENAMETEXTINOptional. Specifies a custom filename for the APP_RESPONSE_CONTENT_FILE output. If not specified, the filename is determined from the Content-Disposition header or defaults to response.[extension] based on content type.
APP_RESPONSE_CONTENTTEXTOUTResponse payload or error message
APP_RESPONSE_CONTENT_IS_ARRAYTEXTOUT

Returns Y if the JSON payload is an array

Only supported for application/json content type responses.

### **Binary vs text content types** `APP_RESPONSE_CONTENT_FILE` automatically detects the content type and uses the appropriate save method: #### **Text content types (saved as UTF-8 text)** * `text/*` (text/plain, text/html, text/csv, text/xml, etc.) * `application/json`, `application/ld+json` * `application/xml`, `application/xhtml+xml` * `application/javascript` * `application/yaml`, `application/toml` * `application/sql`, `application/graphql` #### **Binary content types (saved as raw bytes)** * `application/pdf` * `application/octet-stream` * `application/zip`, `application/gzip`, `application/x-tar` * `application/vnd.*` (Microsoft 365 documents: `docx`, `xlsx`, `pptx`) * `image/*` (`jpeg`, `png`, `gif`, `webp`, etc.) * `audio/*` (`mp3`, `wav`, `ogg`, etc.) * `video/*` (`mp4`, `webm`, `mov`, etc.) #### **Filename resolution** The filename for `APP_RESPONSE_CONTENT_FILE` is determined in this priority order: 1. **`Content-Disposition` header**: If the API returns `Content-Disposition: attachment; filename="report.pdf"`, that filename is used. 2. **`APP_RESPONSE_CONTENT_FILENAME` parameter**: If specified by the user. 3. **Fallback:** `response.[extension]`, where `extension` is derived from the content type (e.g. `response.pdf` for `application/pdf`; `response.bin` for `application/octet-stream`). **📌 Example: Download file from OpenAI** | Parameter | Type | Direction | Value | | --------------------------- | ---- | --------- | --------------------------------------------------- | | `APP_URL` | TEXT | IN | `https://api.openai.com/v1/files/{file_id}/content` | | `APP_URL_file_id` | TEXT | IN | `file-abc123` | | `APP_METHOD` | TEXT | IN | `GET` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | `sk-xxx` | | `APP_RESPONSE_CONTENT_FILE` | FILE | OUT | `DATA_DOWNLOADED_FILE` | {% hint style="info" %} OpenAI only allows downloading files with `purpose: batch` or `purpose: fine-tune`. Files with `purpose: assistants` or `purpose: user_data` cannot be downloaded via the `/content` endpoint. {% endhint %} **📌 Example: Download file from Mistral (with custom filename)** | Parameter | Type | Direction | Value | | ------------------------------- | ---- | --------- | --------------------------------------------------- | | `APP_URL` | TEXT | IN | `https://api.mistral.ai/v1/files/{file_id}/content` | | `APP_URL_file_id` | TEXT | IN | File ID | | `APP_METHOD` | TEXT | IN | `GET` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | Mistral API key | | `APP_RESPONSE_CONTENT_FILENAME` | TEXT | IN | `my_document.pdf` | | `APP_RESPONSE_CONTENT_FILE` | FILE | OUT | `DATA_DOWNLOADED_FILE` | {% hint style="warning" %} Mistral's `/content` endpoint returns `application/octet-stream` without a `Content-Disposition` header. You **must** specify `APP_RESPONSE_CONTENT_FILENAME` to get the correct filename and extension. Without it, the file will be saved as `response.bin`. {% endhint %} #### Mapping a JSON response payload with OUT parameters The application also supports additional custom OUT parameters to map simple JSON response payloads. 📌 **Example** JSON response payload: ```json { "person": { "address": { "street": "160 Guy Street", "zipcode": "J4G 1U4" }, "age": 30, "name": "John" } } ``` The following parameters allow you to map the response payload into different process data:
ParameterTypeDirectionRetrieve the value into a data
ParameterTypeDirectionRetrieve the value into a data
person.address.streetTEXTOUTDATA_STREET
person.address.zipcodeTEXTOUTDATA_ZIPCODE
person.ageTEXTOUTDATA_AGE
person.nameTEXTOUTDATA_NAME
For mapping complex JSON, see the next section. #### Mapping a JSON response payload with OUT parameters using JSONPath query language The application supports the JSONPath query language (similar to XPath expressions in XML). This language allows you to retrieve specific data from a JSON. For more details regarding the JSONPath syntax, see . 📌 **Example** JSON response payload: ```json { "person": { "name": "Elizabeth", "age": 85, "dob": "1937-09-23T00:00:00Z", "children": [ { "name": "Charles", "age": 60, "children": [ { "name": "Nathalie", "children": [ { "name": "George", "age": 8 }, { "name": "Charlotte", "age": 10 }, { "name": "Jefferson", "age": 7 } ] }, { "name": "Harry" } ] }, { "name": "Bob", "age": 57, "children": [ { "name": "John" }, { "name": "Mark" } ] } ] } } ``` For example, here we want to get the names of Charles's grandchildren who are older than seven years old, and we also want these names separated by a `|` (using the `APP_JSONPATH_DELIMITER` IN parameter). At the same time, we are also getting Elizabeth's age and date of birth. To get the information, the following parameters must be defined:
ParameterTypeDirectionIN ValueOUT Value
APP_JSONPATH_DELIMITERTEXTIN|
PARAM1__JSONPATHTEXTINOUTperson.children[?(@.name == 'Charles')].children[*].children[?(@.age > 7)].namedata DATA1_VALUE (value will be: George|Charlotte)
AGE__JSONPATHTEXTIN$.person.age
AGENUMERICOUTdata AGE_VALUE (value will be: 85)
DOB__JSONPATHTEXTIN$.person.dob
DOBDATETIMEOUTdata DOB_VALUE (value will be: 1937-09-23T00:00:00Z)
{% hint style="warning" %} * In the `PARAM1__JSONPATH` parameter name, the `PARAM1` name is not relevant, but it must be followed by the `__JSONPATH` suffix (**two** underscores are used in the suffix).
* To retrieve a value into a **Text** process data, you can use a single INOUT Text parameter (e.g. `PARAM1__JSONPATH` parameter as in the example above).
* To retrieve a value into a **Numeric** or **DateTime** process data, you **must** use separate parameters: an IN Text parameter for the JSONPath query and an OUT parameter that maps to the Numeric or DateTime process data. Both parameters must share the same name prefix (e.g. `AGE__JSONPATH` and `AGE` parameters as in the example above).
* The default value of `APP_JSONPATH_DELIMITER` is a comma (`,`) when this parameter is not defined. {% endhint %} ## Usage example with Azure REST API to obtain an OAuth 2.0 access token and then create an Event Grid topic This example shows how to obtain an access token and use it to create an Event Grid topic. This can be done by creating a process with two actions having RESTAPICLIENT as application. The workflow below illustrates this example:
The next sections describe the parameters that must be declared for each action. ### `GET_TOKEN` action: Obtaining an OAuth 2.0 access token The following parameters are needed to get an access token to use the Azure Resource management API. This token will be stored in the `access_token` OUT parameter and will be used when creating an Event Grid topic in the next section.
ParameterTypeDirectionValue
ParameterTypeDirectionValue
APP_URLTEXTINhttps://login.microsoftonline.com/{tenandId}/oauth2/token
APP_URL_tenantIdTEXTINa6e70c61-fabd-4885-89f7-97121e92db7f
APP_METHODTEXTINPOST
APP_REQUEST_CONTENT_TYPETEXTINapplication/x-www-form-urlencoded
grant_typeTEXTINclient_credentials
client_idTEXTINb7e29e2f-6e2b-4375-9684-8151431d4ca6
client_secretTEXTINlxy/IwKyTedHUWMeeUtyCtu7/YUy0rNGoY3NNWXXotI=
resourceTEXTINhttps://management.core.windows.net/
access_tokenTextOUTDATA_ACCESS_TOKEN
The parameters defined above will generate the following request payload: ```http POST https://login.microsoftonline.com/a6e70c61-fabd-4885-89f7-97121e92db7f/oauth2/token HTTP/1.1 Host: login.microsoftonline.com Content-Type: application/x-www-form-urlencoded grant_type=client_credentials&client_id=b7e29e2f-6e2b-4375-9684-8151431d4ca6&client_secret=lxy/IwKyTedHUWMeeUtyCtu7/YUy0rNGoY3NNWXXotI=&resource=https://management.core.windows.net/ ``` Here's the response from the Azure API: ```json { "token_type":"Bearer", "expires_in":"3600", "ext_expires_in":"3600", "expires_on":"1555951493", "not_before":"1555947593", "resource":"https://management.core.windows.net/", "access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1d..." } ``` {% hint style="info" %} The `access_token` OUT parameter is mapped with the `access_token` JSON property. {% endhint %} For more details about how to get an access token to use the Azure Resource API, see . ### `CREATE_TOPIC` action: Creating an Event Grid topic The following parameters are needed to create an Event Grid topic using the Azure Resource management API.
ParameterTypeDirectionValue
ParameterTypeDirectionValue
APP_URLTEXTINhttps://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}?api-version={api-version}
APP_URL_subscriptionIdTEXTIN235765d9-5d62-43f4-a730-2ed71a3f8adb
APP_URL_resourceGroupNameTEXTINdev-group-advantys
APP_URL_topicNameTEXTINnew-topic-example
APP_URL_api-versionTEXTIN2018-09-15-preview
APP_METHODTEXTINPUT
APP_REQUEST_CONTENT_TYPETEXTINapplication/json
APP_AUTH_BEARER_TOKENTEXTINDATA_ACCESS_TOKEN
locationTEXTINcanadaeast
The parameters defined above will generate the following request payload: ```http PUT https://management.azure.com/subscriptions/235765d9-5d62-43f4-a730-2ed71a3f8adb/resourceGroups/dev-group-advantys/providers/Microsoft.EventGrid/topics/new-topic-example?api-version=2018-09-15-preview Host: management.azure.com Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1d... location: canadaeast ``` Here's the response from the Azure API: ```json { "properties":{ "provisioningState":"Creating", "endpoint":null }, "location":"canadaeast", "tags":null, "id":"/subscriptions/994e2fc0-937d-4110-b355-e7473acef822/resourceGroups/dev-evt-grid/providers/Microsoft.EventGrid/topics/test-from-wfg", "name":"test-from-wfg", "type":"Microsoft.EventGrid/topics" } ``` For more information about how to create an Event Grid topic and the Azure REST API, see . ## Usage example with OpenAI Files API This example shows how to upload a file to OpenAI, list files, download a file, and delete a file using RESTAPICLIENT. ### **`UPLOAD_FILE` action: Uploading a file** | Parameter | Type | Direction | Value | | -------------------------- | ------- | --------- | --------------------------------- | | `APP_URL` | TEXT | IN | `https://api.openai.com/v1/files` | | `APP_METHOD` | TEXT | IN | `POST` | | `APP_REQUEST_CONTENT_TYPE` | TEXT | IN | `multipart/form-data` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | API key | | `APP_FORMFILE_file` | FILE | IN | File to upload | | `APP_FORMDATA_purpose` | TEXT | IN | `batch` | | `APP_RESPONSE_STATUS` | NUMERIC | OUT | `DATA_STATUS` | | `id` | TEXT | OUT | `DATA_FILE_ID` | | `filename` | TEXT | OUT | `DATA_FILENAME` | Here's the response from the OpenAI API: ```json { "id": "file-abc123", "object": "file", "bytes": 120000, "created_at": 1677610602, "filename": "myfile.jsonl", "purpose": "batch" } ``` ### **`LIST_FILES` action: Listing uploaded files** | Parameter | Type | Direction | Value | | ----------------------- | ------- | --------- | --------------------------------- | | `APP_URL` | TEXT | IN | `https://api.openai.com/v1/files` | | `APP_METHOD` | TEXT | IN | `GET` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | API key | | `APP_RESPONSE_STATUS` | NUMERIC | OUT | `DATA_STATUS` | | `APP_RESPONSE_CONTENT` | TEXT | OUT | `DATA_RESPONSE` | | `object` | TEXT | OUT | `DATA_OBJECT` | ### **`DOWNLOAD_FILE` action: Downloading file content** | Parameter | Type | Direction | Value | | --------------------------- | ---- | --------- | --------------------------------------------------- | | `APP_URL` | TEXT | IN | `https://api.openai.com/v1/files/{file_id}/content` | | `APP_URL_file_id` | TEXT | IN | `DATA_FILE_ID` | | `APP_METHOD` | TEXT | IN | `GET` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | API key | | `APP_RESPONSE_CONTENT_FILE` | FILE | OUT | `DATA_DOWNLOADED_FILE` | {% hint style="info" %} Only files with `purpose: batch` or `purpose: fine-tune` can be downloaded. Files with `purpose: assistants` or `purpose: user_data` will return a `400` error. {% endhint %} ### **`DELETE_FILE` action: Deleting a file** | Parameter | Type | Direction | Value | | ----------------------- | ------- | --------- | ------------------------------------------- | | `APP_URL` | TEXT | IN | `https://api.openai.com/v1/files/{file_id}` | | `APP_URL_file_id` | TEXT | IN | `DATA_FILE_ID` | | `APP_METHOD` | TEXT | IN | `DELETE` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | API key | | `APP_RESPONSE_STATUS` | NUMERIC | OUT | `DATA_STATUS` | | `id` | TEXT | OUT | `DATA_FILE_ID` | | `deleted` | TEXT | OUT | `DATA_DELETED` | ### Usage example with Mistral Files API This example shows how to upload a file to Mistral for OCR, get a signed download URL, download the file, and delete it. ### **`UPLOAD_FILE` action: Uploading a file for OCR** | Parameter | Type | Direction | Value | | -------------------------- | ------- | --------- | --------------------------------- | | `APP_URL` | TEXT | IN | `https://api.mistral.ai/v1/files` | | `APP_METHOD` | TEXT | IN | `POST` | | `APP_REQUEST_CONTENT_TYPE` | TEXT | IN | `multipart/form-data` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | API key | | `APP_FORMFILE_file` | FILE | IN | PDF or image file | | `APP_FORMDATA_purpose` | TEXT | IN | `ocr` | | `APP_RESPONSE_STATUS` | NUMERIC | OUT | `DATA_STATUS` | | `id` | TEXT | OUT | `DATA_FILE_ID` | | `filename` | TEXT | OUT | `DATA_FILENAME` | {% hint style="info" %} Mistral OCR supports PDF, images, Word (`.docx`), PowerPoint (`.pptx`), and EPUB files. HTML is not supported. {% endhint %} ### **`RETRIEVE_FILE` action: Getting file metadata** | Parameter | Type | Direction | Value | | ----------------------- | ---- | --------- | ------------------------------------------- | | `APP_URL` | TEXT | IN | `https://api.mistral.ai/v1/files/{file_id}` | | `APP_URL_file_id` | TEXT | IN | `DATA_FILE_ID` | | `APP_METHOD` | TEXT | IN | `GET` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | API key | | `filename` | TEXT | OUT | `DATA_FILENAME` | | `purpose` | TEXT | OUT | `DATA_PURPOSE` | ### **`GET_SIGNED_URL` action: Getting a signed download URL** Get a temporary signed URL for downloading the file. This is useful for sharing or delayed downloads. | Parameter | Type | Direction | Value | | ----------------------- | ------- | --------- | ----------------------------------------------- | | `APP_URL` | TEXT | IN | `https://api.mistral.ai/v1/files/{file_id}/url` | | `APP_URL_file_id` | TEXT | IN | `DATA_FILE_ID` | | `APP_METHOD` | TEXT | IN | `GET` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | API key | | `APP_RESPONSE_STATUS` | NUMERIC | OUT | `DATA_STATUS` | | `url` | TEXT | OUT | `DATA_SIGNED_URL` | Here's the response from the Mistral API: ```json { "url": "https://mistralaifilesapiprodswe.blob.core.windows.net/fine-tune/.../file.pdf?se=2026-01-10T22%3A00%3A00Z&sp=r&sv=2025-01-05&sr=b&sig=..." } ``` {% hint style="info" %} The signed URL expires after 24 hours by default. Add `?expiry=48` to the request URL for a custom expiry (in hours). {% endhint %} ### **`DOWNLOAD_FILE` action: Downloading file content directly** | Parameter | Type | Direction | Value | | ------------------------------- | ---- | --------- | --------------------------------------------------- | | `APP_URL` | TEXT | IN | `https://api.mistral.ai/v1/files/{file_id}/content` | | `APP_URL_file_id` | TEXT | IN | `DATA_FILE_ID` | | `APP_METHOD` | TEXT | IN | `GET` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | API key | | `APP_RESPONSE_CONTENT_FILENAME` | TEXT | IN | `DATA_FILENAME` | | `APP_RESPONSE_CONTENT_FILE` | FILE | OUT | `DATA_DOWNLOADED_FILE` | {% hint style="warning" %} You must specify `APP_RESPONSE_CONTENT_FILENAME` when downloading from Mistral. The API returns `application/octet-stream` without a filename. Use the `filename` from the retrieve/upload response, or specify your own (e.g. `document.pdf`). {% endhint %} ### **`DELETE_FILE` action: Deleting a file** | Parameter | Type | Direction | Value | | ----------------------- | ------- | --------- | ------------------------------------------- | | `APP_URL` | TEXT | IN | `https://api.mistral.ai/v1/files/{file_id}` | | `APP_URL_file_id` | TEXT | IN | `DATA_FILE_ID` | | `APP_METHOD` | TEXT | IN | `DELETE` | | `APP_AUTH_BEARER_TOKEN` | TEXT | IN | API key | | `APP_RESPONSE_STATUS` | NUMERIC | OUT | `DATA_STATUS` | | `id` | TEXT | OUT | `DATA_FILE_ID` | | `deleted` | TEXT | OUT | `DATA_DELETED` | ## Enabling SSL/TLS In case of a `Could not create SSL/TLS secure channel` error, strong encryption must be enabled by executing the following code in PowerShell: ```csharp Set-ItemProperty -Path 'HKLM:\SOFTWARE\Wow6432Node\Microsoft\.NetFramework\v4.0.30319' -Name 'SchUseStrongCrypto' -Value '1' -Type DWord Set-ItemProperty -Path 'HKLM:\SOFTWARE\Microsoft\.NetFramework\v4.0.30319' -Name 'SchUseStrongCrypto' -Value '1' -Type DWo ``` {% hint style="warning" %} Restart your IIS server after executing the commands. {% endhint %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.workflowgen.com/admin/workflow-applications/restapiclient-workflow-application.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.