Task Lists (Workflow Templates) – RealCADENCE™ by VoloForce

POST /actionlists Create a new list
PUT /actionlists/{task_list_id} Update an existing list
GET /actionlists/taskList/ Read an existing list detail.
GET /actionlists/{task_list_id} Create a new task in a task list
DELETE /actionlists/{task_list_id} Delete a task list
GET /actionlists/tasksById (Admin-only) Get tasks by task IDs CSV

Task Lists

POST /actionlists

Create a new Task List

Example	curl 'https://myhostname/actionlists' \ -H 'X-Auth-Token: {token}' \ -H 'X-Auth-User: {username}' \ -H 'Content-Type: application/x-www-form-urlencoded;charset=UTF-8' \ --data-raw 'url-encoded-params' \
title	Task List title
html_description	Plain-text description / instructions for the task-list
listTypeId	Task list Type ID
folderId	Task list folder ID
images	Array with 4 entries: `fullsize_id` : DAID for the full-size task list image `fullsize_url` : URL for the full-size task list image `thumb_id` : DAID for the task list image thumbnail `thumb_url` : URL for the full-size task list image thumbnail Example: images[fullsize_id]: 99999991 images[fullsize_url]: https://imagehost/1623701137.5118_1041.jpg.fullsize.jpg images[thumb_id]: 99999992 images[thumb_url]: https://imagehost/1623701137.5118_1041.jpg.thumbnail.jpg
qualifiedReceiverGroupIdsCsv	CSV of User-Role-Group-IDs permitted to complete the tasks in this task list
qualifiedSenderGroupIdsCsv (required for `Survey On-Demand` and `Actions On-Demand` list types)	CSV of User-Role-Group-IDs permitted to assign the task list
qualifiedSignoffGroupIdsCsv (optional)	CSV of User-Role-Group-IDs qualified to signoff the tasks in this task list
qualifiedRrHandoffReporterGroupsCsv (required for `Service On-Demand` task lists)	CSV of User-Role-Group-IDs permitted to assign the task list
assignForExecutionBeforeReview (optional)	Should be set to ‘true’ when creating a Q.S.Q.R. Service On Demand template.
templateDurationDays (Required for non-scheduled task list types) templateDurationHours (Required for non-scheduled task list types)	When the task list is assigned, the Due-time = Publish Time + templateDurationDays + templateDurationHours
Output	{ "id": "6661", "title": "New Patient Onboarding", "html_description": "New Patient Onboarding Pre-defined tasks list", "status": "ACTIVE", "timestamp_row_added": "2022-03-02 07:30:35", "modified_datetime": "2022-03-02 07:30:35", "author_id": "31", "type_id": "1", "duration_days": null, "duration_hours": null, "folder_id": "1561", "qty_tasks": "0", "image_full": "https:\/\/0a60a44099492299f6fa-33eb74d6f9c1f37db0e9ee11e80ac304.ssl.cf2.rackcdn.com\/1623701137.5118_1041.jpg.fullsize.jpg", "image_full_daid": "99999991", "image_thumb": "https:\/\/0a60a44099492299f6fa-33eb74d6f9c1f37db0e9ee11e80ac304.ssl.cf2.rackcdn.com\/1623701137.5118_1041.jpg.thumbnail.jpg", "image_thumb_daid": "99999992", "nextDueDateTime": null, "dueDateTime": null, "scheduleStatus": "UNSCHEDULED", "requiresHandoffToQualifiedExecutors": false, "qualification_groups": { "receiverGroups": [ { "id": "11", "name": "Admins" } ], "senderGroups": [], "rrHandoffReporterGroups": [] }, "signoffGroups": [] }

PUT /actionlists/{task_list_id}

Update a Task List

Example	curl 'https://myhostname/actionlists/6671' \ -X 'PUT' \ -H 'X-Auth-Token: {token}' \ -H 'X-Auth-User: {username}' \ -H 'Content-Type: application/x-www-form-urlencoded;charset=UTF-8' \ --data-raw 'url-encoded-params' \
title	Task List title
html_description	Plain-text description / instructions for the task-list
listTypeId	Task list Type ID
folderId	Task list folder ID
images	Array with 4 entries: `fullsize_id` : DAID for the full-size task list image `fullsize_url` : URL for the full-size task list image `thumb_id` : DAID for the task list image thumbnail `thumb_url` : URL for the full-size task list image thumbnail Example: images[fullsize_id]: 99999991 images[fullsize_url]: https://imagehost/1623701137.5118_1041.jpg.fullsize.jpg images[thumb_id]: 99999992 images[thumb_url]: https://imagehost/1623701137.5118_1041.jpg.thumbnail.jpg
qualifiedReceiverGroupIdsCsv	CSV of User-Role-Group-IDs permitted to complete the tasks in this task list
qualifiedSenderGroupIdsCsv (required for `Survey On-Demand` and `Actions On-Demand` list types)	CSV of User-Role-Group-IDs permitted to assign this task list
qualifiedSignoffGroupIdsCsv (optional)	CSV of User-Role-Group-IDs qualified to signoff the tasks in this task list
qualifiedRrHandoffReporterGroupsCsv (required for `Service On-Demand` task lists)	CSV of User-Role-Group-IDs permitted to assign the task list
assignForExecutionBeforeReview (optional)	Should be set to ‘true’ when creating a Q.S.Q.R. Service On Demand template.
templateDurationDays (Required for non-scheduled task list types) templateDurationHours (Required for non-scheduled task list types)	When the task list is assigned, the Due-time = Publish Time + templateDurationDays + templateDurationHours
Output	{ "id": "6681", "title": "New Patient Onboarding", "html_description": "AOD for new patient onboarding", "status": "ACTIVE", "timestamp_row_added": "2022-03-02 12:37:05", "modified_datetime": "2022-03-02 12:37:05", "author_id": "31", "type_id": "111", "duration_days": "5", "duration_hours": "4", "folder_id": "1561", "qty_tasks": "0", "image_full": "https:\/\/0a60a44099492299f6fa-33eb74d6f9c1f37db0e9ee11e80ac304.ssl.cf2.rackcdn.com\/1623701137.5118_1041.jpg.fullsize.jpg", "image_full_daid": "99999991", "image_thumb": "https:\/\/0a60a44099492299f6fa-33eb74d6f9c1f37db0e9ee11e80ac304.ssl.cf2.rackcdn.com\/1623701137.5118_1041.jpg.thumbnail.jpg", "image_thumb_daid": "99999992", "nextDueDateTime": null, "dueDateTime": null, "scheduleStatus": "UNSCHEDULED", "requiresHandoffToQualifiedExecutors": true, "qualification_groups": { "receiverGroups": [ { "id": "11", "name": "Admins" }, { "id": "1161", "name": "Banking Sector" } ], "senderGroups": [], "rrHandoffReporterGroups": [ { "id": "11", "name": "Admins" }, { "id": "1161", "name": "Banking Sector" } ] }, "signoffGroups": [] }

GET /actionlist/taskList/

Get a paginated array of task lists

Example	curl 'https://myhostname/actionlist/taskList/?offset=0&limit=51&orderBy=id&orderType=DESC&scheduleFilter=ALL&fetchInProgressStatus=true' \ -H 'X-Auth-Token: {token}' \ -H 'X-Auth-User: {username}' \
offset (optional)	Pagination offset
limit (optional)	Page size
orderBy (optional)	Permitted values `id` : Task list id `list_name` : Task list name
orderType (optional)	Permitted values `ASC` : Ascending `DESC` : Descending
searchTerm (optional)	If numeric, a task list with ID exactly matching the search time is returned If not numeric, all task lists with list names partially matching the search term are return
folderId (optional)	Get task lists from the specified task list folder
fetchInProgressStatus (optional)	If set to `true`, each record will have a `is_in_progress` field set to `true` or `false`
scheduleFilter (optional)	Permitted values: `SCHEDULED` : Only return task lists with at least one instance in progress at present `UNSCHEDULED` : Only return task lists with no instance in progress at present `ALL` : This filter won’t be applied
Output	{ "checksum": "5bff82087e692cb4ae36ae60e5fbc85b", "sizeof": 676, "status": 200, "msg": "", "data": [ { "id": "6121", "list_name": "Material Loading", "html_description": "Check if material is loaded correctly", "status": "ACTIVE", "modified_datetime": "2021-06-16 06:07:43", "author_id": "5091", "qtyInstances": "0", "type_id": "1", "folder_id": "1141", "folder_name": "Test_4474_Two", "images": [], "qty_tasks": 1, "is_in_progress": false }, { "id": "6111", "list_name": "Material unloading", "html_description": "Check if material is unloaded properly and shifted to desired section inside the store", "status": "ACTIVE", "modified_datetime": "2021-06-16 04:32:35", "author_id": "5091", "qtyInstances": "0", "type_id": "1", "folder_id": "1131", "folder_name": "Test_4474", "images": [], "qty_tasks": 1, "is_in_progress": false } ], "timestamp": 1646227177, "datetime": "2022-03-02 13:19:37" }

GET /actionlists/{task_list_id}

Get the task list by ID

Example	curl 'https://myhostname/actionlists/6681?username=uname123&token=123123123123&includeTaskCount=false&includeDigitalAssets=true&includeQualificationGroups=true'
includeTaskCount (optional)	Set to `true` to include `qty_tasks` in the payload. This field contains the count of actionable tasks in the task list, if requested.
includeDigitalAssets (optional)	If `true`, the following fields are added to the response image_full image_full_daid image_thumb image_thumb_daid Example: "image_full": "https:\/\/imgserver\/1623701137.5118_1041.jpg.fullsize.jpg", "image_full_daid": "99999991", "image_thumb": "https:\/\/imgserver\/1623701137.5118_1041.jpg.thumbnail.jpg", "image_thumb_daid": "99999992",
includeQualificationGroups (optional)	If set to `true` the following fields are included in the repsonse: `qualification_groups` `signoffGroups` Example: "qualification_groups": { "receiverGroups": [ { "id": "11", "name": "Admins" }, { "id": "1161", "name": "Banking Sector" } ], "senderGroups": [], "rrHandoffReporterGroups": [ { "id": "11", "name": "Admins" }, { "id": "1161", "name": "Banking Sector" } ] }, "signoffGroups": [ { "task_list_id": "6681", "group_id": "31", "datetime_created": "2022-03-02 15:27:59", "group_name": "DM", "list_name": "New Patient Onboarding" } ]
Output	{ "id": "6681", "title": "New Patient Onboarding", "html_description": "AOD for new patient onboarding", "status": "ACTIVE", "timestamp_row_added": "2022-03-02 12:37:05", "modified_datetime": "2022-03-02 15:27:59", "author_id": "31", "type_id": "111", "duration_days": "5", "duration_hours": "4", "folder_id": "1561", "image_full": "https:\/\/imgserver\/1623701137.5118_1041.jpg.fullsize.jpg", "image_full_daid": "99999991", "image_thumb": "https:\/\/imgserver\/1623701137.5118_1041.jpg.thumbnail.jpg", "image_thumb_daid": "99999992", "requiresHandoffToQualifiedExecutors": true, "qualification_groups": { "receiverGroups": [ { "id": "11", "name": "Admins" }, { "id": "1161", "name": "Banking Sector" } ], "senderGroups": [], "rrHandoffReporterGroups": [ { "id": "11", "name": "Admins" }, { "id": "1161", "name": "Banking Sector" } ] }, "signoffGroups": [ { "task_list_id": "6681", "group_id": "31", "datetime_created": "2022-03-02 15:27:59", "group_name": "DM", "list_name": "New Patient Onboarding" } ] }

DELETE /actionlists/{task_list_id}

Delete a task list

Example

curl 'https://host/actionlists/6681' \
  -X 'DELETE' \
  -H 'X-Auth-Token: {token}' \
  -H 'X-Auth-User: {username}'

Output

{
  "id": "6681",
  "list_name": "New Patient Onboarding SOD",
  "start_datetime": null,
  "due_datetime": null,
  "expire_datetime": null,
  "type_id": "111",
  "digital_asset_id": null,
  "html_description": "AOD for new patient onboarding",
  "format_id": null,
  "region_id": null,
  "author_id": "31",
  "org_id": "1",
  "status": "INACTIVE",
  "publish_datetime": null,
  "publish_timezone": null,
  "schedule_type": null,
  "enable_traffic_counting": null,
  "enable_time_based_scheduling": null,
  "modified_datetime": "2022-03-02 16:41:01",
  "non_parent_action_count": null,
  "visibility": "GLOBAL",
  "folder_id": "1561",
  "is_qsqr_rr_template": "1"
}

GET /actionlists/tasksById

(Admin-only) Get tasks by task IDs CSV

Also check: GET /actionlists/actionsById

Example

curl 'https://hostname/actionlist/tasksById?taskIdsCsv=1234%2C5678%2C8976' \
  -X 'GET' \
  -H 'X-Auth-Token: {token}' \
  -H 'X-Auth-User: {username}'

taskIdsCsv

CSV of Task Ids (max permitted count per call is restricted based on service quota)

Output

{
  "checksum": "6a61cceb852ae72a1e1470b73b18557a",
  "sizeof": 2327,
  "status": 200,
  "msg": "",
  "data": {
    "48101": {
      "task": {
        "collect_addnl_inputs": "CAI_NEVER",
        "digital_asset_id": 15874491,
        "expected_duration": "0",
        "html_description": "Test",
        "id": 48101,
        "is_auto_accepted": "0",
        "lit_id": "",
        "max_score": "1",
        "name": "Evidence Collection (Input Action) 1",
        "orig_task_id": null,
        "parent_task_id": 0,
        "parent_task_sort_order": 0,
        "previous_task_id": null,
        "required_input": "",
        "status": "ACTIVE",
        "task_list_id": 3621,
        "task_sort_order": 2,
        "task_type_id": 6,
        "tpr_trigger": "IF_NO"
      },
      "task_requirements": [
        {
          "id": "56631",
          "task_id": "48101",
          "requirement_type": "NUMERIC",
          "required_input": "",
          "required_input_comparison_type": "ANY",
          "context_msg": "ABCD",
          "timestamp_row_created": "2021-03-10 06:15:10"
        },
        {
          "id": "56641",
          "task_id": "48101",
          "requirement_type": "TEXTUAL",
          "required_input": "",
          "required_input_comparison_type": "ANY",
          "context_msg": "Test",
          "timestamp_row_created": "2021-03-10 06:15:10"
        }
      ],
      "images": {
        "fullsize_daid": 15874491,
        "fullsize_url": "https:\/\/imgserver\/tmpupload\/1_1646892910.199_3631.jpg.fullsize.jpg",
        "cdn_id": "1",
        "thumbnail_daid": "15874501",
        "thumbnail_url": "https:\/\/imgserver\/tmpupload\/1_1646892910.199_3631.jpg.thumbnail.jpg"
      },
      "sections": [],
      "external_integrations": [],
      "task_sort_order": 2,
      "parent_task_sort_order": 0,
      "attachments": []
    },
    "48081": {
      "task": {
        "collect_addnl_inputs": "CAI_NEVER",
        "digital_asset_id": 15860581,
        "expected_duration": "0",
        "html_description": "test",
        "id": 48081,
        "is_auto_accepted": "0",
        "lit_id": "",
        "max_score": "1",
        "name": "Class 1",
        "orig_task_id": 48061,
        "parent_task_id": 0,
        "parent_task_sort_order": 0,
        "previous_task_id": "48061",
        "required_input": "",
        "status": "ACTIVE",
        "task_list_id": 3611,
        "task_sort_order": 1,
        "task_type_id": 6,
        "tpr_trigger": "IF_NO"
      },
      "task_requirements": [
        {
          "id": "56601",
          "task_id": "48081",
          "requirement_type": "DOC_FILE",
          "required_input": "",
          "required_input_comparison_type": "ANY",
          "context_msg": "test",
          "timestamp_row_created": "2021-02-20 10:11:29"
        }
      ],
      "images": {
        "fullsize_daid": 15860581,
        "fullsize_url": "https:\/\/imgserver\/1622219370.55_31.jpg.fullsize.jpg",
        "cdn_id": "2",
        "thumbnail_daid": "15860591",
        "thumbnail_url": "https:\/\/imgserver\/1622219370.55_31.jpg.thumbnail.jpg"
      },
      "sections": [],
      "external_integrations": [],
      "task_sort_order": 1,
      "parent_task_sort_order": 0,
      "attachments": []
    }
  },
  "timestamp": 1648661993,
  "datetime": "2021-02-20 17:39:53"
}