ПланФикс API task.update — различия между версиями

Версия 07:45, 29 декабря 2012

Функция обновления информации задачи. Формат запроса:

<?xml version="1.0" encoding="UTF-8"?>
<request method="task.update">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
    <title></title>
    <description></description>
    <importance></importance>
    <status></status>
    <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>
    <workers>
      <users>
        <id></id>
        <id></id>
        <!-- ... -->
      </users>
      <groups>
        <id></id>
        <id></id>
        <!-- ... -->
      </groups>
    </workers>      
    <auditors>
      <id></id>
      <id></id>
      <!-- ... -->
    </auditors> 
  </task>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
id	int	идентификатор обновляемой задачи	обязательный параметр
title	string	название задачи
description	string	о чем задача, описание
importance	enum	срочность	перечень допустимых значений смотри в разделе срочность задач
status	enum	статус задачи	перечень допустимых значений смотри в разделе статусы задач
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	время начала работы	в интерфейсе ПланФикс поле закончить работу До
workers		корневой элемент списка исполнителей задачи
workers.users		корневой элемент списка пользователей, которым поставлена задача
workers.users.id	int	идентификатор пользователя которому поставлена задача
workers.groups		корневой элемент списка групп, которым поставлена задача
workers.groups.id	int	идентификатор группы
auditors		корневой элемент списка аудиторов задачи
auditors.id	int	идентификатор пользователя - аудитора задачи

Добавляемые даты могут задаваться в двух форматах. Первый формат короткий, указывается только число, год и месяц. Второй формат - полный, дополнительно указывается время начала/завершения, если того требует задача.

Не указанные параметры (за исключением 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>

Перейти