ПланФикс API action.update — различия между версиями
Материал из ПланФикс
Seva (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
Строка 17: | Строка 17: | ||
</notifiedList> | </notifiedList> | ||
<isHidden></isHidden> | <isHidden></isHidden> | ||
+ | <analitics> | ||
+ | <analitic> | ||
+ | <id></id> | ||
+ | <analiticData> | ||
+ | <key></key> | ||
+ | <itemData> | ||
+ | <fieldId></fieldId> | ||
+ | <value></value> | ||
+ | </itemData> | ||
+ | <itemData> | ||
+ | <fieldId></fieldId> | ||
+ | <value></value> | ||
+ | </itemData> | ||
+ | <!-- ... --> | ||
+ | </analiticData> | ||
+ | </analitic> | ||
+ | <analitic> | ||
+ | <id></id> | ||
+ | <analiticData> | ||
+ | <key></key> | ||
+ | <itemData> | ||
+ | <fieldId></fieldId> | ||
+ | <value></value> | ||
+ | </itemData> | ||
+ | <itemData> | ||
+ | <fieldId></fieldId> | ||
+ | <value></value> | ||
+ | </itemData> | ||
+ | <!-- ... --> | ||
+ | </analiticData> | ||
+ | </analitic> | ||
+ | <!-- ... --> | ||
+ | </analitics> | ||
</action> | </action> | ||
<signature></signature> | <signature></signature> | ||
Строка 37: | Строка 70: | ||
|- | |- | ||
|isHidden ||bool || является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей || не обязательное поле, по умолчанию равно 0 (false) | |isHidden ||bool || является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей || не обязательное поле, по умолчанию равно 0 (false) | ||
+ | |- | ||
+ | |analitics || || список обновляемых аналитик || не обязательный параметр | ||
+ | |- | ||
+ | |analitics.analitic || || узел, содержащий данные по аналитике || | ||
+ | |- | ||
+ | |analitic.id || int || идентификатор аналитики || список доступных аналитик можно получить при помощи функции [[ПланФикс API analitic.getList|analitic.getList]] | ||
+ | |- | ||
+ | |analitic.analiticData || || список значений полей || | ||
+ | |- | ||
+ | |analiticData.key || int || ключ поля || данное поле становится доступным после выполнения [[ПланФикс API analitic.getData|функции analitic.getData]] | ||
+ | |- | ||
+ | |analiticData.itemData || || значение одного из параметров || | ||
+ | |- | ||
+ | |itemData.fieldId || int || идентификатор параметра || идентификатор параметра равен [[ПланФикс API analitic.getOptions|feild.id]] | ||
+ | |- | ||
+ | |itemData.value || string || значение || | ||
|- | |- | ||
|signature ||string(32)|| подпись || | |signature ||string(32)|| подпись || |
Версия 08:43, 23 декабря 2010
Функция обновления данных в действии. Формат запроса:
<?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>
<analitics>
<analitic>
<id></id>
<analiticData>
<key></key>
<itemData>
<fieldId></fieldId>
<value></value>
</itemData>
<itemData>
<fieldId></fieldId>
<value></value>
</itemData>
<!-- ... -->
</analiticData>
</analitic>
<analitic>
<id></id>
<analiticData>
<key></key>
<itemData>
<fieldId></fieldId>
<value></value>
</itemData>
<itemData>
<fieldId></fieldId>
<value></value>
</itemData>
<!-- ... -->
</analiticData>
</analitic>
<!-- ... -->
</analitics>
</action>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
id | int | идентификатор действия | |
description | string | текст с описанием действия, комментарий | |
taskNewStatus | enum | этим действием меняется статус задачи на указанный | не обязательный параметр, перечень допустимых значений смотри в разделе статусы задач, попытка поменять на неправильный статус или поменять статус не последним действием приведет к ошибке |
notifiedList | этим действием необходимо уведомить следующих пользователей | ||
notifiedList.user | список пользователей которые получат уведомление | ||
notifiedList.user.id | int | идентификатор пользователя | |
isHidden | bool | является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей | не обязательное поле, по умолчанию равно 0 (false) |
analitics | список обновляемых аналитик | не обязательный параметр | |
analitics.analitic | узел, содержащий данные по аналитике | ||
analitic.id | int | идентификатор аналитики | список доступных аналитик можно получить при помощи функции analitic.getList |
analitic.analiticData | список значений полей | ||
analiticData.key | int | ключ поля | данное поле становится доступным после выполнения функции analitic.getData |
analiticData.itemData | значение одного из параметров | ||
itemData.fieldId | int | идентификатор параметра | идентификатор параметра равен feild.id |
itemData.value | string | значение | |
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>