API tasks allow you to execute a Workflow task list by passing a user-defined json.
You can create API tasks based on the available item types. You can create API tasks based on the available item types. The only available item types for API tasks are Documents and Workview Objects
To create a new API task:
-
Right-click an item type, select
New
,
and then select API Task.
The Create API Task window is displayed.
- Enter the name of the API task and select the item types the API Task will execute on from the drop-down list.
-
Click Next.
The What user groups do you want to have access to the API Task? page is displayed.
-
In the What user groups do you want to have access to the API
Task? page, click Add to
add
the user groups.
The User Groups window is displayed.
-
Select a user group and click OK.
Note: You can add multiple user groups.
-
Click
Next.
The How should the API Task find items? page is displayed.
-
Select Portfolio Relation from the drop-down list to
find the work items to execute the API tasks on the On
Found task list.
Note: If the portfolio relation does not find any work item to execute upon, then a new document can be created automatically for Document Types with a File Type of Virtual E-Form. When using WorkView Objects as the item type, specify the WorkView application and the corresponding WorkView Class that is created.
-
Click Next.
The Which Workflow properties should be set from the API Task JSON? page is displayed.
-
To set the Workflow properties from the API Task JSON, specify a JSON path and
a property name:
-
In the Which Workflow properties should be set from the API
Task JSON? page, click Add.
The OnBase Studio window is dispayled.
- Enter the JSON path and the property name in the respective fields and click OK.
Note: Properties are created as arrays when generated from a JSON path. -
In the Which Workflow properties should be set from the API
Task JSON? page, click Add.
-
Click
Next
and then
click
Finish.
A new API Task is created and is displayed in the Properties pane.