Reports

Get / Download task report#

To download the report in xls format, add the header Accept: application/vnd.ms-excel
To get the report in json format, add the header Accept: application/json

GET
/tasks-manual/{taskId}/responses

Request parameters:

Request Parameter	Type	Description	Required
page	Integer	Number of page	false
size	Integer	Count of elements in page	false
status	Set of string	Available statuses `OPEN, IN_PROGRESS, CLOSED`	false
approvalStatus	Set of string	Available statuses `APPROVED, NOT_APPROVED, APPROVABLE, NOT_APPROVABLE`	false
responseIds	Set of integer	Identifiers of responses	false
divisionIds	Set of integer	Identifiers of divisions	false
regionIds	Set of integer	Identifiers of regions	false
shopIds	Set of integer	Identifiers of stores	false
closedAfter	Timestamp in milliseconds	Response closed after date	false
closedBefore	Timestamp in milliseconds	Response closed before date	false

Response

Returns a list of Response objects. Pagination info is returned in response headers, not in the body:x-total-count, x-total-pages, x-page-number, x-page-size.

Examples

curl https://api.qvalon.com/v1/tasks-manual/162/responses \
--header 'Authorization: Bearer <your_token>'

200 OK

[
  {
    "id": 449,
    "taskId": 162,
    "version": 1,
    "status": "CLOSED",
    "executorId": 1609,
    "executorName": "Madison",
    "region": "Los Angeles",
    "regionId": 86,
    "division": "United States",
    "divisionId": 28,
    "overdue": true,
    "closeDate": 1671065103313,
    "comment": "The task was completed automatically",
    "attachmentsCount": 0,
    "executorsCommentRequired": false,
    "minAttachmentsCount": 0,
    "taskLog": "Closed overdue task.",
    "executorRole": "SHOP",
    "shopId": 668,
    "shopName": "Store 01",
    "labels": {},
    "needApproval": false,
    "customObservers": [
      {
        "observerId": 1,
        "observerName": "John Vu"
      }
    ],
    "deleted": false,
    "taskCategories": [],
    "commentsCount": 0,
    "commentsRequiredCount": 0,
    "claimCount": 0,
    "closedClaimCount": 0,
    "photoReportChecklistsTotalCount": 0,
    "photoReportChecklistsFinishedCount": 0,
    "photoReportChecklists": [],
    "autoclosed": true,
    "autoclosedReason": "MISSED",
    "executors": [],
    "observerPermissions": {
      "canReturnToWork": true,
      "canDelegate": true,
      "canApprove": true,
      "canDelete": false
    }
  }
]

Download task attachments#

Downloads all files attached to the task as a zip archive

GET
/tasks-manual/responses/zip

Request parameters:

Request Parameter	Type	Description	Required
taskId	Integer	Identifier of the task	true

Response

Returns a zip archive

Examples

curl https://api.qvalon.com/v1/tasks-manual/responses/zip?taskId=162 \
--header 'Authorization: Bearer <your_token>'

200 OK

[]