|
Call REST Function |
Scroll |
|
The Call Rest Function enables Administrators to call an external web services from an automatic workflow task without coding. |
Drop-down List
GET: Retrieves data from a server at the specified resource.
POST: Sends data to the API server to create/update a resource.
PUT: Sends data to the API to update or create a resource. The difference is that PUT requests will always produce the same result.
DELETE: Deletes the resource at the specified resource.
PATCH: Similar to POST and PUT options, but only applies to partial modifications to the resource.
Macros...
Opens a dialog with all available macros.
URL Field
The placeholder for the URL of the Web Service call.
Script
A initialization script can be created, which will be executed before the execution of the field assignments. Also, variables and functions could be defined here that will be available for the assignment scripts.
Test...
Runs a test API call that checks whether a communication can be made to the Web Service and if a response can be achieved. Opens a dialog to demonstrate the outcome of the test.
Parameters
List the parameters required to send/receive.
Add
Add a Parameter.
Remove
Remove a Parameter.
Authorization
Type:
Select the authorization type (i.e. Basic, Bearer Token, OAuth (Authorization Code), OAuth (Client Credentials)).
|
Note: •With OAuth, a client application needs to be created in order for it to be able to integrate. •The OAuth redirect URI is the following one: http://localhost:64957/authorize •The OAuth redirect URI can be customized for special cases using Regkey: HKEY_CURRENT_USER\SOFTWARE\Therefore\Client\OAuthRedirectUrl (STRING) |
Header
List the Headers required to send/receive.
Body
List the JSON Values and Objects.
Insert:
Select either a JSON Object or Value to be listed.
Remove:
Remove a JSON Object/Value.
Load JSON file:
Upload a JSON file into the Body.
Success codes:
List the success codes that the API call should consider to be successful.
Script
A initialization script can be created, which will be executed before the execution of the field assignments. Also, variables and functions could be defined here that will be available for the assignment scripts.
Auto-append Mode
This will set the default append option that users will see.
Category Default
The default setting a user will see when saving documents is: Append to end of existing document.
Disabled
The auto append feature will be disabled.
Insert at beginning of existing document
The new document will be added as the first file in the composite document.
Append to end of existing document
The new document will be added as the last file in the composite document.
Replace existing document
All existing files in the document will be deleted and replaced with the new document.
Category Field/Assignment
Assign mappings of index data fields from one category to another
Load JSON file:
Upload a JSON file into the Body.
|
Note: REST calls were designed for making outgoing calls to 3rd party applications. Although it’s possible to use REST calls to call the Therefore API, to solve advanced requirements, the feature is limited especially when working with index data information. |
