ПланФикс API action.update
Материал из Planfix
Функция обновления данных в действии. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.update">
<account></account>
<sid></sid>
<action>
<id></id>
<description></description>
<taskNewStatus></taskNewStatus>
<notifiedList>
<user>
<id></id>
<id></id>
<!-- ... -->
</user>
</notifiedList>
<isHidden></isHidden>
</action>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
id | int | идентификатор действия | |
description | string | текст с описанием действия, комментарий | |
taskNewStatus | enum | этим действием меняется статус задачи на указанный | не обязательный параметр, перечень допустимых значений смотри в разделе статусы задач, попытка поменять на неправильный статус или поменять статус не последним действием приведет к ошибке |
notifiedList | этим действием необходимо уведомить следующих пользователей | ||
notifiedList.user | список пользователей которые получат уведомление | ||
notifiedList.user.id | int | идентификатор пользователя | |
isHidden | bool | является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей | не обязательное поле, по умолчанию равно 0 (false) |
signature | string(32) | подпись |
Помните, можно обновлять действия с типом ACTION и COMMENT. Остальные попытки будут вызывать ошибку.
Результат удачного выполнения запроса:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<action>
<id></id>
</action>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
action.id | int | идентификатор обновляемого действия |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>