View / Create / Edit / Delete

Get tasks

Return Task objects

• GET
• /tasks

Request parameters:

Request Parameter	Type	Description	Required
page	Integer	Number of page	true
size	Integer	Count of elements in page, recommended 1000 elements per page	true
name	String	Search by task name	false
taskIds	List of integers	Search by task ids	false
divisionIds	List of integers	Search by division ids	false
regionIds	List of integers	Search by region ids	false
status	String	Search by status: OPEN, IN_PROGRESS, CLOSED	false
createdAfter	Timestamp in milliseconds	Search for tasks where the creation date is after	false
createdBefore	Timestamp in milliseconds	Search for tasks where the creation date is before	false
closedBefore	Timestamp in milliseconds	Search for tasks where the closed date is after	false
closedBefore	Timestamp in milliseconds	Search for tasks where the closed date is before	false
deadlineAfter	Timestamp in milliseconds	Search for tasks where the deadline date is after	false
modifiedBefore	Timestamp in milliseconds	Search for tasks where the deadline date is before	false
taskTypes	String	Search for tasks by task type: COMMON, ROUTED, PHOTO_REPORT, SURVEY	false
checklistId	Integer	Search for tasks by checklistId, only for ROUTED task type	false
approvalStatus	Set of string	Search for tasks by approval status: APPROVED, NOT_APPROVED, APPROVABLE, NOT_APPROVABLE	false

Examples

curl https://api.qvalon.com/v1/tasks \

--header 'Authorization: Bearer <your_token>'

200 OK

[

{

"attachmentsRequired": false,

"id": 162,

"version": 2,

"name": "test task",

"description": "test description",

"status": "OPEN",

"grouped": false,

"periodic": false,

"response": false,

"authorId": 1,

"authorName": "John Vu",

"executorName": "Madison",

"executors": [

{

"id": 1609,

"name": "Madison"

}

],

"observerName": "Does John",

"observers": [

{

"id": 1615,

"name": "Does John"

}

],

"createDate": 1623749422616,

"totalCount": 1,

"closedCount": 0,

"taskType": "COMMON",

"userRole": "AUTHOR",

"deadlineDate": 1623877199965,

"responseList": [

{

"id": 449,

"taskId": 162,

"version": 0,

"status": "OPEN",

"executorId": 1609,

"executorName": "Madison",

"region": "Test region",

"regionId": 86,

"division": "Test division",

"divisionId": 28,

"overdue": false,

"attachmentsCount": 0,

"executorsCommentRequired": true,

"minAttachmentsCount": 1,

"executorRole": "SHOP",

"notificationPeriod": "daily",

"shopId": 668,

"shopName": "Store 01",

"labels": {},

"needApproval": true,

"approved": false,

"customObservers": [

{

"observerId": 1615,

"observerName": "Does John"

}

],

"deleted": false

}

],

"isLoadPhotoFromGalleryProhibited": true,

"labels": {},

"notifications": [

{

"type": "UPDATE",

"role": "AUTHOR",

"push": true,

"email": true

},

{

"type": "UPDATE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "UPDATE",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "RETURN",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "RETURN",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "AUTHOR",

"push": true,

"email": true

},

{

"type": "CLOSE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "CLOSE",

"role": "AUTHOR",

"push": true,

"email": true

},

{

"type": "CREATE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "CREATE",

"role": "EXECUTOR",

"push": true,

"email": true

}

],

"claimCount": 0,

"claimDoneCount": 0,

"needApproval": true,

"approvalCount": 0,

"routedToExecutor": false,

"isOnlyOneRequired": true

}

]

Get task by id

Return Task object

• GET
• /tasks/{id}

Examples

curl https://api.qvalon.com/v1/tasks/37 \

--header 'Authorization: Bearer <your_token>'

200 OK

{

"attachmentsRequired": false,

"id": 162,

"version": 2,

"name": "test task",

"description": "test description",

"status": "OPEN",

"grouped": false,

"periodic": false,

"response": false,

"authorId": 1,

"authorName": "John Vu",

"executorName": "Madison",

"executors": [

{

"id": 1609,

"name": "Madison"

}

],

"observerName": "Does John",

"observers": [

{

"id": 1615,

"name": "Does John"

}

],

"createDate": 1623749422616,

"totalCount": 1,

"closedCount": 0,

"taskType": "COMMON",

"userRole": "AUTHOR",

"deadlineDate": 1623877199965,

"responseList": [

{

"id": 449,

"taskId": 162,

"version": 0,

"status": "OPEN",

"executorId": 1609,

"executorName": "Madison",

"region": "Test region",

"regionId": 86,

"division": "Test division",

"divisionId": 28,

"overdue": false,

"attachmentsCount": 0,

"executorsCommentRequired": true,

"minAttachmentsCount": 1,

"executorRole": "SHOP",

"notificationPeriod": "daily",

"shopId": 668,

"shopName": "Store 01",

"labels": {},

"needApproval": true,

"approved": false,

"customObservers": [

{

"observerId": 1615,

"observerName": "Does John"

}

],

"deleted": false

}

],

"isLoadPhotoFromGalleryProhibited": true,

"labels": {},

"notifications": [

{

"type": "UPDATE",

"role": "AUTHOR",

"push": true,

"email": true

},

{

"type": "UPDATE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "UPDATE",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "RETURN",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "RETURN",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "AUTHOR",

"push": true,

"email": true

},

{

"type": "CLOSE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "CLOSE",

"role": "AUTHOR",

"push": true,

"email": true

},

{

"type": "CREATE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "CREATE",

"role": "EXECUTOR",

"push": true,

"email": true

}

],

"claimCount": 0,

"claimDoneCount": 0,

"needApproval": true,

"approvalCount": 0,

"routedToExecutor": false,

"isOnlyOneRequired": true

}

Create task

Creates new task.

• POST
• /tasks/create

Request body:

Attribute	Type	Description	Nullable
name	String	Task name	false
taskType	Enum of string	Available types:COMMON,SURVEY,PHOTO_REPORT	false
description	String	Task description	false
deadlineDate	Timestamp in milliseconds	Task deadline date	false
executors	Object	Executor user object with field id and name	false
executorsCommentRequired	Boolean	Executors is obliged to leave a comment	false
needApproval	Boolean	Flag indicating this task need approval	false
isOnlyOneRequired	Boolean	There is only one sub-task to complete in the store	false
isLoadPhotoFromGalleryProhibited	Boolean	Block uploading photos from the gallery	false
notificationPeriod	Enum of string	Frequency of reminders for executors: daily, weekly, deadline, dayBeforeDeadline	false
minAttachmentsCount	Integer	Min. the number of attachments that the executor must attach	false
notifications	List objects	Set custom notifications for task. See Notification object	true
customObservers	List objects	Set custom observers for task. See Observer object	true
observersEnabled	Boolean	Observers enable	false
formTemplateId	String	Survey template id Required for SURVEY task type	true

Response

Returns Task object

Examples

curl --request POST https://api.qvalon.com/v1/tasks/create \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"name":"test task","taskType":"COMMON","description":"test description","deadlineDate":1623790800965,"executors":{"executorRole":"SHOP","objectsToUsers":{"668":[1609]}},"executorsCommentRequired":true,"needApproval":true,"isOnlyOneRequired":true,"isLoadPhotoFromGalleryProhibited":true,"notificationPeriod":"daily","minAttachmentsCount":1,"notifications":[],"customObservers":[{"observerId":1615,"observerName":"Does John"}],"observersEnabled":true,"formTemplateId":""}'

200 OK

{

"attachmentsRequired": false,

"id": 162,

"version": 2,

"name": "test task",

"description": "test description",

"status": "OPEN",

"grouped": false,

"periodic": false,

"response": false,

"authorId": 1,

"authorName": "John Vu",

"executorName": "Madison",

"executors": [

{

"id": 1609,

"name": "Madison"

}

],

"observerName": "Does John",

"observers": [

{

"id": 1,

"name": "John Vu"

},

{

"id": 1615,

"name": "Does John"

}

],

"createDate": 1623749422616,

"totalCount": 1,

"closedCount": 0,

"taskType": "COMMON",

"userRole": "AUTHOR",

"deadlineDate": 1623877199965,

"responseList": [

{

"id": 449,

"taskId": 162,

"version": 0,

"status": "OPEN",

"executorId": 1609,

"executorName": "Madison",

"region": "Test region",

"regionId": 86,

"division": "Test division",

"divisionId": 28,

"overdue": false,

"attachmentsCount": 0,

"executorsCommentRequired": true,

"minAttachmentsCount": 1,

"executorRole": "SHOP",

"notificationPeriod": "daily",

"shopId": 668,

"shopName": "Store 01",

"labels": {},

"needApproval": true,

"approved": false,

"customObservers": [

{

"observerId": 1,

"observerName": "John Vu"

},

{

"observerId": 1615,

"observerName": "Does John"

}

],

"deleted": false

}

],

"isLoadPhotoFromGalleryProhibited": true,

"labels": {},

"notifications": [

{

"type": "CREATE",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "CREATE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "CLOSE",

"role": "AUTHOR",

"push": true,

"email": true

},

{

"type": "CLOSE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "AUTHOR",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "RETURN",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "RETURN",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "UPDATE",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "UPDATE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "UPDATE",

"role": "AUTHOR",

"push": true,

"email": true

}

],

"claimCount": 0,

"claimDoneCount": 0,

"needApproval": true,

"approvalCount": 0,

"routedToExecutor": false,

"isOnlyOneRequired": true

}

Edit task

Edit existing task.

• PUT
• /tasks-manual

Request body:

Attribute	Type	Description	Nullable
id	Int	Task id	false
version	Int	Task version	false
name	String	Task name	false
description	String	Task description	false
periodic	Boolean	Task periodic	false
executors	Object	List executors Executors object	false
taskType	Enum of string	Available types:COMMON,SURVEY,PHOTO_REPORT	false
deadlineDate	Timestamp in milliseconds	Task deadline date	false
deadlineTimeEnabled	Boolean	Task deadline enabled	false
isLoadPhotoFromGalleryProhibited	Boolean	Block uploading photos from the gallery	false
notifications	List objects	Set custom notifications for task. See Notification object	true
needApproval	Boolean	Flag indicating this task need approval	false
isOnlyOneRequired	Boolean	There is only one sub-task to complete in the store	false
signatureRequired	Boolean	Signature required	false
customObservers	List objects	Set custom observers for task. See Observer object	true
executorsCommentRequired	Boolean	Executors comment is required	false
notificationPeriod	Enum of string	Frequency of reminders for executors: daily, weekly, deadline, dayBeforeDeadline	false
minAttachmentsCount	Integer	Min. the number of attachments that the executor must attach	false

Response

Returns Task object

Examples

curl --request PUT https://api.qvalon.com/v1/tasks-manual \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"id":162,"version":1,"name":"test task","description":"test description","periodic":false,"executors":{"executorRole":"SHOP","objectsToUsers":{"664":[1600],"665":[1600],"668":[1600],"669":[1600],"670":[1601],"671":[1600]}},"taskType":"COMMON","deadlineDate":1623877199965,"deadlineTimeEnabled":true,"isLoadPhotoFromGalleryProhibited":false,"notifications":[{"type":"UPDATE","role":"AUTHOR","push":true,"email":true},{"type":"UPDATE","role":"OBSERVER","push":true,"email":true},{"type":"UPDATE","role":"EXECUTOR","push":true,"email":true},{"type":"RETURN","role":"OBSERVER","push":true,"email":true},{"type":"RETURN","role":"EXECUTOR","push":true,"email":true},{"type":"OVERDUE","role":"OBSERVER","push":true,"email":true},{"type":"OVERDUE","role":"EXECUTOR","push":true,"email":true},{"type":"OVERDUE","role":"AUTHOR","push":true,"email":true},{"type":"CLOSE","role":"OBSERVER","push":true,"email":true},{"type":"CLOSE","role":"AUTHOR","push":true,"email":true},{"type":"CREATE","role":"OBSERVER","push":true,"email":true},{"type":"CREATE","role":"EXECUTOR","push":true,"email":true}],"needApproval":false,"isOnlyOneRequired":false,"signatureRequired":false,"taskCategories":[],"customObservers":[],"executorsCommentRequired":false,"notificationPeriod":"daily","minAttachmentsCount":0}'

200 OK

{

"attachmentsRequired": false,

"id": 162,

"version": 2,

"name": "test task",

"description": "test description",

"status": "OPEN",

"grouped": false,

"periodic": false,

"response": false,

"authorId": 1,

"authorName": "John Vu",

"executorName": "Madison",

"executors": [

{

"id": 1609,

"name": "Madison"

}

],

"observerName": "Does John",

"observers": [

{

"id": 1,

"name": "John Vu"

},

{

"id": 1615,

"name": "Does John"

}

],

"createDate": 1623749422616,

"totalCount": 1,

"closedCount": 0,

"taskType": "COMMON",

"userRole": "AUTHOR",

"deadlineDate": 1623877199965,

"responseList": [

{

"id": 449,

"taskId": 162,

"version": 0,

"status": "OPEN",

"executorId": 1609,

"executorName": "Madison",

"region": "Test region",

"regionId": 86,

"division": "Test division",

"divisionId": 28,

"overdue": false,

"attachmentsCount": 0,

"executorsCommentRequired": true,

"minAttachmentsCount": 1,

"executorRole": "SHOP",

"notificationPeriod": "daily",

"shopId": 668,

"shopName": "Store 01",

"labels": {},

"needApproval": true,

"approved": false,

"customObservers": [

{

"observerId": 1,

"observerName": "John Vu"

},

{

"observerId": 1615,

"observerName": "Does John"

}

],

"deleted": false

}

],

"isLoadPhotoFromGalleryProhibited": true,

"labels": {},

"notifications": [

{

"type": "CREATE",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "CREATE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "CLOSE",

"role": "AUTHOR",

"push": true,

"email": true

},

{

"type": "CLOSE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "AUTHOR",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "OVERDUE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "RETURN",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "RETURN",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "UPDATE",

"role": "EXECUTOR",

"push": true,

"email": true

},

{

"type": "UPDATE",

"role": "OBSERVER",

"push": true,

"email": true

},

{

"type": "UPDATE",

"role": "AUTHOR",

"push": true,

"email": true

}

],

"claimCount": 0,

"claimDoneCount": 0,

"needApproval": true,

"approvalCount": 0,

"routedToExecutor": false,

"isOnlyOneRequired": true

}

Delete task

Returns code status

• DELETE
• /tasks-manual/{id}

Examples

curl --request DELETE https://api.qvalon.com/v1/tasks-manual/162 \

--header 'Authorization: Bearer <your_token>'

200 OK

{}