v1

latestOpenAPI 3.1.02026-07-14159142161.9 KB
tasksService

Create task

Create task

post/tasks/v1/tasks

Request body

parent_idinteger

Parent task ID

titlestring required

Title of the task

setter_idstring required

ID of the user who set the task

responsible_idstring

ID of the user responsible for the task

deadlineinteger

Deadline timestamp

bodystring

Task description

status'notScheduled' | 'scheduled' | 'inWork' | 'stopped' | 'inControl' | 'ready'
priority'low' | 'notHigh' | 'neutral' | 'high' | 'veryHigh'
accomplices_idsstring[]

IDs of task accomplices

auditors_idsstring[]

IDs of task auditors

department_idinteger

Department ID

group_idstring

Group ID

accept_resultboolean

Whether the task result is accepted

required_resultboolean

Whether a result is required

time_estimateinteger

Estimated time for the task

time_trackingboolean

Whether time tracking is enabled

crm_entity_listboolean

CRM entity list flag

deadline_hourinteger

Deadline hour

deadline_dayinteger

Deadline day

timezone_offsetinteger

Timezone offset

delegationboolean

Delegation flag

created_byinteger required

ID of the user who created the task

created_dateinteger

Created date timestamp

upload_idstring

Upload ID

file_idsinteger[]

List of file IDs

created_atinteger

Created at timestamp

task_typestring

Type of the task

Example request

{
  "scheduler": {
    "period": "day",
    "every": 1246,
    "hour_start": 1246,
    "deadline_hour": 1246,
    "deadline_day": 1246,
    "day_of_week": 1246,
    "date_stop": 1246,
    "iteration": 12,
    "timezone_offset": 1246
  },
  "task_type": "task"
}

Response

OK

idstring
parentIdstring
titlestring
deadlinenumber

timestamp in seconds

closedDatenumber

timestamp in seconds

createdBystring
closedBystring
createdDatenumber

timestamp in seconds

responsibleIdstring

ID of responsible person

bodystring
status'notScheduled' | 'scheduled' | 'inWork' | 'stopped' | 'inControl' | 'ready'
kanbanStageIdstring
priority'low' | 'notHigh' | 'neutral' | 'high' | 'veryHigh'
acceptResultboolean
requiredResultboolean
resultCommentIdstring
departmentIdstring

Department ID

groupIdstring

Group ID

setterIdstring
timeTrackingboolean
timeEstimatenumber

timestamp in seconds

templateboolean
templateIdstring
delegationinteger
taskTypestring
basicTaskboolean
accomplicesIdsstring[]
auditorsIdsstring[]

Example response

{
  "id": "5",
  "parentId": "2",
  "title": "Describe swagger api for tasksService",
  "deadline": 1654180120,
  "closedDate": 1654180120,
  "createdBy": "1",
  "closedBy": "1",
  "createdDate": 1654180120,
  "responsibleId": "1",
  "body": "<b>need use swagger-ui@4.x</b>",
  "kanbanStageId": "2",
  "acceptResult": true,
  "requiredResult": true,
  "resultCommentId": "1",
  "departmentId": "1",
  "groupId": "1",
  "setterId": "1",
  "timeEstimate": 1654180120,
  "templateId": "2",
  "taskType": "task",
  "files": [
    {
      "id": 1,
      "entityType": "post",
      "entityId": 1,
      "uploadId": "369c4620-adee-4526-a0d8-a1db20bcf5b2",
      "originalFilename": "sample.jpg",
      "lastModified": 1664629542,
      "size": 123456,
      "url": "https://aws.s3.amazonaws.com/my-bucket/61/dd/61ddc0045c05ba7537b63e63184b9203.jpg"
    }
  ],
  "accomplicesIds": [
    "2",
    "3"
  ],
  "auditorsIds": [
    "4",
    "5"
  ]
}