Перейти к основному содержимому
API docs by Redocly

Evolutrix CRM Rest API | Tasks (1.0.0)

Download OpenAPI specification:Download

Описание Rest API — методов для взаимодействия с серверной стороной модуля Tasks.

Коллекция Postman со всеми методами.

Расширение ядра

Модуль расширяет некоторые API методы ядра системы. Ниже перечислены соответствующие изменения:

Задачи

Описание методов для взаимодействия с задачами.

index

Возвращает список задач.

В данном методе действует ограничение на максимальное количество возвращаемых связей задач, а именно:

  • Возвращается не более 2 клиентов,
  • Возвращается не более 2 обращений,
  • Возвращается не более 2 пользователей,
  • Возвращается не более 5 меток.

Требуются права доступа:

  • TASK_SHOW

Для получения не связанных с текущим аутентифицированным сотрудником задач дополнительно требуется право доступа TASK_SHOW_ALL.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

sort_by
string
Value: ["id","title","deadline_at","priority","position","created_at","updated_at"]
Example: sort_by=title

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

search
string
Example: search=welcome

Поисковая строка

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

priorities
Array of integers
Items Enum: 0 1 2 3

Массив приоритетов задач.

deadline_at_from
string

Минимальный срок задачи в формате dd.mm.YYYY (01.01.2000).

deadline_at_to
string

Максимальный срок задачи в формате dd.mm.YYYY (01.01.2000).

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у задачи.

has_no_tags
Array of integers

Массив идентификаторов меток, которых НЕ ДОЛЖНО быть у задачи.

clients
Array of integers

Массив идентификаторов клиентов, которые должны быть связаны с задачей.

leads
Array of integers

Массив идентификаторов обращений, которые должны быть связаны с задачей.

users
Array of integers

Массив идентификаторов сотрудников, которые должны быть участниками или исполнителями задачи.

participants
Array of integers

Массив идентификаторов сотрудников, которые должны быть участниками задачи.

executors
Array of integers

Массив идентификаторов сотрудников, которые должны быть исполнителями задачи.

creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями задачи.

users_or_creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями или исполнителями задачи.

statuses
Array of integers

Массив идентификаторов статусов задачи.

types
Array of integers

Массив идентификаторов типов задачи.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новую задачу.

Требуются права доступа:

  • TASK_SHOW
  • TASK_STORE

Дополнительные права доступа:

  • При отсутствии права доступа CLIENT_SHOW полученные в параметре clients клиенты не будут сохранены.
  • При отсутствии права доступа LEAD_SHOW полученные в параметре leads обращения не будут сохранены.
  • При отсутствии права доступа USER_SHOW полученные в параметрах participants и executors сотрудники не будут сохранены.
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные задачи

title
required
string

Заголовок задачи

description
string

Описание задачи

priority
required
integer
Enum: 0 1 2 3

Приоритет задачи (0 - низкий, 1 - обычный, 2 - высокий, 3 - срочный)

deadline_at
string

Срок выполнения задачи (dd.mm.YYYY H:i)

type_id
integer

Уникальный идентификатор типа задачи

status_id
required
integer

Уникальный идентификатор статуса задачи

clients
Array of integers

Массив идентификаторов клиентов (не более 50)

leads
Array of integers

Массив идентификаторов обращений (не более 50)

participants
Array of integers

Массив идентификаторов сотрудников-участников (не более 50)

executors
Array of integers

Массив идентификаторов сотрудников-исполнителей (не более 50)

tags
Array of integers

Массив идентификаторов меток (не более 50)

Responses

Request samples

Content type
application/json
{
  • "title": "Новая задача",
  • "description": "Описание задачи",
  • "result": "Результат выполнения задачи",
  • "deadline_at": "2023-08-29 12:00",
  • "priority": 1,
  • "status_id": 1,
  • "type_id": 9,
  • "clients": [
    ],
  • "leads": [
    ],
  • "participants": [
    ],
  • "executors": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

bulk destroy

Массовое удаление задач.

Требуются права доступа:

  • TASK_SHOW
  • TASK_DESTROY

Для удаления не связанных с текущим аутентифицированным сотрудником задач дополнительно требуется право доступа TASK_SHOW_ALL.

Authorizations:
BearerToken
Request Body schema: application/json
required
ids
required
Array of integers

Массив идентификаторов

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

kanban

Возвращает статусы задач (в количестве, равному параметру statuses_per_page) и задачи с этими статусами.

Предусмотренная в методе пагинация подразумевает постраничное получение статусов задач. Метод следует использовать для первичного построения и постраничной подгрузки колонок kanban доски. Для получения следующих страниц задач в каждой колонке следует использовать метод получения задач с учётом нижеописанного способа формирования списка задач.

Статусы обращений служат колонками kanban доски.

При формировании списка задач происходит выборка задач для каждого статуса. Эта выборка ограничивает задачи для каждого статуса количеством, указанным в параметре tasks_per_page, и при их получении использует обратную (descending) сортировку по полю обращений position.

В данном методе действует ограничение на максимальное количество возвращаемых связей задач, а именно:

  • Возвращается не более 4 клиентов,
  • Возвращается не более 4 обращений,
  • Возвращается не более 4 сотрудников-участников,
  • Возвращается не более 4 сотрудников-исполнителей,
  • Возвращается не более 5 меток.
  • Возвращается не более 4 комментариев.

Требуются права доступа:

  • TASK_SHOW

Для получения не связанных с текущим аутентифицированным сотрудником задач дополнительно требуется право доступа TASK_SHOW_ALL.

Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

tasks_per_page
integer
Default: 25
Enum: 10 25 50

Кол-во отображаемых задач на в каждой колонке статуса.

statuses_per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых статусов.

search
string

Произвольный текстовый запрос для поиска записей.

priorities
Array of integers
Items Enum: 0 1 2 3

Массив приоритетов задач.

deadline_at_from
string

Минимальный срок задачи в формате dd.mm.YYYY (01.01.2000).

deadline_at_to
string

Максимальный срок задачи в формате dd.mm.YYYY (01.01.2000).

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у задачи.

has_no_tags
Array of integers

Массив идентификаторов меток, которых НЕ ДОЛЖНО быть у задачи.

clients
Array of integers

Массив идентификаторов клиентов, которые должны быть связаны с задачей.

leads
Array of integers

Массив идентификаторов обращений, которые должны быть связаны с задачей.

users
Array of integers

Массив идентификаторов сотрудников, которые должны быть участниками или исполнителями задачи.

participants
Array of integers

Массив идентификаторов сотрудников, которые должны быть участниками задачи.

executors
Array of integers

Массив идентификаторов сотрудников, которые должны быть исполнителями задачи.

creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями задачи.

users_or_creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями или исполнителями задачи.

statuses
Array of integers

Массив идентификаторов статусов задачи.

types
Array of integers

Массив идентификаторов типов задачи.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные задачи.

Требуются права доступа:

  • TASK_SHOW

Для получения не связанных с текущим аутентифицированным сотрудником задач дополнительно требуется право доступа TASK_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
taskId
required
integer

Идентификатор задачи

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные задачи.

Требуются права доступа:

  • TASK_SHOW
  • TASK_STORE

Дополнительные права доступа:

  • При отсутствии права доступа CLIENT_SHOW полученные в параметре clients клиенты не будут сохранены.
  • При отсутствии права доступа LEAD_SHOW полученные в параметре leads обращения не будут сохранены.
  • При отсутствии права доступа USER_SHOW полученные в параметрах participants и executors сотрудники не будут сохранены.

Для обновления не связанных с текущим аутентифицированным сотрудником задач дополнительно требуется право доступа TASK_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
taskId
required
integer

Идентификатор задачи

Request Body schema: application/json
required

Данные задачи

title
required
string

Заголовок задачи

description
string

Описание задачи

priority
required
integer
Enum: 0 1 2 3

Приоритет задачи (0 - низкий, 1 - обычный, 2 - высокий, 3 - срочный)

deadline_at
string

Срок выполнения задачи (dd.mm.YYYY H:i)

type_id
integer

Уникальный идентификатор типа задачи

status_id
required
integer

Уникальный идентификатор статуса задачи

clients
Array of integers

Массив идентификаторов клиентов (не более 50)

leads
Array of integers

Массив идентификаторов обращений (не более 50)

participants
Array of integers

Массив идентификаторов сотрудников-участников (не более 50)

executors
Array of integers

Массив идентификаторов сотрудников-исполнителей (не более 50)

tags
Array of integers

Массив идентификаторов меток (не более 50)

Responses

Request samples

Content type
application/json
{
  • "title": "Новая задача",
  • "description": "Описание задачи",
  • "result": "Результат выполнения задачи",
  • "deadline_at": "2023-08-29 12:00",
  • "priority": 1,
  • "status_id": 1,
  • "type_id": 9,
  • "clients": [
    ],
  • "leads": [
    ],
  • "participants": [
    ],
  • "executors": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет задачу.

Требуются права доступа:

  • TASK_SHOW
  • TASK_DESTROY

Для удаления не связанных с текущим аутентифицированным сотрудником задач дополнительно требуется право доступа TASK_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
taskId
required
integer

Идентификатор задачи

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

reorder

Обновляет порядок отображения задачи в Kanban.

Требуются права доступа:

  • TASK_SHOW
  • TASK_STORE

Для обновления не связанных с текущим аутентифицированным сотрудником задач дополнительно требуется право доступа TASK_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
taskId
required
integer

Идентификатор задачи

Request Body schema: application/json
required

Данные задачи

status_id
required
integer

Уникальный идентификатор статуса задачи

position
required
integer

Порядок отображения задачи в колонке указанного статуса

Responses

Request samples

Content type
application/json
{
  • "status_id": 1,
  • "position": 327675
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Параметры задачи, создаваемой при отмене календарного события через автоматическое подтверждение

Описание методов для взаимодействия с параметрами задачи, создаваемой при отмене календарного события через автоматическое подтверждение. Используется при установленном модуле Communication.

show

Возвращает информацию о параметрах задачи, которую необходимо создать при отмене календарного события через автоматическое подтверждение

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет информацию о параметрах задачи, которую необходимо создать при отмене календарного события через автоматическое подтверждение

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные конфигурации задержки между автоматическими подтверждениями календарных событий

is_active
required
boolean

Флаг необходимости создания задачи

title
string

Заголовок задачи. Обязательное поле при положительном значении поля is_active.

description
string

Примечание задачи

priority
integer
Value: [0,1,2,3]

Приоритет задачи. Обязательное поле при положительном значении поля is_active.

status_id
integer

Идентификатор статуса задачи. Обязательное поле при положительном значении поля is_active.

type_id
integer

Идентификатор типа задачи

participants
Array of integers

Массив идентификаторов участников задачи

participants_roles
Array of integers

Массив идентификаторов ролей, сотрудников которых необходимо назначить участниками задачи

participants_by_calendar_event
boolean

Флаг необходимости назначения участниками задачи участников календарного события

executors
Array of integers

Массив идентификаторов исполнителей задачи

executors_roles
Array of integers

Массив идентификаторов ролей, сотрудников которых необходимо назначить исполнителями задачи

executors_by_calendar_event
boolean

Флаг необходимости назначения исполнителями задачи участников календарного события

tags
Array of integers

Массив идентификаторов меток задачи

Responses

Request samples

Content type
application/json
{
  • "is_active": true,
  • "title": "Календарное событие отменено клиентом",
  • "description": "",
  • "priority": 1,
  • "status_id": 1,
  • "type_id": 1,
  • "participants": [
    ],
  • "participants_roles": [
    ],
  • "participants_by_calendar_event": true,
  • "executors": [
    ],
  • "executors_roles": [
    ],
  • "executors_by_calendar_event": true,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}