ПланФикс API task.update — различия между версиями
Материал из ПланФикс
Seva (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
(не показано 14 промежуточных версий 2 участников) | |||
Строка 1: | Строка 1: | ||
+ | {{#seo: | ||
+ | |title=ПланФикс API task.update | ||
+ | |titlemode=append | ||
+ | |keywords=планфикс, задачи, апи, api | ||
+ | |description=ПланФикс API task.update | ||
+ | }} | ||
+ | |||
Функция обновления информации задачи. Формат запроса: | Функция обновления информации задачи. Формат запроса: | ||
<source lang="xml"> | <source lang="xml"> | ||
Строка 5: | Строка 12: | ||
<account></account> | <account></account> | ||
<sid></sid> | <sid></sid> | ||
+ | <silent></silent> | ||
<task> | <task> | ||
<id></id> | <id></id> | ||
+ | <general></general> | ||
<title></title> | <title></title> | ||
<description></description> | <description></description> | ||
<importance></importance> | <importance></importance> | ||
<status></status> | <status></status> | ||
+ | <statusSet></statusSet> | ||
<checkResult></checkResult> | <checkResult></checkResult> | ||
<owner> | <owner> | ||
Строка 32: | Строка 42: | ||
<endTimeIsSet></endTimeIsSet> | <endTimeIsSet></endTimeIsSet> | ||
<endTime></endTime> | <endTime></endTime> | ||
+ | <isSummary></isSummary> | ||
+ | <duration></duration> | ||
+ | <durationUnit></durationUnit> | ||
+ | <durationIsSet></durationIsSet> | ||
<workers> | <workers> | ||
<users> | <users> | ||
Строка 43: | Строка 57: | ||
<!-- ... --> | <!-- ... --> | ||
</groups> | </groups> | ||
− | </workers> | + | </workers> |
+ | <members> | ||
+ | <users> | ||
+ | <id></id> | ||
+ | <id></id> | ||
+ | <!-- ... --> | ||
+ | </users> | ||
+ | <groups> | ||
+ | <id></id> | ||
+ | <id></id> | ||
+ | <!-- ... --> | ||
+ | </groups> | ||
+ | </members> | ||
+ | <auditors> | ||
+ | <users> | ||
+ | <id></id> | ||
+ | <id></id> | ||
+ | <!-- ... --> | ||
+ | </users> | ||
+ | <groups> | ||
+ | <id></id> | ||
+ | <id></id> | ||
+ | <!-- ... --> | ||
+ | </groups> | ||
+ | </auditors> | ||
+ | <customData> | ||
+ | <customValue> | ||
+ | <id></id> | ||
+ | <value></value> | ||
+ | </customValue> | ||
+ | <!-- ... --> | ||
+ | </customData> | ||
</task> | </task> | ||
<signature></signature> | <signature></signature> | ||
Строка 51: | Строка 96: | ||
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | ||
|- | |- | ||
− | |id||int ||идентификатор обновляемой задачи || | + | |silent||bool ||при значении 1 - об изменении не рассылаются уведомления, не создаются действия и записи в логе задачи || обязательно значение 1 при массовых периодических обновлениях задач |
+ | |- | ||
+ | |id||int ||идентификатор обновляемой задачи || | ||
+ | |- | ||
+ | |general||int ||номер задачи (если задан, используется вместо id)|| | ||
|- | |- | ||
|title ||string ||название задачи || | |title ||string ||название задачи || | ||
Строка 59: | Строка 108: | ||
|importance || enum||срочность || перечень допустимых значений смотри в разделе [[ПланФикс API:Срочность задачи|срочность задач]] | |importance || enum||срочность || перечень допустимых значений смотри в разделе [[ПланФикс API:Срочность задачи|срочность задач]] | ||
|- | |- | ||
− | |status ||enum ||статус задачи || | + | |status ||enum/int ||статус задачи || Допустимы значения из раздела [[ПланФикс API:Системные статусы задач|Системные статусы задач]] или идентификаторы статусов, полученные в результате вызова функции [[ПланФикс API taskStatus.getListOfSet|taskStatus.getListOfSet]] |
+ | |- | ||
+ | |statusSet ||int ||процесс задачи || Идентификаторы процессов можно получить в результате вызова функции [[ПланФикс API taskStatus.getSetList|taskStatus.getSetList]] | ||
|- | |- | ||
|checkResult ||bool ||является ли задача задачей с обязательной проверкой результата || | |checkResult ||bool ||является ли задача задачей с обязательной проверкой результата || | ||
Строка 87: | Строка 138: | ||
|startTime ||Time || время начала работы || в интерфейсе ПланФикс поле ''приступить к работе'' | |startTime ||Time || время начала работы || в интерфейсе ПланФикс поле ''приступить к работе'' | ||
|- | |- | ||
− | |endDateIsSet ||bool || задана ли дата | + | |endDateIsSet ||bool || задана ли дата завершения работы || |
+ | |- | ||
+ | |endDate ||Date || дата завершения работы || в интерфейсе ПланФикс поле ''закончить работу До'' | ||
+ | |- | ||
+ | |endTimeIsSet ||bool || задано ли время завершения работы || | ||
+ | |- | ||
+ | |endTime ||Time || время завершения работы || в интерфейсе ПланФикс поле ''закончить работу До'' | ||
+ | |- | ||
+ | |isSummary ||bool - 0/1|| задача является суммарной || | ||
|- | |- | ||
− | | | + | |durationIsSet||bool - 0/1|| задана ли длительность || |
|- | |- | ||
− | | | + | |duration||int|| длительность || |
|- | |- | ||
− | | | + | |durationUnit||int|| 0 - минуты, 1 - часы, 2 - дни || |
|- | |- | ||
|workers || ||корневой элемент списка исполнителей задачи || | |workers || ||корневой элемент списка исполнителей задачи || | ||
Строка 104: | Строка 163: | ||
|- | |- | ||
|workers.groups.id ||int || идентификатор группы|| | |workers.groups.id ||int || идентификатор группы|| | ||
+ | |- | ||
+ | |members || ||корневой элемент списка участников задачи || | ||
+ | |- | ||
+ | |members.users || || корневой элемент списка участников задачи || | ||
+ | |- | ||
+ | |members.users.id ||int ||идентификатор участника задачи || | ||
+ | |- | ||
+ | |members.groups || ||корневой элемент списка групп участников || | ||
+ | |- | ||
+ | |members.groups.id ||int || идентификатор группы участников || | ||
+ | |- | ||
+ | |auditors || ||корневой элемент списка аудиторов задачи, содержимое аналогично workers и members || | ||
+ | |- | ||
+ | |customData|| ||значения пользовательских полей задачи || | ||
+ | |- | ||
+ | |customData.customValue.id|| ||идентификатор пользовательского поля задачи || | ||
+ | |- | ||
+ | |customData.customValue.value|| ||значение пользовательского поля задачи || (для полей типа набор задач, список сотрудников, набор записей справочника - идентификаторы через запятую в квадратных скобках) | ||
|- | |- | ||
|} | |} |
Текущая версия на 11:12, 11 июня 2020
Функция обновления информации задачи. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="task.update">
<account></account>
<sid></sid>
<silent></silent>
<task>
<id></id>
<general></general>
<title></title>
<description></description>
<importance></importance>
<status></status>
<statusSet></statusSet>
<checkResult></checkResult>
<owner>
<id></id>
</owner>
<parent>
<id></id>
</parent>
<project>
<id></id>
</project>
<client>
<id></id>
</client>
<startDateIsSet></startDateIsSet>
<startDate></startDate>
<startTimeIsSet></startTimeIsSet>
<startTime></startTime>
<endDateIsSet></endDateIsSet>
<endDate></endDate>
<endTimeIsSet></endTimeIsSet>
<endTime></endTime>
<isSummary></isSummary>
<duration></duration>
<durationUnit></durationUnit>
<durationIsSet></durationIsSet>
<workers>
<users>
<id></id>
<id></id>
<!-- ... -->
</users>
<groups>
<id></id>
<id></id>
<!-- ... -->
</groups>
</workers>
<members>
<users>
<id></id>
<id></id>
<!-- ... -->
</users>
<groups>
<id></id>
<id></id>
<!-- ... -->
</groups>
</members>
<auditors>
<users>
<id></id>
<id></id>
<!-- ... -->
</users>
<groups>
<id></id>
<id></id>
<!-- ... -->
</groups>
</auditors>
<customData>
<customValue>
<id></id>
<value></value>
</customValue>
<!-- ... -->
</customData>
</task>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
silent | bool | при значении 1 - об изменении не рассылаются уведомления, не создаются действия и записи в логе задачи | обязательно значение 1 при массовых периодических обновлениях задач |
id | int | идентификатор обновляемой задачи | |
general | int | номер задачи (если задан, используется вместо id) | |
title | string | название задачи | |
description | string | о чем задача, описание | |
importance | enum | срочность | перечень допустимых значений смотри в разделе срочность задач |
status | enum/int | статус задачи | Допустимы значения из раздела Системные статусы задач или идентификаторы статусов, полученные в результате вызова функции taskStatus.getListOfSet |
statusSet | int | процесс задачи | Идентификаторы процессов можно получить в результате вызова функции taskStatus.getSetList |
checkResult | bool | является ли задача задачей с обязательной проверкой результата | |
owner | создатель задачи | необязательное поле. Если не указано - берется пользователь от имени которого выполняется функция | |
owner.id | int | идентификатор пользователя | |
parent | над задача | необязательное поле | |
parent.id | int | идентификатор задачи, которая будет являться над задачей | допустимо значение 0 (ноль) |
project | в рамках какого проекта поставлена задача | ||
project.id | int | идентификатор проекта | |
client | контрагент | необязательный параметр | |
client.id | int | идентификатор контрагента | допустимо значение 0 |
startDateIsSet | bool | задана ли дата начала работы | |
startDate | Date | дата начала работы | в интерфейсе ПланФикс поле приступить к работе |
startTimeIsSet | bool | задано ли время начала работы | |
startTime | Time | время начала работы | в интерфейсе ПланФикс поле приступить к работе |
endDateIsSet | bool | задана ли дата завершения работы | |
endDate | Date | дата завершения работы | в интерфейсе ПланФикс поле закончить работу До |
endTimeIsSet | bool | задано ли время завершения работы | |
endTime | Time | время завершения работы | в интерфейсе ПланФикс поле закончить работу До |
isSummary | bool - 0/1 | задача является суммарной | |
durationIsSet | bool - 0/1 | задана ли длительность | |
duration | int | длительность | |
durationUnit | int | 0 - минуты, 1 - часы, 2 - дни | |
workers | корневой элемент списка исполнителей задачи | ||
workers.users | корневой элемент списка пользователей, которым поставлена задача | ||
workers.users.id | int | идентификатор пользователя которому поставлена задача | |
workers.groups | корневой элемент списка групп, которым поставлена задача | ||
workers.groups.id | int | идентификатор группы | |
members | корневой элемент списка участников задачи | ||
members.users | корневой элемент списка участников задачи | ||
members.users.id | int | идентификатор участника задачи | |
members.groups | корневой элемент списка групп участников | ||
members.groups.id | int | идентификатор группы участников | |
auditors | корневой элемент списка аудиторов задачи, содержимое аналогично workers и members | ||
customData | значения пользовательских полей задачи | ||
customData.customValue.id | идентификатор пользовательского поля задачи | ||
customData.customValue.value | значение пользовательского поля задачи | (для полей типа набор задач, список сотрудников, набор записей справочника - идентификаторы через запятую в квадратных скобках) |
Добавляемые даты могут задаваться в двух форматах. Первый формат короткий, указывается только число, год и месяц. Второй формат - полный, дополнительно указывается время начала/завершения, если того требует задача.
Не указанные параметры (за исключением id) заменяются значениями по умолчанию. В результате выполнения запроса данные задачи обновляются на указанные в запросе.
Ответ при удачном выполнении функции:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<task>
<id></id>
</task>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
task.id | int | идентификатор обновляемой задачи |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>