Action assignment APIs are highly configurable and require object identification prior to use. List, Task (Action), Location, Location Group, User and other IDs may be required.
- Actions On-Demand – Get Action Lists
- Actions On-Demand – Assign List to Location
- Service On-Demand – Get Action Lists
- Service Request (Reflection) origination
- Actions on Demand (in Key Based APIs)
- Location Actions
- Location Service requests (reflections)
- GET /actionlist/actionsById (Admin-only) Get assigned actions by action completion IDs CSV
- Action Completion
- Service Request (Reflection) Completion
- Action Note
- Action Delegation
- Un-delegate an action
- Extend the due date-time for actions
- Extend the due date-time for service requests (aka reflections)
- PUT /actionlist/actionJsonContext (Admin-only) Set JSON context for an action completion ID
- My Actions – Location Action Counts
- Task Problem Report
Optional Parameters
For tracking and compliance purposes, Assignment API requests allow for optional arguments to be included with the payload.
| lat | Latitude floating point value. |
| lon | Longitude floating point value. |
| app_name | An identifying name for the app or script requesting the API |
| app_version | An version for the app or script requesting the API |
GET actionlist/onDemandTemplates (Actions On-Demand)
Actions On-Demand – Get Action List.
| Example |
curl --request GET \ --url https://hostname/actionlist/onDemandTemplates?templateTypeId=201 | 241 \ --header 'content-type: application/json' \ --header 'x-auth-token: 555-555-1212' \ --header 'x-auth-user: joe.user' \ |
| templateTypeId | ID of Template Type |
POST actionlist/assignOnDemand (Actions On-Demand)
Actions On-Demand – Assign List to Location.
| Example |
curl --request POST \
--url https://hostname/actionlist/assignOnDemand?templateId=14111&locationId=8101 \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--param '{
"templateId" : "14111",
"locationId" : "8101"
}'
|
| templateTypeId | ID of Template Type |
| locationId | ID of Location |
GET actionlist/onDemandTemplates (Service On-Demand)
Service On-Demand Get Action List.
| Example |
curl --request GET \ --url https://hostname/actionlist/onDemandTemplates?templateTypeId=111 \ --header 'content-type: application/json' \ --header 'x-auth-token: 555-555-1212' \ --header 'x-auth-user: joe.user' \ |
| templateTypeId | ID of Template Type |
POST reflections/upstreamAlert
Generate a Service on Demand action ticket assignment. Requires task being assigned to be a member of an Action List of type “Service on Demand”. Other documentation may refer to this feature as “Upstream Alert” or “Reverse Reflection”.
https:// [host] / reflections / upstreamAlert / [Location ID] / [Task ID]
| Example | Action requires numeric input and a digital asset ID for photo evidence.
curl --request POST \
--url https://hostname/reflections/upstreamAlert/123/456 \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--data '{
"reason_msg" : "Requesting repair on item 987654321-abc",
"numeric_input" : "4321",
"daid" : "1234"
}'
|
| reason_msg | The human readible message indicating the reason for making the request. |
| reason_daid | The human readible message indicating the reason for digital asset ID. |
| confirmation_input | Textual input (‘YES’|’NO’) *if required* as action evidence |
| numeric_input | Numeric input *if required* as action evidence |
| textual_input | Textual input *if required* as action evidence |
| qr_input | Textual input *if required* as action evidence |
| daid | Photo evidence digital asset ID *if required* as action evidence |
| document_hyperlink | Document link/hyperlink *if required* as action evidence |
| document_daid | Document digital asset ID *if required* as action evidence |
GET realcadence/locationTaskTree3
Fetch a dictionary (tree) of Actions assigned to a Location.
https:// [host] / realcadence / locationTaskTree3 / [Location ID]
| Example | Action requires numeric input and a digital asset ID for photo evidence.
curl --request GET \ --url https://hostname/realcadence/locationTaskTree3/12345 \ --header 'content-type: application/json' \ --header 'x-auth-token: 555-555-1212' \ --header 'x-auth-user: joe.user' |
GET reflections/locationReflections
Fetch pending service requests (reflections) for a Location.
https:// [host] / reflections / locationReflections / [Location ID]
| Example |
curl --request GET \ --url https://hostname/reflections/locationReflections/12345 \ --header 'content-type: application/json' \ --header 'x-auth-token: 555-555-1212' \ --header 'x-auth-user: joe.user' |
| Output |
{
"checksum": "71392132f9534396270b51f654089606",
"sizeof": 76907,
"status": 200,
"msg": "",
"data": [
{
"id": "137251",
"requested_by_user_id": "31",
"target_location_id": "5701",
"target_user_id": null,
"original_task_id": "67211",
"original_task_list_id": "6091",
"completion_log_id": "66236191",
"completion_log_type": "PLANOGRAM",
"notes": "Testing",
"status": "OPEN",
"requires_conf": "NO",
"requires_textual": "YES",
"requires_numeric": "YES",
"requires_photo": "NO",
"requires_qr_scan": "NO",
"requires_mcsi": "NO",
"requires_doc_file": "YES",
"requires_doc_link": "NO",
"datetime_due": "2022-04-03 15:38:00",
"timestamp_due": "1649000280",
"datetime_due_server_tz": "2022-04-03 14:38:00",
"timestamp_due_utc": "1648996680",
"datetime_completed": "2022-03-31 14:38:23",
"accepted_by_user_id": null,
"timestamp_row_added": "2022-03-31 14:38:23",
"task_name": "Evidence 001",
"task_list_name": "Banking Sector_QSQR ON",
"template_type_id": "111",
"location_schedule_instance_id": "3855011",
"timezone": "Europe\/London",
"qtyUnreadComments": 0,
"is_reviewer_for_reflection": true,
"is_sender_for_reflection": false,
"attachments": [],
"is_delegated": false,
"workflow_to_show": "ACTION_NEEDS_MGMNT_REVIEW",
"images": {
"fullImage": {
"daid": "15772861",
"url": "https:\/\/0a60a44099492299f6fa-33eb74d6f9c1f37db0e9ee11e80ac304.ssl.cf2.rackcdn.com\/1623657553.1585_2511.jpg.fullsize.jpg",
"asset_type_id": "1",
"filename": "1623657553.1585_2511.jpg.fullsize.jpg",
"cdn_id": "2",
"thumbnail_daid": "15772871",
"type_name": "Image"
},
"thumbnail": {
"daid": "15772871",
"url": "https:\/\/0a60a44099492299f6fa-33eb74d6f9c1f37db0e9ee11e80ac304.ssl.cf2.rackcdn.com\/1623657553.1585_2511.jpg.thumbnail.jpg",
"asset_type_id": "7",
"filename": "1623657553.1585_2511.jpg.thumbnail.jpg",
"cdn_id": "2",
"thumbnail_daid": null,
"type_name": "Image Thumb"
}
},
"reflection_details": {
"action_state": {
"id": 66236191,
"location_id": "5701",
"task_list_id": "6091",
"task_id": "67211",
"queue_id": "74961",
"queue_name": "vfadmin.location_schedule_notifications",
"start_datetime": "2022-03-31 14:38:00",
"due_datetime": "2022-04-03 14:38:00",
"status": "REFLECTION",
"longitude": null,
"latitude": null,
"uuid": null,
"numeric_input": null,
"textual_input": null,
"notes": null,
"ipv4_address": null,
"ipv6_address": null,
"datetime_start": null,
"completed_by_user_id": null,
"complete_datetime": null,
"datetime_last_updated": "2022-03-31 14:38:23",
"accepted_by_user_id": null,
"accepted_datetime": null,
"reflection_reqd_by_user_id": "31",
"reflection_reqd_datetime": "2022-03-31 14:38:23",
"publish_datetime": "2022-03-31 14:38:00",
"fail_reqd_by_user_id": null,
"fail_reqd_datetime": null,
"is_autocadence": "0",
"zone_id": null,
"location_schedule_instance_id": "3855011",
"schedule_type": "ON_DEMAND",
"fk_network_type_id": null,
"device_model": null,
"device_version": null,
"device_name": null,
"device_uiidiom": null,
"system_name": null,
"system_version": null,
"device_battery_level": null,
"app_name": null,
"app_version": null,
"ltz_location_timezone": "Europe\/London",
"ltz_datetime_publish": "2022-03-31 15:38:00",
"ltz_datetime_start": "2022-03-31 15:38:00",
"ltz_datetime_due": "2022-04-03 15:38:00",
"ltz_complete_datetime": null,
"started_by": null,
"list_instance_id": "6091_1649000280",
"ltz_datetime_start_datetime": null,
"ltz_accepted_datetime": null,
"display_status": "REFLECTION",
"due_date_elapsed": false
},
"evidence": [],
"correspondence": [
{
"id": "361771",
"requested_reflections_id": "137251",
"completion_log_id": "66236191",
"message_text": "Please provide an update",
"updated_by_user_id": "31",
"evidence_digital_asset_id": "0",
"evidence_textual": "",
"evidence_numeric": "",
"timestamp_row_added": "2022-03-31 14:38:37",
"longitude": "",
"latitude": "",
"correspondence_type": "MESSAGE",
"status": "ACTIVE",
"reference_url": null,
"evidence_qr_scan": "",
"evidence_confirmation_input": "",
"evidence_distance_metres": "0",
"ltz_timestamp_row_added": "2022-03-31 15:38:37",
"evidence_mcsi_db_id": "0",
"mcsi_other_textual_input": null,
"evidence_doc_daid": "0",
"evidence_doc_link": null,
"severity_id": null,
"reflection_id": "137251",
"is_read_indicator": "444031",
"evidence_url": null,
"evidence_url_filesize": null,
"evidence_url_checksum": null,
"evidence_url_extension": null,
"evidence_doc_daid_url": null,
"evidence_doc_daid_url_filesize": null,
"evidence_doc_daid_url_checksum": null,
"evidence_doc_daid_url_extension": null,
"escalation_tcl_id": null,
"escalation_reflection_id": null,
"updated_by_user": {
"id": 31,
"first_name": "Abc",
"last_name": "Z",
"username": "abcd",
"location_id": "1",
"created_by_user_id": "21",
"status": "ACTIVE",
"email": "[email protected]",
"smstxt_country_code": null,
"smstxt": "",
"single_location_user": "0",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "1",
"tomm_agenda_dispatch_time": "19",
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": "1",
"user_timezone": "Pacific\/Auckland"
},
"is_read": true
},
{
"id": "361761",
"requested_reflections_id": "137251",
"completion_log_id": "66236191",
"message_text": "Please provide an update",
"updated_by_user_id": "31",
"evidence_digital_asset_id": "0",
"evidence_textual": "",
"evidence_numeric": "",
"timestamp_row_added": "2022-03-31 14:38:33",
"longitude": "",
"latitude": "",
"correspondence_type": "MESSAGE",
"status": "ACTIVE",
"reference_url": null,
"evidence_qr_scan": "",
"evidence_confirmation_input": "",
"evidence_distance_metres": "0",
"ltz_timestamp_row_added": "2022-03-31 15:38:33",
"evidence_mcsi_db_id": "0",
"mcsi_other_textual_input": null,
"evidence_doc_daid": "0",
"evidence_doc_link": null,
"severity_id": null,
"reflection_id": "137251",
"is_read_indicator": "444021",
"evidence_url": null,
"evidence_url_filesize": null,
"evidence_url_checksum": null,
"evidence_url_extension": null,
"evidence_doc_daid_url": null,
"evidence_doc_daid_url_filesize": null,
"evidence_doc_daid_url_checksum": null,
"evidence_doc_daid_url_extension": null,
"escalation_tcl_id": null,
"escalation_reflection_id": null,
"updated_by_user": {
"id": 31,
"first_name": "Abc",
"last_name": "Z",
"username": "abcd",
"location_id": "1",
"created_by_user_id": "21",
"status": "ACTIVE",
"email": "[email protected]",
"smstxt_country_code": null,
"smstxt": "",
"single_location_user": "0",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "1",
"tomm_agenda_dispatch_time": "19",
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": "1",
"user_timezone": "Pacific\/Auckland"
},
"is_read": true
}
],
"task": {
"id": "67211",
"task_type_id": "6",
"name": "Evidence 001",
"html_description": "Evidence 001",
"expected_duration": "0",
"lit_id": "",
"required_input": "",
"digital_asset_id": "15772861",
"task_list_id": "6091",
"is_auto_accepted": "0",
"status": "ACTIVE",
"parent_task_id": "0",
"task_sort_order": "1",
"parent_task_sort_order": "0",
"previous_task_id": null,
"max_score": "1",
"tpr_trigger": "IF_NO",
"collect_addnl_inputs": "CAI_NEVER",
"orig_task_id": null,
"requirements": [
{
"id": "90441",
"task_id": "67211",
"requirement_type": "NUMERIC",
"required_input": "",
"required_input_comparison_type": "ANY",
"context_msg": "minimum account balence",
"timestamp_row_created": "2021-06-15 07:27:49"
},
{
"id": "90451",
"task_id": "67211",
"requirement_type": "TEXTUAL",
"required_input": "",
"required_input_comparison_type": "ANY",
"context_msg": "Axis Bank is Private Bank?",
"timestamp_row_created": "2021-06-15 07:27:49"
},
{
"id": "90461",
"task_id": "67211",
"requirement_type": "DOC_FILE",
"required_input": "",
"required_input_comparison_type": "ANY",
"context_msg": "upload the file",
"timestamp_row_created": "2021-06-15 07:27:49"
}
],
"da": {
"67211": {
"fullImage": {
"daid": "15772861",
"url": "https:\/\/0a60a44099492299f6fa-33eb74d6f9c1f37db0e9ee11e80ac304.ssl.cf2.rackcdn.com\/1623657553.1585_2511.jpg.fullsize.jpg",
"asset_type_id": "1",
"filename": "1623657553.1585_2511.jpg.fullsize.jpg",
"cdn_id": "2",
"thumbnail_daid": "15772871",
"type_name": "Image"
},
"thumbnail": {
"daid": "15772871",
"url": "https:\/\/0a60a44099492299f6fa-33eb74d6f9c1f37db0e9ee11e80ac304.ssl.cf2.rackcdn.com\/1623657553.1585_2511.jpg.thumbnail.jpg",
"asset_type_id": "7",
"filename": "1623657553.1585_2511.jpg.thumbnail.jpg",
"cdn_id": "2",
"thumbnail_daid": null,
"type_name": "Image Thumb"
}
}
},
"sections": [],
"sort_order": "1",
"attachments": []
},
"task_list": {
"id": "6091",
"list_name": "Banking Sector_QSQR ON",
"start_datetime": null,
"due_datetime": null,
"expire_datetime": null,
"type_id": "111",
"digital_asset_id": null,
"html_description": "Reserve Bank Of India",
"format_id": null,
"region_id": null,
"author_id": "2511",
"org_id": "1",
"status": "ACTIVE",
"publish_datetime": null,
"publish_timezone": null,
"schedule_type": null,
"enable_traffic_counting": null,
"enable_time_based_scheduling": null,
"modified_datetime": "2022-03-31 14:39:02",
"non_parent_action_count": "10",
"visibility": "GLOBAL",
"folder_id": "1121",
"is_qsqr_rr_template": "1"
},
"reflection": {
"id": "137251",
"requested_by_user_id": "31",
"target_location_id": "5701",
"target_user_id": null,
"original_task_id": "67211",
"original_task_list_id": "6091",
"completion_log_id": "66236191",
"completion_log_type": "PLANOGRAM",
"notes": "Testing",
"status": "OPEN",
"requires_textual": "YES",
"requires_numeric": "YES",
"requires_photo": "NO",
"datetime_due": "2022-04-03 15:38:00",
"datetime_completed": "2022-03-31 15:38:23",
"accepted_by_user_id": null,
"timestamp_row_added": "2022-03-31 15:38:23",
"failed_by_user_id": null,
"failed_datetime": null,
"datetime_last_updated": "2022-03-31 14:38:23",
"reflection_type": "SERVICE_ON_DEMAND_QSQR",
"datetime_due_server_tz": "2022-04-03 14:38:00",
"requires_qr_scan": "NO",
"requires_conf": "NO",
"evidence_by_user_id": "31",
"stz_evidence_added_time": "2022-03-31 14:38:23",
"ltz_evidence_added_time": "2022-03-31 15:38:23",
"reopened_by_user_id": null,
"stz_reopened_time": null,
"ltz_reopened_time": null,
"requires_mcsi": "NO",
"requires_doc_file": "YES",
"requires_doc_link": "NO",
"problem_report_status": null,
"problem_report_status_backpop_datetime": null,
"ltz_datetime_last_updated": "2022-03-31 15:38:23",
"system_datetime_due": "2022-04-03 15:38:00",
"system_datetime_completed": "2022-03-31 14:38:23",
"system_timestamp_row_added": "2022-03-31 14:38:23",
"user_name": "Abcd",
"location_name": "05-04-London",
"location_timezone": "Europe\/London",
"task_list_name": "Banking Sector_QSQR ON",
"task_name": "Evidence 001",
"correspondence": [
{
"id": "361771",
"requested_reflections_id": "137251",
"completion_log_id": "66236191",
"message_text": "Please provide an update",
"updated_by_user_id": "31",
"evidence_digital_asset_id": "0",
"evidence_textual": "",
"evidence_numeric": "",
"timestamp_row_added": "2022-03-31 14:38:37",
"longitude": "",
"latitude": "",
"correspondence_type": "MESSAGE",
"status": "ACTIVE",
"reference_url": null,
"evidence_qr_scan": "",
"evidence_confirmation_input": "",
"evidence_distance_metres": "0",
"ltz_timestamp_row_added": "2022-03-31 15:38:37",
"evidence_mcsi_db_id": "0",
"mcsi_other_textual_input": null,
"evidence_doc_daid": "0",
"evidence_doc_link": null,
"severity_id": null,
"reflection_id": "137251",
"is_read_indicator": "444031",
"evidence_url": null,
"evidence_url_filesize": null,
"evidence_url_checksum": null,
"evidence_url_extension": null,
"evidence_doc_daid_url": null,
"evidence_doc_daid_url_filesize": null,
"evidence_doc_daid_url_checksum": null,
"evidence_doc_daid_url_extension": null,
"escalation_tcl_id": null,
"escalation_reflection_id": null,
"updated_by_user": {
"id": 31,
"first_name": "Abc",
"last_name": "Z",
"username": "abcd",
"location_id": "1",
"created_by_user_id": "21",
"status": "ACTIVE",
"email": "[email protected]",
"smstxt_country_code": null,
"smstxt": "",
"single_location_user": "0",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "1",
"tomm_agenda_dispatch_time": "19",
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": "1",
"user_timezone": "Pacific\/Auckland"
},
"is_read": true
},
{
"id": "361761",
"requested_reflections_id": "137251",
"completion_log_id": "66236191",
"message_text": "Please provide an update",
"updated_by_user_id": "31",
"evidence_digital_asset_id": "0",
"evidence_textual": "",
"evidence_numeric": "",
"timestamp_row_added": "2022-03-31 14:38:33",
"longitude": "",
"latitude": "",
"correspondence_type": "MESSAGE",
"status": "ACTIVE",
"reference_url": null,
"evidence_qr_scan": "",
"evidence_confirmation_input": "",
"evidence_distance_metres": "0",
"ltz_timestamp_row_added": "2022-03-31 15:38:33",
"evidence_mcsi_db_id": "0",
"mcsi_other_textual_input": null,
"evidence_doc_daid": "0",
"evidence_doc_link": null,
"severity_id": null,
"reflection_id": "137251",
"is_read_indicator": "444021",
"evidence_url": null,
"evidence_url_filesize": null,
"evidence_url_checksum": null,
"evidence_url_extension": null,
"evidence_doc_daid_url": null,
"evidence_doc_daid_url_filesize": null,
"evidence_doc_daid_url_checksum": null,
"evidence_doc_daid_url_extension": null,
"escalation_tcl_id": null,
"escalation_reflection_id": null,
"updated_by_user": {
"id": 31,
"first_name": "Abc",
"last_name": "Z",
"username": "abcd",
"location_id": "1",
"created_by_user_id": "21",
"status": "ACTIVE",
"email": "[email protected]",
"smstxt_country_code": null,
"smstxt": "",
"single_location_user": "0",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "1",
"tomm_agenda_dispatch_time": "19",
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": "1",
"user_timezone": "Pacific\/Auckland"
},
"is_read": true
}
],
"delegation": [],
"latest_undelegation": [],
"is_delegated": false
},
"assigned_location": {
"id": "5701",
"name": "05-04-London",
"address1": "Unit 9 Market Row, Coldharbour",
"address2": "Ln, Brixton, London SW9 8LB, United Kingdom",
"city": "London",
"state_province": "",
"postal_code": "SW9 8LB",
"longitude": "-0.1121972",
"latitude": "51.4624528",
"pri_organization_id": "1",
"timezone": "Europe\/London",
"email": null,
"smstxt": "",
"uuid": "",
"alias": null,
"region_id": "1",
"floor_plan_format_id": "1",
"fact_id": "",
"store_code": "7124685j",
"status": "ACTIVE",
"time_open_monday": "09:00",
"time_open_tuesday": "09:00",
"time_open_wednesday": "09:00",
"time_open_thursday": "09:00",
"time_open_friday": "09:00",
"time_open_saturday": "09:00",
"time_open_sunday": "09:00",
"time_close_monday": "19:00",
"time_close_tuesday": "19:00",
"time_close_wednesday": "19:00",
"time_close_thursday": "19:00",
"time_close_friday": "19:00",
"time_close_saturday": "19:00",
"time_close_sunday": "19:00",
"rvp_id": null,
"dir_id": null,
"country_iso3": "GBR",
"closed_mondays": "NO",
"closed_tuesdays": "NO",
"closed_wednesdays": "NO",
"closed_thursdays": "NO",
"closed_fridays": "NO",
"closed_saturdays": "NO",
"closed_sundays": "NO",
"h24_mondays": "NO",
"h24_tuesdays": "NO",
"h24_wednesdays": "NO",
"h24_thursdays": "NO",
"h24_fridays": "NO",
"h24_saturdays": "NO",
"h24_sundays": "NO",
"location_type": "1"
},
"started_by_user": null,
"completed_by_user": [],
"accepted_by_user": [],
"failed_by_user": [],
"reflected_by_user": {
"id": 31,
"first_name": "Abc",
"last_name": "Z",
"username": "abcd",
"location_id": "1",
"created_by_user_id": "21",
"status": "ACTIVE",
"email": "[email protected]",
"smstxt_country_code": null,
"smstxt": "",
"single_location_user": "0",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "1",
"tomm_agenda_dispatch_time": "19",
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": "1",
"user_timezone": "Pacific\/Auckland",
"avatars": []
},
"escalationLinks": [],
"reflection_evidence_by_user": {
"id": "31",
"first_name": "ABC",
"last_name": "Z",
"username": "abcd",
"location_id": "1",
"created_by_user_id": "21",
"status": "ACTIVE",
"email": "[email protected]",
"smstxt_country_code": null,
"smstxt": "",
"single_location_user": "0",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "1",
"tomm_agenda_dispatch_time": "19",
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": "1",
"user_timezone": "Pacific\/Auckland"
},
"reflection_reopened_by_user": null,
"nvrImageEvidence": []
}
},
{
.....
}
],
"timestamp": 1648746793,
"datetime": "2022-03-31 17:13:13"
}
|
GET /actionlist/actionsById
(Admin-only) Get assigned actions by action completion IDs CSV
Also check: GET /actionlist/tasksById
| Example |
curl 'https://hostname/actionlist/actionsById?actionIdsCsv=1234%2C5678%2C8976' \
-X 'GET' \
-H 'X-Auth-Token: {token}' \
-H 'X-Auth-User: {username}'
|
| actionIdsCsv | CSV of action completion Ids (aka “tcl_id) – max permitted count per call is restricted based on service quota |
| Output |
{
"checksum": "15bca72911c7aca168e65f8259535f2f",
"sizeof": 14084,
"status": 200,
"msg": "",
"data": {
"48101": {
"action_state": {
"id": 48101,
"location_id": "61",
"task_list_id": "141",
"task_id": "4121",
"queue_id": "1211",
"queue_name": "vfadmin.location_schedule_notifications",
"start_datetime": "2019-08-20 15:00:00",
"due_datetime": "2019-08-20 16:30:00",
"status": "COMPLETED",
"longitude": "-88.7176787",
"latitude": "43.6336679",
"uuid": "81d98f7d-5946-4d3e-8705-305dfaf05ac9",
"numeric_input": null,
"textual_input": null,
"notes": null,
"ipv4_address": "99.30.145.108",
"ipv6_address": null,
"datetime_start": "2019-08-20 15:24:54",
"completed_by_user_id": "151",
"complete_datetime": "2019-08-20 15:25:21",
"datetime_last_updated": "2019-08-20 15:25:21",
"accepted_by_user_id": null,
"accepted_datetime": null,
"reflection_reqd_by_user_id": null,
"reflection_reqd_datetime": null,
"publish_datetime": "2019-08-20 15:00:00",
"fail_reqd_by_user_id": null,
"fail_reqd_datetime": null,
"is_autocadence": "0",
"zone_id": null,
"location_schedule_instance_id": "1911",
"schedule_type": "RECURRING_ABSOLUTE",
"fk_network_type_id": "1",
"device_model": "samsung samsung SM-T560NU",
"device_version": null,
"device_name": null,
"device_uiidiom": null,
"system_name": "Android",
"system_version": "7.1.1",
"device_battery_level": null,
"app_name": "RealCADENCE",
"app_version": "v2.3.531",
"ltz_location_timezone": "America\/Chicago",
"ltz_datetime_publish": "2019-08-20 10:00:00",
"ltz_datetime_start": "2019-08-20 10:00:00",
"ltz_datetime_due": "2019-08-20 11:30:00",
"ltz_complete_datetime": "2019-08-20 10:25:21",
"started_by": "151",
"list_instance_id": "141_1566300600",
"ltz_datetime_start_datetime": "2019-08-20 10:24:54",
"ltz_accepted_datetime": null,
"display_status": "COMPLETE",
"due_date_elapsed": true
},
"evidence": [
{
"id": "27151",
"longitude": "-88.7176787",
"latitude": "43.6336679",
"timestamp_row_added": "2019-08-20 15:25:21",
"task_id": "4121",
"digital_asset_id": "0",
"completion_log_id": "48101",
"task_input_requirement_id": "4171",
"required_input": "YES",
"auto_match_detected": "NO",
"status": "ACTIVE",
"task_input_requirement_type": "REQUIRED_CONFIRMATION",
"evidence_distance_metres": "6.1989112849896",
"mcsi_other_textual_input": null,
"requirement_type": "CONFIRMATION",
"task_required_input": "CONFIRMATION",
"required_input_comparison_type": "ANY",
"user_first_name": "12113",
"user_last_name": "WAUPUN",
"user_email": "",
"completed_by_user_id": "151",
"complete_datetime": "2019-08-20 15:25:21",
"ltz_complete_datetime": "2019-08-20 10:25:21",
"user_full_name": "12113 WAUPUN",
"da_url": null,
"da_asset_type_id": null,
"da_filesize": null,
"da_checksum": null,
"da_cdn_id": null,
"da_extension": null,
"is_other": null,
"needs_text_inp": null,
"mcsi_display_text": null,
"mcsi_score": null
}
],
"correspondence": [],
"task": {
"id": "4121",
"task_type_id": "6",
"name": "Kitchen - Buns thawed as needed",
"html_description": "Kitchen - Buns thawed as needed",
"expected_duration": "0",
"lit_id": "",
"required_input": "",
"digital_asset_id": "2941",
"task_list_id": "141",
"is_auto_accepted": "0",
"status": "ACTIVE",
"parent_task_id": "0",
"task_sort_order": "32",
"parent_task_sort_order": "0",
"previous_task_id": "0",
"max_score": "1",
"tpr_trigger": "IF_NO",
"collect_addnl_inputs": "CAI_NEVER",
"orig_task_id": null,
"requirements": [
{
"id": "4171",
"task_id": "4121",
"requirement_type": "CONFIRMATION",
"required_input": "CONFIRMATION",
"required_input_comparison_type": "ANY",
"context_msg": "Are the Buns thawed as needed",
"timestamp_row_created": "2019-08-17 17:11:17"
}
],
"da": {
"4121": {
"fullImage": {
"daid": "2941",
"url": "https:\/\/imgserve\/31_1564744660.8275_31.jpg.fullsize.jpg",
"asset_type_id": "1",
"filename": "31_1564744660.8275_31.jpg.fullsize.jpg",
"cdn_id": "2",
"thumbnail_daid": "2951",
"type_name": "Image"
},
"thumbnail": {
"daid": "2951",
"url": "https:\/\/imgserve\/31_1564744660.8275_31.jpg.thumbnail.jpg",
"asset_type_id": "7",
"filename": "31_1564744660.8275_31.jpg.thumbnail.jpg",
"cdn_id": "2",
"thumbnail_daid": null,
"type_name": "Image Thumb"
}
}
},
"sections": [],
"sort_order": "32",
"attachments": []
},
"task_list": {
"id": "141",
"list_name": "Checklist",
"start_datetime": null,
"due_datetime": null,
"expire_datetime": null,
"type_id": "1",
"digital_asset_id": null,
"html_description": "Checklist of the entire building.",
"format_id": null,
"region_id": null,
"author_id": "41",
"org_id": "1",
"status": "ACTIVE",
"publish_datetime": null,
"publish_timezone": null,
"schedule_type": null,
"enable_traffic_counting": null,
"enable_time_based_scheduling": null,
"modified_datetime": "2019-08-17 17:11:17",
"non_parent_action_count": "35",
"visibility": "GLOBAL",
"folder_id": "1",
"is_qsqr_rr_template": null,
"is_locked": "0"
},
"reflection": [],
"assigned_location": {
"id": "61",
"name": "Waupun",
"address1": "932 E Main St",
"address2": "PO Box 511",
"city": "Waupun",
"state_province": "WI",
"postal_code": "53963",
"longitude": "-88.7176295",
"latitude": "43.633625",
"pri_organization_id": "1",
"timezone": "America\/Chicago",
"email": "[email protected]",
"smstxt": "",
"uuid": "",
"alias": null,
"region_id": "1",
"floor_plan_format_id": "11",
"fact_id": "",
"store_code": "12113",
"status": "ACTIVE",
"time_open_monday": "09:00",
"time_open_tuesday": "09:00",
"time_open_wednesday": "09:00",
"time_open_thursday": "09:00",
"time_open_friday": "09:00",
"time_open_saturday": "09:00",
"time_open_sunday": "09:00",
"time_close_monday": "19:00",
"time_close_tuesday": "19:00",
"time_close_wednesday": "19:00",
"time_close_thursday": "19:00",
"time_close_friday": "19:00",
"time_close_saturday": "19:00",
"time_close_sunday": "19:00",
"rvp_id": null,
"dir_id": null,
"country_iso3": "USA",
"closed_mondays": "NO",
"closed_tuesdays": "NO",
"closed_wednesdays": "NO",
"closed_thursdays": "NO",
"closed_fridays": "NO",
"closed_saturdays": "NO",
"closed_sundays": "NO",
"h24_mondays": "NO",
"h24_tuesdays": "NO",
"h24_wednesdays": "NO",
"h24_thursdays": "NO",
"h24_fridays": "NO",
"h24_saturdays": "NO",
"h24_sundays": "NO",
"location_type": "1"
},
"started_by_user": {
"id": "151",
"first_name": "12113",
"last_name": "WAUPUN",
"username": "12113",
"location_id": "61",
"created_by_user_id": "31",
"status": "ACTIVE",
"email": "",
"smstxt_country_code": null,
"smstxt": "",
"single_location_user": "1",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "0",
"tomm_agenda_dispatch_time": null,
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": null,
"user_timezone": "America\/Chicago"
},
"completed_by_user": {
"id": 151,
"first_name": "12113",
"last_name": "WAUPUN",
"username": "12113",
"location_id": "61",
"created_by_user_id": "31",
"status": "ACTIVE",
"email": "",
"smstxt_country_code": null,
"smstxt": "",
"single_location_user": "1",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "0",
"tomm_agenda_dispatch_time": null,
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": null,
"user_timezone": "America\/Chicago",
"avatars": []
},
"accepted_by_user": [],
"failed_by_user": [],
"reflected_by_user": [],
"escalationLinks": [],
"reflection_evidence_by_user": null,
"reflection_reopened_by_user": null,
"nvrImageEvidence": [],
"context": []
},
"48081": {
"action_state": {
"id": 48081,
"location_id": "81",
"task_list_id": "141",
"task_id": "4281",
"queue_id": "1191",
"queue_name": "vfadmin.location_schedule_notifications",
"start_datetime": "2019-08-20 15:00:00",
"due_datetime": "2019-08-20 16:30:00",
"status": "COMPLETED",
"longitude": "-89.4105148",
"latitude": "45.6372699",
"uuid": "18fad14d-9441-43a3-b97d-bab0ae9313e1",
"numeric_input": null,
"textual_input": null,
"notes": null,
"ipv4_address": "71.90.31.90",
"ipv6_address": null,
"datetime_start": "2019-08-20 16:01:59",
"completed_by_user_id": "141",
"complete_datetime": "2019-08-20 16:02:31",
"datetime_last_updated": "2019-08-20 16:02:31",
"accepted_by_user_id": null,
"accepted_datetime": null,
"reflection_reqd_by_user_id": null,
"reflection_reqd_datetime": null,
"publish_datetime": "2019-08-20 15:00:00",
"fail_reqd_by_user_id": null,
"fail_reqd_datetime": null,
"is_autocadence": "0",
"zone_id": null,
"location_schedule_instance_id": "1891",
"schedule_type": "RECURRING_ABSOLUTE",
"fk_network_type_id": "1",
"device_model": "samsung samsung SM-T560NU",
"device_version": null,
"device_name": null,
"device_uiidiom": null,
"system_name": "Android",
"system_version": "7.1.1",
"device_battery_level": null,
"app_name": "RealCADENCE",
"app_version": "v2.3.531",
"ltz_location_timezone": "America\/Chicago",
"ltz_datetime_publish": "2019-08-20 10:00:00",
"ltz_datetime_start": "2019-08-20 10:00:00",
"ltz_datetime_due": "2019-08-20 11:30:00",
"ltz_complete_datetime": "2019-08-20 11:02:31",
"started_by": "141",
"list_instance_id": "141_1566300600",
"ltz_datetime_start_datetime": "2019-08-20 11:01:59",
"ltz_accepted_datetime": null,
"display_status": "COMPLETE",
"due_date_elapsed": true
},
"evidence": [
{
"id": "27801",
"longitude": "-89.4105148",
"latitude": "45.6372699",
"timestamp_row_added": "2019-08-20 16:02:31",
"task_id": "4281",
"digital_asset_id": "34301",
"completion_log_id": "48081",
"task_input_requirement_id": "4331",
"required_input": "",
"auto_match_detected": "NO",
"status": "ACTIVE",
"task_input_requirement_type": "REQUIRED_PHOTO",
"evidence_distance_metres": "38.211476340188",
"mcsi_other_textual_input": null,
"requirement_type": "PHOTO",
"task_required_input": "",
"required_input_comparison_type": "ANY",
"user_first_name": "25052",
"user_last_name": "ABC",
"user_email": "",
"completed_by_user_id": "141",
"complete_datetime": "2019-08-20 16:02:31",
"ltz_complete_datetime": "2019-08-20 11:02:31",
"user_full_name": "25052 ABC",
"da_url": "https:\/\/imgserve\/1566316950.9878_141.jpg.fullsize.jpg",
"da_asset_type_id": "1",
"da_filesize": "70806",
"da_checksum": "ea1b3a4039c1d127b763eb60aae30b92",
"da_cdn_id": "2",
"da_extension": null,
"is_other": null,
"needs_text_inp": null,
"mcsi_display_text": null,
"mcsi_score": null
}
],
"correspondence": [],
"task": {
"id": "4281",
"task_type_id": "6",
"name": "Kitchen - Cabinet timers set",
"html_description": "Kitchen - Cabinet timers set",
"expected_duration": "0",
"lit_id": "",
"required_input": "",
"digital_asset_id": "18681",
"task_list_id": "141",
"is_auto_accepted": "0",
"status": "ACTIVE",
"parent_task_id": "0",
"task_sort_order": "28",
"parent_task_sort_order": "0",
"previous_task_id": "0",
"max_score": "1",
"tpr_trigger": "NEVER",
"collect_addnl_inputs": "CAI_NEVER",
"orig_task_id": null,
"requirements": [
{
"id": "4331",
"task_id": "4281",
"requirement_type": "PHOTO",
"required_input": "",
"required_input_comparison_type": "ANY",
"context_msg": "Are the Cabinet timers set\/fresh product? Take a photo of the timed cabinets.",
"timestamp_row_created": "2019-08-17 17:11:17"
}
],
"da": {
"4281": {
"fullImage": {
"daid": "18681",
"url": "https:\/\/imgserve\/1566057416.4527_41.jpg.fullsize.jpg",
"asset_type_id": "1",
"filename": "1566057416.4527_41.jpg.fullsize.jpg",
"cdn_id": "2",
"thumbnail_daid": "18691",
"type_name": "Image"
},
"thumbnail": {
"daid": "18691",
"url": "https:\/\/imgserve\/1566057416.4527_41.jpg.thumbnail.jpg",
"asset_type_id": "7",
"filename": "1566057416.4527_41.jpg.thumbnail.jpg",
"cdn_id": "2",
"thumbnail_daid": null,
"type_name": "Image Thumb"
}
}
},
"sections": [],
"sort_order": "28",
"attachments": []
},
"task_list": {
"id": "141",
"list_name": "Checklist",
"start_datetime": null,
"due_datetime": null,
"expire_datetime": null,
"type_id": "1",
"digital_asset_id": null,
"html_description": "Checklist of the entire building.",
"format_id": null,
"region_id": null,
"author_id": "41",
"org_id": "1",
"status": "ACTIVE",
"publish_datetime": null,
"publish_timezone": null,
"schedule_type": null,
"enable_traffic_counting": null,
"enable_time_based_scheduling": null,
"modified_datetime": "2019-08-17 17:11:17",
"non_parent_action_count": "35",
"visibility": "GLOBAL",
"folder_id": "1",
"is_qsqr_rr_template": null,
"is_locked": "0"
},
"reflection": [],
"assigned_location": {
"id": "81",
"name": "ABC",
"address1": "25 S. Stevens St",
"address2": "",
"city": "Rhinelander",
"state_province": "WI",
"postal_code": "54501",
"longitude": "-89.4108741",
"latitude": "45.6370354",
"pri_organization_id": "1",
"timezone": "America\/Chicago",
"email": "[email protected]",
"smstxt": "",
"uuid": "",
"alias": null,
"region_id": "1",
"floor_plan_format_id": "11",
"fact_id": "",
"store_code": "25052",
"status": "ACTIVE",
"time_open_monday": "09:00",
"time_open_tuesday": "09:00",
"time_open_wednesday": "09:00",
"time_open_thursday": "09:00",
"time_open_friday": "09:00",
"time_open_saturday": "09:00",
"time_open_sunday": "09:00",
"time_close_monday": "19:00",
"time_close_tuesday": "19:00",
"time_close_wednesday": "19:00",
"time_close_thursday": "19:00",
"time_close_friday": "19:00",
"time_close_saturday": "19:00",
"time_close_sunday": "19:00",
"rvp_id": null,
"dir_id": null,
"country_iso3": "USA",
"closed_mondays": "NO",
"closed_tuesdays": "NO",
"closed_wednesdays": "NO",
"closed_thursdays": "NO",
"closed_fridays": "NO",
"closed_saturdays": "NO",
"closed_sundays": "NO",
"h24_mondays": "NO",
"h24_tuesdays": "NO",
"h24_wednesdays": "NO",
"h24_thursdays": "NO",
"h24_fridays": "NO",
"h24_saturdays": "NO",
"h24_sundays": "NO",
"location_type": "1"
},
"started_by_user": {
"id": "141",
"first_name": "25052",
"last_name": "ABC",
"username": "25052",
"location_id": "81",
"created_by_user_id": "31",
"status": "ACTIVE",
"email": "",
"smstxt_country_code": null,
"smstxt": "",
"single_location_user": "1",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "0",
"tomm_agenda_dispatch_time": null,
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": null,
"user_timezone": "America\/Chicago"
},
"completed_by_user": {
"id": 141,
"first_name": "25052",
"last_name": "ABC",
"username": "25052",
"location_id": "81",
"created_by_user_id": "31",
"status": "ACTIVE",
"email": "",
"smstxt_country_code": null,
"smstxt": "",
"single_location_user": "1",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "0",
"tomm_agenda_dispatch_time": null,
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": null,
"user_timezone": "America\/Chicago",
"avatars": []
},
"accepted_by_user": [],
"failed_by_user": [],
"reflected_by_user": [],
"escalationLinks": [],
"reflection_evidence_by_user": null,
"reflection_reopened_by_user": null,
"nvrImageEvidence": [],
"context": []
}
},
"timestamp": 1648844281,
"datetime": "2021-02-01 20:18:01"
}
|
POST actionlist/actionCompletion
Complete an Action by submitting evidence.
https:// [host] / actionlist / actionCompletion
| Example | Action requires numeric input and a digital asset ID for photo evidence.
curl --request POST \
--url https://hostname/actionlist/actionCompletion \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--data '{
"cid" : "123456789",
"ni" : "4321",
"daid" : "1234"
}'
|
| cid | Action Completion ID aka “tcl_id” from locationTaskTree API |
| ci | Confirmation input (‘YES’|’NO’) *if required* as action evidence |
| ni | Numeric input *if required* as action evidence |
| ti | Textual input *if required* as action evidence |
| qr | QR scan input *if required* as action evidence |
| mcsi | Multiple Choice Selection ID |
| daid | Photo evidence digital asset ID *if required* as action evidence (see Assets to obtain id) |
| document_daid | File/document evidence digital asset ID *if required* as action evidence (see Assets to obtain id) |
| document_hyperlink | URL referencing a file to download or web accessible resource. |
POST reflections/evidence
Complete a service-request (reflection) by submitting evidence.
https:// [host] / reflections / evidence / {reflection ID}
| Example | Action requires text input, numeric input and document digital asset ID evidence.
curl --request POST \
--url https://hostname/reflections/evidence \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--data '{
"et" : "Abcd",
"en" : "4321",
"daid" : "1234"
}'
|
| reflection ID | The ID of the service request aka reflection from locationReflections API |
| ec | Confirmation input (‘YES’|’NO’) *if required* as action evidence |
| en | Numeric input *if required* as action evidence |
| et | Textual input *if required* as action evidence |
| eq | QR scan input *if required* as action evidence |
| mcsi | Multiple Choice Selection ID |
| daid | Photo evidence digital asset ID *if required* as action evidence (see Assets to obtain id) |
| document_daid | File/document evidence digital asset ID *if required* as action evidence (see Assets to obtain id) |
| document_hyperlink | URL referencing a file to download or web accessible resource. |
POST actionlist/actionComment
Add a new “note” to an action.
https:// [host] / actionlist / actionComment / [action completion id]
| Example | Action requires numeric input and a digital asset ID for photo evidence.
curl --request POST \
--url https://hostname/actionlist/actionComment/12345 \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--data '{
"type" : "MESSAGE",
"comment" : "This is a straight up text note.",
}'
|
| type | String constants of one of the following: MESSAGE | MESSAGE_PHOTO | MESSAGE_FILE | MESSAGE_URL |
| comment (optional, based on message type) | A string of characters representing something human readable. |
| severityId (optional, based on message type; values 0,1,2,3 as defined in Admin > Extra Options) | A numeric value that is set in |
| daid (optional, based on message type) | Photo evidence digital asset ID *if required* as action evidence (see Assets to obtain id) |
| document_hyperlink (optional, based on message type) | URL referencing a file to download or web accessible resource. |
| startNewUserMsgThread (optional; ‘true’ if desired) | Creates a user-inbox message thread with all primary users linked to the action’s assigned location. |
POST reflections/delegate
Delegate an action to a specific user.
https:// [host] / reflections / delegate / [action completion id]
| Example |
curl 'https://host/reflections/delegate/12345' \ -X 'POST' -H 'X-Auth-Token: auth-token' \ -H 'X-Auth-User: username' \ --data-raw 'operation=REPLACE&delegateIdsCsv=1234' |
| operation | Permitted value: REPLACE |
| delegateIdsCsv | User ID to delegate to |
| delegationReason | Message for the delegated user |
POST actionlist/bulkActionUpdate
Extend the due date-time for actions.
https:// [host] / actionlist / bulkActionUpdate
| Example |
curl 'https://features.voloforce.net/actionlist/bulkActionUpdate' \ -X 'POST' -H 'X-Auth-Token: auth-token' \ -H 'X-Auth-User: username' \ --data-raw 'updateType=REFLECT&actionIds=12335&reason=Extending%20due%20date%2Ftime%20to%20complete%20this%20action%20to%20Apr%201%2C%202022%205%3A13%20PM&due=2022-04-01%2017%3A13%3A00' |
| updateType | REFLECT |
| actionIds | CSV of Action completion IDs to extend |
| reason | Message for extension |
| due | Due date-time in the format YYYY-MM-DD hh:mm:00 (eg. 2022-04-01 17:13:00). Note: the hour should be in the 24-hour format. |
POST actionlist/bulkActionUpdate
Extend the due date-time for service requests (aka reflections).
https:// [host] / actionlist / bulkActionUpdate
| Example |
curl 'https://features.voloforce.net/actionlist/bulkActionUpdate' \ -X 'POST' -H 'X-Auth-Token: authtoken' \ -H 'X-Auth-User: authuser' \ --data-raw 'updateType=REFLECTION_EXTEND&actionIds=54321%2C287561&reason=Extending%20due%20date%2Ftime%20to%20complete%20this%20action%20to%20Mar%2031%2C%202022%205%3A39%20PM&due=2022-03-31%2017%3A39%3A00' |
| updateType | REFLECTION_EXTEND |
| actionIds | CSV of Action completion IDs to extend |
| reason | Message for extension |
| due | Due date-time in the format YYYY-MM-DD hh:mm:00 (eg. 2022-04-01 17:13:00). Note: the hour should be in the 24-hour format. |
PUT /actionlist/actionJsonContext
(Admin-only) Set JSON context for an action completion ID.
https:// [host] / actionlist / actionJsonContext / [action completion id]
| Example |
curl --request PUT \
--url https://host/actionlist/actionJsonContext/12345 \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'x-auth-token: token' \
--header 'x-auth-user: john.doe' \
--data 'json={"abcd": "some str", "efgh": 12345, "ijkl": {}, "mnop": []}'
|
| json | Any well-formed JSON. Max length is restricted based on service quota. |
GET realcadence/countsNow4
Get action status for actions published but not yet due for a given location ID.
Note: Location ID is optional and if NULL, will respond will all user’s location Action counts.
https:// [host] / realcadence / countsNow4 / [location_id]
| Example | Action requires numeric input and a digital asset ID for photo evidence.
curl --request GET \ --url https://hostname/realcadence/countsNow4/12345 \ --header 'content-type: application/json' \ --header 'x-auth-token: 555-555-1212' \ --header 'x-auth-user: joe.user' \ |
POST reflections/taskProblemReport
Reports a task problem with reason why the task could not be completed.
https:// [host] / reflections / taskProblemReport
| Example | Action requires numeric input and a digital asset ID for photo evidence.
curl --request POST \
--url https://hostname/reflections/taskProblemReport \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--data '{
"cid" : "1234",
"n" : "Cannot confirm action completion"
}'
|
| cid | Completion Log ID |
| n | Note or Reason why the task could not be completed |