Task

The task can be of several types, for many executors and has many settings

Attribute	Type	Description	Nullable
id	String	Identifier	false
version	Integer	Version of task (increased every time after update of task)	true
name	String	Task name	false
description	String	Task description	false
status	String	Current task status: available statuses `OPEN, IN_PROGRESS, CLOSED` '	false
grouped	Boolean	Flag indicating a group task	false
response	Boolean	Flag indicating a this task is subtask (response)	false
authorId	Integer	Identifier of author of task	false
authorName	String	Full name of author of task	false
executorName	String	Full name of executor of task	true
executors	Object	List executors User object	false
observerName	Object	Full name of observer's of task	true
observers	Object	List observers User object	true
createDate	Timestamp in milliseconds	Task create date	false
totalCount	Long	Count of subtasks (responses)	false
closedCount	Long	Count of closed subtasks (responses)	false
linkedTaskId	Long	Deprecated field	true
taskType	String	Type of task: `COMMON, ROUTED, PHOTO_REPORT, SURVEY`	false
userRole	String	Current user role in task	false
deadlineDate	Timestamp in milliseconds	Deadline date of task	false
closeDate	Timestamp in milliseconds	Close date of task	true
exemplarTaskTemplateId	Integer	Identifier of template task	true
parentTaskId	Integer	Identifier of parent task	true
childTaskId	Integer	Identifier of parent task	true
attachmentsCount	Integer	Count of attachments in task	true
route	Object	Object of routing executors, see Route object	true
periodicTaskSchedule	Object	Deprecated field	true
responseList	List of objects	List of task response (subtasks), see Response object	true
isLoadPhotoFromGalleryProhibited	Boolean	Block uploading photos from the gallery	false
labels	Map of string, string	Some labels for task	true
notifications	List objects	Set custom notifications for task. See Notification object	true
claimCount	Integer	Count of claim tasks for this task	true
claimDoneCount	Integer	Count of closed claim tasks for this task	true
needApproval	Boolean	Flag indicating this task need approval	false
approved	Boolean	Flag indicating this task was be approved	true
approvalCount	Integer	Count of approved subtasks (responses)	true
approvalDate	Timestamp in milliseconds	Date when the task was be approved	true
routedToExecutor	Boolean	Flag indicating this task is routed from checklist	true
editorName	String	Full name of user who changed the task	true
modifiedAt	Timestamp in milliseconds	Date and time of the last change	true
isOnlyOneRequired	Boolean	There is only one sub-task to complete in the store	false

Example:

{
  "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
}