Skip to main content

Response

Response is a task response object


AttributeTypeDescriptionNullable
idStringIdentifierfalse
taskIdIntegerIdentifier of taskfalse
versionIntegerVersion of task response (increased every time after update of response)true
statusStringCurrent task response status: available statuses OPEN, IN_PROGRESS, CLOSED false
executorIdIntegerIdentifier of executor usertrue
executorNameStringFull name of executorfalse
regionStringThe name of the region in which the store is located for which the task response was created false
regionIdIntegerIdentifier of the region in which the store is located for which the task response was createdtrue
divisionStringThe name of the division in which the store is located for which the task response was created false
divisionIdIntegerIdentifier of the division in which the store is located for which the task response was createdtrue
overdueBooleanFlag indicating a this task is overduefalse
observersBoolean List of task response observers
See Observer object
false
startDateTimestamp in millisecondsDate and time when task response startedtrue
closeDateTimestamp in millisecondsDate and time when task response closedtrue
commentStringExecutor commenttrue
attachmentsCountStringCount of attachments linked to task responsefalse
minAttachmentsCountStringThe minimum number of investments that the executor must attach to task responsefalse
taskLogStringLog task response closed eventtrue
executorRoleStringThe type of user role on which the task was created
SHOP - director of store
REGION - director of region
DIVISION - director of division
ROUTED_USER - routed to user
USER - task to user
SUPERVISOR - auditor
COMPANY - user with company level
true
supervisorCommentStringExecutor commenttrue
notificationPeriodEnum of stringFrequency of reminders for executors:
daily, weekly, deadline, dayBeforeDeadline
false
shopIdIntegerIdentifier of the store for which the task response was createdtrue
shopNameStringStore name which the task response was createdtrue
labelsMap of string, stringSome labels for task responsetrue
needApprovalBooleanFlag indicating this task response need approvalfalse
approvedBooleanFlag indicating this task response was be approvedtrue
approverNameStringFull name of user who approved task responsetrue
approvalDateTimestamp in millisecondsDate and time when task was approvedtrue
customObserversList objects List observers for task response.
See Observer object
true
deletedBooleanFlag indicating this task response was be deletedfalse
userRoleStringCurrent user role in taskfalse
returnerIdIntegerIdentifier of user who return task to worktrue
Example:
[
{
"id": 449,
"taskId": 162,
"version": 0,
"status": "OPEN",
"executorId": 1609,
"executorName": "Test executor name",
"region": "West",
"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
}
]