Skip to main content

Task category

Task category is a helper object that describes a single photo section of a photo report. It is filled in only for tasks of the PHOTO_REPORT type (passed in the taskCategories array when creating a task); for other task types it is ignored.


AttributeTypeDescriptionNullable
nameStringCategory name shown to the executorfalse
descriptionStringCategory description / instructions for the executortrue
minAttachmentsCountIntegerMinimum number of photos the executor must attach to this categoryfalse
needCommentBooleanWhether a comment is required for this categoryfalse
orderNumberIntegerPosition of the category in the listfalse
catalogIdIntegerIdentifier of the catalog the category is linked totrue
catalogValueIdIntegerIdentifier of the catalog value the category is linked totrue
Example:
[
{
"name": "Entrance zone",
"description": "Photos of the entrance and window display",
"minAttachmentsCount": 2,
"needComment": false,
"orderNumber": 1
},
{
"name": "Checkout zone",
"description": "Photos of the checkout area",
"minAttachmentsCount": 1,
"needComment": true,
"orderNumber": 2
}
]
Usages: