Function | Description |
|---|
/onelistserver/api/datasync/SyncTasks
| This API synchronises OneList tasks with source workflow tasks. The ActiveTasks array contains new or updated task detail. OneList reads this array to add or update the tasks to its task cache; The supported task actions must be defined in the EnabledActions field. every action:The value of each action, specify the type of action in the ActionType field: Action - the action is a task level action, i.e. an action button is created for the whole task. LineAction - the action is a line-level action. It Actions of this type can be selected bound to a Section in the OneList Task Configurator for binding with the line (a Section) requiring line-level actions. ForwardTask - the action is to forward the task to a different user. OneList ensures a forwarded user is selected when executing this action.
The value of For each task level action, specify the ApplyLineAction field (only applicable for Action type):
The TaskDetail field is mandatory and it must be assigned the full detail of the task (JSON). It can contain hierarchical data structures and there is no limit to the number of levels of hierarchy. This is the source data for the OneList task engine to layout the task for presentation. The meta data of the task attachments should be included in the Attachments field. The attachment files are posted to OneList separately using the /onelistserver/api/datasync/SyncAttachments API. If the HasValue field is not set then OneList uses the TaskDetail field to calculate the hash.
The DeletedTaskId array contains the id of the tasks that are completed by the source workflow. OneList removes these tasks from its task cache;
|
/onelistserver/api/datasync/GetUserSyncRequests
| This API returns the list of user id of the source system users who have outstanding task but are not yet mapped to an OneList user. The source system should call the SyncUsers API to create or update their accounts in OneList so they can view their tasks in OneList. |
/onelistserver/api/datasync/GetActiveUsers
| This API returns the profile of active OneList users. It can be used to compare with source system user information to detect outdated OneList user profile. The UserName field is the source system user id; The OneListUserId field is the OneList user id; The other fields are the current OneList user profile information.
|
/onelistserver/api/datasync/SyncUsers
| This API adds or updates OneList user account with the source system user information. It also creates the user mapping between the OneList user account and the source system user account. The UserName field is the source system user id; The OneListUserId field is optional, if not specified then the UserName is used as the OneList user id; The other fields are used to populate the OneList user profile.
|
/onelistserver/api/datasync/SyncAttachments
| This API synchronises OneList task attachment cache with source system files. The Attachments array contains the current version of the files for the task; The DeletedAttachments array contains the source system document id that is removed from the source system document repository.
|
/onelistserver/api/datasync/GetActionRequests
| This API returns the list of user task actions. The source system should perform the requested task action in the workflow. The UserId is the source system user id who performed the action in OneList; The Task field is the full detail of the task to be actioned; The TaskAction field contains the detail of the task action including user input such as approval comment; The LineActions array is only populated for task supporting line-level action; The Token field may contain the refresh token for source system to impersonate the user.
|
/onelistserver/api/datasync/PostTaskActionOutcome
/onelistserver/api/datasync/PostLineLevalTaskActionOutcome
| Source system calls this API to notify OneList of the requested task action. |
