Saltar al contendio prinicipal

Task Group Data Model

Advertencia

Esta página aún no se encuentra traducida al español.

COTTaskGroup

Description​

A task group stores a workflow group's configuration and contains the tasks that are processed through the workflow group.

JSON Sample​

{
    "_id" : "616eafbda973cd46d72fb841",
    "botUser" : "616eafc8c5b117753c1ae35c",
    "collectionName" : "projects",
    "company" : "613eafd572343ecb53cc8ccc",
    "createdAt" : "2021-10-18T21:53:27.028Z",
    "defaultView" : "kanban",
    "flowType" : "state-machine",
    "group" : "616eafea86d8203cfb2c8c6b",
    "hideClosedAfterDays" : 7,
    "initialStateMachine" : "616eb003c91d4c15104cc1fb",
    "isActive" : true,
    "levelConfig" : [],
    "modifiedAt" : "2021-10-18T21:53:27.028Z",
    "readPermissions" : ["app-access"],
    "taskEditorPermissions" : ["admin-task-write"],
    "taskFollowerPermissions" : ["admin-task-read", "admin-channels-read"],
    "taskPropertyPermissions" : [{
      "property" : "616eb3a8e59baa38b250da97",
      "editor" : ["admin-groups-write", "admin-properties-write"],
      "follower" : ["admin-groups-read"]
    }],
    "writePermissions" : ["admin-*-write"]
}

Fields​

FieldDescriptionTypeNote
_idThe task group's identification codeObjectIdFor internal use only. Do not modify.
botUserCode name of automatically-created bot associated with the workflow group.ObjectId<COTUser>For internal use only. Do not modify.
collectionNameThe workflow group's code name: groups.nameCodestringFor internal use only. Do not modify.
companyThe company the task is found inObjectId<COTCompany>For internal use only. Do not modify.
createdAtDate and time the group was createdISODateYYYY-MM-DDTHH:mm:ss.SSSZ
defaultFilterFilter used to sort tasks in the task view.ObjectId
defaultViewIndicates the default view in the task view section.stringOptions: list, kanban, calendar, gantt, grid
flowTypeDetermines how tasks transition from one state to another.stringstate-machine: state transitions must be predetermined in the setup.
free: freely change from one state to another.
groupIndicates the workflow group associated with the task group.ObjectId<COTGroup>For internal use only. Do not modify.
hideClosedAfterDaysClosed tasks will disappear from the task view after the amount of days indicated.number
initialStateMachineIndicates which workflow the group initiates in.ObjectID<COTSMStateMachine>
isActiveIndicates whether the task group is active or not.boolean
levelConfigUsed to configure the amount of sub-tasks per levels that are permitted. A maximum of 50 bits can be distributed in up to 5 levels.
Example: [20, 20, 10], i.e., 220 on the first level, 220 on the second, and 210 on the third and last level.		number[ ]Must be configured before any tasks exist, cannot be modified afterwards.
modifiedAtIndicates date and time of last modification.ISODateYYYY-MM-DDTHH:mm:ss.SSSZ
readPermissionsPermissions that allow users associated to the task to view task information settings.string[ ]Users need at least one of the permissions in the array.
taskEditorPermissionsPermissions that allow unassociated users to edit the tasks in the group.string[ ]Users need at least one of the permissions in the array.
taskFollowerPermissionsPermissions that allow unassociated users to view the tasks in the group.string[ ]Users need at least one of the permissions in the array.
taskPropertyPermissionsEnables unassociated users –with the proper permissions– to view or edit tasks when a task within the group is in a certain state or has a specific status (additional field).object[ ]Each object represents a state or status used as a permission filter.
taskPropertyPermissions.propertyIndicates either the additional field or status that the task must have or the state the task has to be in to enable unassociated users to view or edit them.ObjectId<COTProperty>Available task statuses can be found in the task's status{1,5} fields as described in the COTTask.
Obtaining task states' objectIDs is described here.
taskPropertyPermissions.editorPermissions that allow unassociated users to edit tasks with the previously indicated status or state.string[ ]Users need at least one of the permissions in the array.
taskPropertyPermissions.followerPermissions that allow unassociated users to view tasks with the previously indicated status or state.string[ ]Users need at least one of the permissions in the array.
writePermissionsPermissions that allow users associated to the task to edit task settings.string[ ]Users need at least one of the permissions in the array.

Deprecated​

FieldDescriptionTypeNote
readonlyboolean

Additional Resources​

Help​