API task UK

en | uk | ru

Розділ API ERP "UserSide"

Призначення: Робота із завданнями

Додаткові параметри:
action - підкатегорія запиту (можливе значення: див. нижче)

Підкатегорії

add

Доопрацьовано у: 3.19.30 (додано параметр is_high_priority)

Доопрацьовано у: 3.18.43 (додано параметр device_id)

Доопрацьовано у: 3.18.29 (додано параметр deadline_hour)

Доопрацьовано у: 3.17dev1 (виключено параметри usercode, uzelcode і додано параметри customer_id, node_id)

Доопрацьовано у: 3.16dev2 (виключено параметри unit_id, author_operator_id і додано параметри employee_id, author_employee_id)

Доопрацьовано у: 3.12.84 (додано параметр parent_task_id)

Доопрацьовано у: 3.12.38 (додано параметри unit_id, division_id)

Доопрацьовано у: 3.12.26 (додано параметр work_amount)

Доопрацьовано у: 3.12beta31 (додано параметр author_operator_id)

Опис: Створення завдання

Обов'язкові параметри:
 work_typer - ID типу завдання

Необов'язкові параметри:
 apart - номер квартири
 address_id - (для версії 3.13 і пізніше) id адресної одиниці
 author_employee_id - ID співробітника-автора завдання
 author_operator_id - ID оператора-автора завдання (до версії 3.16dev2)
 citycode - (для версії 3.12 і раніше) id населеного пункту. Якщо не вказано, то береться з даних за будинком housecode
 customer_id - (для версії 3.17 і пізніше) ID абонента
 deadline_hour - час на виконання завдання (від дати прийняття. У годинах)
 device_id - ID обладнання
 division_id - ID підрозділу (допускається кілька значень через кому)
 dopf_N - значення додаткового поля для поля ID N
 employee_id - ID виконавця (допускається кілька значень через кому)
 fio - ПІБ клієнта (мається на увазі, що "клієнт" ще не є абонентом)
 housecode - (для версії 3.12 і раніше) id будівлі. Якщо не вказано, то береться з даних за абонентом - customer_id, або з даних по об'єкту інфраструктури - node_id
 is_high_priority - прапорець - високий пріоритет
 node_id - (для версії 3.17 і пізніше) ID об'єкти інфраструктури
 opis - нотатки до завдання
 parent_task_id - ID батьківського завдання
 unit_id - ID виконавця (допускається кілька значень через кому) (до версії 3.16dev2)
 usercode - (для версії 3.16 і раніше) ID абонента
 uzelcode - (для версії 3.16 і раніше) ID об'єкти інфраструктури
 work_amount - обсяг робіт
 work_datedo - дата, на яку призначено виконання завдання

add_cable_line_to_task

Додано у: 3.20.2

Опис: Додавання кабельної лінії до завдання

Обов'язкові параметри:
 task_id - id завдання
 cable_line_id - id кабельної лінії

add_customer_to_task

Додано у: 3.13.70

Опис: Додавання абонента до завдання

Обов'язкові параметри:
 task_id - id завдання
 customer_id - id абонента

add_device_to_task

Додано у: 3.19beta1

Опис: Додавання обладнання до завдання

Обов'язкові параметри:
 task_id - id завдання
 device_id - id обладнання

add_node_to_task

Додано у: 3.20.17

Опис: Додавання об'єкти інфраструктури до завдання

Обов'язкові параметри:
 task_id - id завдання
 node_id - id об'єкти інфраструктури

add_owner_to_task

Додано у: 3.19.19

Опис: Додавання власника до завдання

Обов'язкові параметри:
 task_id - id завдання
 owner_id - id власника

change_date_work

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Додано у: 3.12.83

Опис: Зміна даты і времени выполнения завдання (дата, на которую назначены работы)

Обов'язкові параметри:
 id - id завдання
 value - дата
Необов'язкові параметри:
 employee_id - id співробітника-инициатора (для фиксации в историю по заданию)
 operator_id - id оператора-инициатора (для фиксации в историю по заданию) (до версії 3.16dev2)

change_state

Доопрацьовано у: 3.20.3 (додано параметр date_hold)

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Опис: Изменения состояния (статуса) завдання

Обов'язкові параметри:
 id - id завдання
 state_id - id состояния завдання
Необов'язкові параметри:
 employee_id - id співробітника, от имени которого изменять стан
 operator_id - id оператора, от имени которого изменять стан (до версії 3.16dev2)
 date_hold - дата/час до которой отложить завдання (при переводе в статус с ролью "Отложено")

check_verify_code

Опис: Проверка кода подтверждения для выполнения заявки

Обов'язкові параметри:
 id - ID завдання
 verify_code - код подтверждения

checklist_item_check

Додано у: 3.17dev1

Опис: Отметка пункта чек-листа в задании

Обов'язкові параметри:
 id - id пункта чек-листа
 task_id - id завдання
 employee_id - id співробітника, от имени которого помечается пункт

checklist_item_uncheck

Додано у: 3.17dev1

Опис: Снятие отметки с пункта чек-листа в задании

Обов'язкові параметри:
 id - id пункта чек-листа
 task_id - id завдання

comment_add

Доопрацьовано у: 3.17dev1 (додано параметр dateadd)

Доопрацьовано у: 3.16.19 (додано параметр reply_comment_id)

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Доопрацьовано у: 3.12.89 (додано параметр author_operator_id)

Опис: Додавання комментария

Обов'язкові параметри:
 id - ID завдання
 comment - текст
Необов'язкові параметри:
 dateadd - дата-час комментария
 employee_id - id співробітника, от имени которого коментар
 operator_id - id оператора, от имени которого коментар (до версії 3.16dev2)
 reply_comment_id - id комментария, на который отвечаем

comment_edit

Додано у: 3.18beta1

Опис: Зміна комментария

Обов'язкові параметри:
 id - ID комментария
 task_id - ID завдання
 body - текст

delete

Додано у: 3.14.35

Опис: Видалення завдання

Обов'язкові параметри:
 id - id завдання

division_add

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Додано у: 3.13.36

Опис: Додавання підрозділу

Обов'язкові параметри:
 id - id завдання
 division_id - id підрозділу
Необов'язкові параметри:
 employee_id - id співробітника-инициатора (для фиксации в историю по заданию)
 operator_id - id оператора-инициатора (для фиксации в историю по заданию) (до версії 3.16dev2)

division_delete

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Додано у: 3.13.36

Опис: Исключение підрозділу

Обов'язкові параметри:
 id - id завдання
 division_id - id підрозділу
Необов'язкові параметри:
 employee_id - id співробітника-инициатора (для фиксации в историю по заданию)
 operator_id - id оператора-инициатора (для фиксации в историю по заданию) (до версії 3.16dev2)

edit

Доопрацьовано у: 3.20.23 (додано параметр customer_name)

Доопрацьовано у: 3.19.41 (додано параметр author_employee_id)

Доопрацьовано у: 3.19.30 (додано параметр is_high_priority)

Доопрацьовано у: 3.19.15 (додано параметр job_time_hour)

Доопрацьовано у: 3.19.12 (додано параметр apartment)

Доопрацьовано у: 3.18.30 (додано параметр deadline_hour)

Доопрацьовано у: 3.18beta1 (додано параметр address_id)

Доопрацьовано у: 3.16dev3 (додано параметр type_id)

Доопрацьовано у: 3.15.12 (додано параметр parent_task_id)

Додано у: 3.13.18

Опис: Зміна завдання

Обов'язкові параметри:
 id - id завдання
Необов'язкові параметри:
 address_id - id адресної одиниці
 apartment - номер квартири
 author_employee_id - id співробітника - автора завдання
 customer_name - произвольное имя/назва клієнта (без привязки к абоненту)
 body - текст завдання (описательная часть)
 deadline_hour - час на виконання завдання (від дати прийняття. У годинах)
 is_high_priority - прапорець - високий пріоритет
 job_time_hour - час на виконання завдання (с даты начала работ. В часах)
 parent_task_id - id батьківського завдання
 type_id - id типа завдання

employee_add

Додано у: 3.16dev2

Опис: Додавання виконавця

Обов'язкові параметри:
 id - id завдання
 employee_id - id виконавця
Необов'язкові параметри:
 author_employee_id - id співробітника-инициатора (для фиксации в историю по заданию)

employee_delete

Додано у: 3.16dev2

Опис: Исключение виконавця

Обов'язкові параметри:
 id - id завдання
 employee_id - id виконавця
Необов'язкові параметри:
 author_employee_id - id співробітника-инициатора (для фиксации в историю по заданию)

get_allow_staff

Додано у: 3.15.23

Опис: Список виконавців і підрозділів, которые доступны для назначення на завдання (согласно настроек)

Обов'язкові параметри:
 id - id завдання

get_catalog_type

Додано у: 3.12.22

Опис: Типы заданий

Необов'язкові параметри:
 id - id типа заданий (можна через кому)

get_catalog_type_group

Додано у: 3.16dev3

Опис: Группы типов заданий

get_catalog_state

Доопрацьовано у: 3.19.1 (додано параметр type_id)

Додано у: 3.12.22

Опис: Классификатор состояний заданий

Необов'язкові параметри:
 type_id - id типа завдання
 state_id - id состояния (можна через кому)

get_comment

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Доопрацьовано у: 3.14.67 (додано параметр id)

Доопрацьовано у: 3.14.53 (додано параметр operator_id)

Доопрацьовано у: 3.13.50 (додано параметри date_add_from і date_add_to)

Додано у: 3.12.75

Опис: Комментарии

Необов'язкові параметри (но должен быть хотя-бы один):
 id - id комментария (можна через кому)
 task_id - id заданий (можна через кому)
 date_add_from - дата додавання комментария (с)
 date_add_to - дата додавання комментария (до)
 employee_id - id співробітника-автора комментария
 operator_id - id оператора-автора комментария (до версії 3.16dev2)

get_list

Доопрацьовано у: 3.18.43 (додано параметр device_id)

Доопрацьовано у: 3.18.40 (додано параметр apart)

Доопрацьовано у: 3.18.30 (додано параметри change_operation_type, change_employee_id)

Доопрацьовано у: 3.18beta1 (додано параметр address_id)

Доопрацьовано у: 3.16dev3 (додано параметри task_position, task_position_radius, из параметра order_by исключены возможные значення customer_id і house_id)

Доопрацьовано у: 3.16dev2 (виключено параметри closer_operator_id, staff_id, author_id, watcher_id додано параметри closer_employee_id, employee_id, author_employee_id, watcher_employee_id)

Доопрацьовано у: 3.15.23 (додано параметр is_expired)

Доопрацьовано у: 3.14.71 (додано параметр node_id)

Доопрацьовано у: 3.14.62 (додано параметр closer_operator_id)

Доопрацьовано у: 3.14.56 (додано параметр division_id_with_staff)

Доопрацьовано у: 3.14.41 (в параметр staff_id добавлено возможное значення -1)

Доопрацьовано у: 3.13.29 (додано параметри date_change_from, date_change_to)

Доопрацьовано у: 3.13.28 (в параметр order_by добавлен вариант date_change)

Доопрацьовано у: 3.12.91 (додано параметр watcher_id)

Доопрацьовано у: 3.12.83 (додано параметр author_id)

Доопрацьовано у: 3.12.78 (додано параметри order_by, limit, offset)

Доопрацьовано у: 3.12.62 (додано параметр customer_id)

Доопрацьовано у: 3.12.24 (додано параметри date_do_from, date_do_to)

Доопрацьовано у: 3.12beta29 (додано параметр house_id)

Опис: Список заданий (идентификаторы)

Необов'язкові параметри (условия выборки):
 address_id - ID адресного об'єкта (можна через кому)
 apart - номер квартири/помещения
 author_id - ID оператора - автора завдання (можна через кому) (до версії 3.16dev2)
 author_employee_id - ID співробітника - автора завдання (можна через кому)
 change_employee_id - ID співробітника - автора изменений по заданию
 change_operation_type - тип действий по изменению завдання (возможные значення: add_comment, change_state)
 closer_employee_id - ID співробітника, который закрыл (выполнил) завдання (можна через кому)
 closer_operator_id - ID оператора, который закрыл (выполнил) завдання (можна через кому) (до версії 3.16dev2)
 customer_id - ID абонента (можна через кому)
 date_add_from - дата создания завдання (с)
 date_add_to - дата создания завдання (до)
 date_change_from - дата обновления завдання (с)
 date_change_to - дата обновления завдання (до)
 date_do_from - дата, на яку призначено виконання завдання (с)
 date_do_to - дата, на яку призначено виконання завдання (до)
 date_finish_from - дата выполнения завдання (с)
 date_finish_to - дата выполнения завдання (до)
 device_id - ID обладнання (можна через кому)
 division_id - ID підрозділу (можна через кому)
 division_id_with_staff - ID підрозділу (в т.ч. с завданнями співробітников этого підрозділу) (можна через кому)
 employee_id - ID виконавця (можна через кому, используйте -1 для получения заданий без виконавців)
 house_id - ID будинока работ
 is_expired - прапорець - выводить только просроченные завдання
 node_id - ID об'єкта розміщення
 staff_id - ID виконавця (можна через кому, используйте -1 для получения заданий без виконавців) (до версії 3.16dev2)
 state_id - ID статуса заданий (можна через кому)
 task_position - координати завдання (там где это возможно. В формате lat,lng. Напр: 40.245218,52.333384)
 task_position_radius - радіус от task_position (в метрах)
 type_id - ID типа заданий (можна через кому)
 watcher_id - ID оператора-наблюдателя за завданням (можна через кому) (до версії 3.16dev2)
 watcher_employee_id - ID співробітника-наблюдателя за завданням (можна через кому)
 order_by - поле для сортировки (возможные варианты: date_add, date_change, date_do, date_finish, state_id, type_id)
 limit - лимит выборки записей
 offset - смещение выборки

get_related_task_id

Опис: Список связанных заданий с текущим завданням (идентификаторы)

Обов'язкові параметри:
 id - ID завдання

get_typical_comments

Додано у: 3.14.70

Опис: Отримання списка типовых комментариев

mark_add

Додано у: 3.19.24

Опис: Додавання метки на завдання
Обов'язкові параметри:
 task_id - id завдання
 mark_id - id метки

mark_delete

Додано у: 3.19.24

Опис: Видалення метки с завдання
Обов'язкові параметри:
 task_id - id завдання
 mark_id - id метки

overview_task

Додано у: 3.19.7

Опис: Фиксация факта просмотра завдання співробітником

Обов'язкові параметри:
 task_id - id завдання
 employee_id - id співробітника

remove_cable_line_from_task

Додано у: 3.20.2

Опис: Исключение кабельної лінії с завдання

Обов'язкові параметри:
 task_id - id завдання
 cable_line_id - id кабельної лінії

remove_customer_from_task

Додано у: 3.15.23

Опис: Исключение абонента с завдання

Обов'язкові параметри:
 task_id - id завдання
 customer_id - id абонента

remove_node_from_task

Додано у: 3.20.17

Опис: Исключение об'єкти інфраструктури с завдання

Обов'язкові параметри:
 task_id - id завдання
 node_id - id об'єкти інфраструктури

remove_owner_from_task

Додано у: 3.19.19

Опис: Исключение власника с завдання

Обов'язкові параметри:
 task_id - id завдання
 owner_id - id власника

set_rate

Додано у: 3.12.63

Опис: Указание индивидуального тарифа (для співробітников) по заданию

Обов'язкові параметри:
 task_id - ID завдання
 rate - тариф

show

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Доопрацьовано у: 3.13.29 (в параметре id можно подавать список через кому)

Доопрацьовано у: 3.13.25 (додано параметр is_without_comments)

Доопрацьовано у: 3.12.64 (додано параметр operator_id)

Опис: Информация о задании

Обов'язкові параметри:
 id - id завдання (можна через кому)
Необов'язкові параметри:
 employee_id - id співробітника, который просматривает это завдання (для фиксации в историю по заданию)
 is_without_comments - прапорець - не выводить комментарии в информации по заданию
 operator_id - id оператора, который просматривает это завдання (для фиксации в историю по заданию) (до версії 3.16dev2)

(*) staff_add

Виключено у: 3.16dev2 (используйте API->task->employee_add)

Додано у: 3.12.83

Опис: Додавання виконавця

Обов'язкові параметри:
 id - id завдання
 staff_id - id виконавця
Необов'язкові параметри:
 operator_id - id оператора-инициатора (для фиксации в историю по заданию)

(*) staff_delete

Виключено у: 3.16dev2 (используйте API->task->employee_delete)

Додано у: 3.12.83

Опис: Исключение виконавця

Обов'язкові параметри:
 id - id завдання
 staff_id - id виконавця
Необов'язкові параметри:
 operator_id - id оператора-инициатора (для фиксации в историю по заданию)

watcher_add

Доопрацьовано у: 3.16dev2 (виключено параметри staff_id, operator_id, додано параметри employee_id, author_employee_id)

Додано у: 3.14.21

Опис: Додавання наблюдателя

Обов'язкові параметри:
 id - id завдання
 employee_id - id наблюдателя
 staff_id - id наблюдателя (до версії 3.16dev2)
Необов'язкові параметри:
 author_employee_id - id співробітника-инициатора (для фиксации в историю по заданию)
 operator_id - id оператора-инициатора (для фиксации в историю по заданию) (до версії 3.16dev2)

watcher_delete

Доопрацьовано у: 3.16dev2 (виключено параметри staff_id, operator_id, додано параметри employee_id, author_employee_id)

Додано у: 3.14.21

Опис: Исключение наблюдателя

Обов'язкові параметри:
 id - id завдання
 employee_id - id наблюдателя
 staff_id - id наблюдателя (до версії 3.16dev2)
Необов'язкові параметри:
 author_employee_id - id співробітника-инициатора (для фиксации в историю по заданию)
 operator_id - id оператора-инициатора (для фиксации в историю по заданию) (до версії 3.16dev2)