ПланФикс API action.update: различия между версиями
Материал из Planfix
Artem (обсуждение | вклад) Нет описания правки |
Artem (обсуждение | вклад) Нет описания правки |
||
(не показаны 3 промежуточные версии 2 участников) | |||
Строка 1: | Строка 1: | ||
{{#seo: | |||
|title=ПланФикс API action.update | |||
|titlemode=append | |||
|keywords=планфикс, действия, апи, api | |||
|description=ПланФикс API action.update | |||
}} | |||
Функция обновления данных в комментарии. Формат запроса: | Функция обновления данных в комментарии. Формат запроса: | ||
<source lang="xml"> | <source lang="xml"> | ||
Строка 67: | Строка 73: | ||
|description ||string ||текст комментария || | |description ||string ||текст комментария || | ||
|- | |- | ||
|taskNewStatus ||enum ||этим | |taskNewStatus ||enum ||этим комментарием меняется статус задачи на указанный ||не обязательный параметр, перечень допустимых значений смотри в разделе [[ПланФикс API:Статусы задач|статусы задач]], попытка поменять на неправильный статус или поменять статус не последним комментарием приведет к ошибке | ||
|- | |- | ||
|notifiedList || ||этим | |notifiedList || ||этим комментарием необходимо уведомить следующих пользователей || | ||
|- | |- | ||
|notifiedList.user || || список пользователей которые получат уведомление || | |notifiedList.user || || список пользователей, которые получат уведомление || | ||
|- | |- | ||
|notifiedList.user.id ||int || идентификатор пользователя || | |notifiedList.user.id ||int || идентификатор пользователя || | ||
|- | |- | ||
|isHidden ||bool || является ли | |isHidden ||bool || является ли комментарий скрытым от всех пользователей, за исключением списка уведомленных пользователей || не обязательное поле, по умолчанию равно 0 (false) | ||
|- | |- | ||
|dateTime || [[ПланФикс API:Тип данных DateTime | DateTime]] || дата/время создания - не обязательный, по | |dateTime || [[ПланФикс API:Тип данных DateTime | DateTime]] || дата/время создания - не обязательный, по умолчанию - не изменяется || может заполняться, только если авторизация была сделана под сотрудником с правами администратора | ||
|- | |- | ||
|analitics || || список обновляемых аналитик || не обязательный параметр | |analitics || || список обновляемых аналитик || не обязательный параметр | ||
Строка 87: | Строка 93: | ||
|analitic.analiticData || || список строк аналитики || | |analitic.analiticData || || список строк аналитики || | ||
|- | |- | ||
|analiticData.key || int || идентификатор строки аналитики, если в | |analiticData.key || int || идентификатор строки аналитики, если в запросе этот атрибут присутствует - происходит изменения аналитики с этим идентификатором, если нет - добавление новой строки аналитики || | ||
|- | |- | ||
|analiticData.itemData || || значение поля аналитики || | |analiticData.itemData || || значение поля аналитики || | ||
|- | |- | ||
|itemData.fieldId || int || идентификатор поля аналитики || идентификаторы можно получить | |itemData.fieldId || int || идентификатор поля аналитики || идентификаторы можно получить методом [[ПланФикс API analitic.getOptions|feild.id]] | ||
|- | |- | ||
|itemData.value || string || значение поля аналитики || | |itemData.value || string || значение поля аналитики || | ||
|- | |- | ||
|deletedAnalitics || || список | |deletedAnalitics || || список удаленных аналитик || | ||
|- | |- | ||
|deletedAnalitics.key || int || ключ данных удаляемой аналитики ||данное поле становится доступным после выполнения [[ПланФикс API analitic.getData|функции analitic.getData]] | |deletedAnalitics.key || int || ключ данных удаляемой аналитики ||данное поле становится доступным после выполнения [[ПланФикс API analitic.getData|функции analitic.getData]] | ||
Строка 102: | Строка 108: | ||
|- | |- | ||
|} | |} | ||
Помните, можно обновлять | Помните, можно обновлять комментарии с типом '''ACTION''' и '''COMMENT'''. Остальные попытки будут вызывать ошибку. | ||
Строка 117: | Строка 123: | ||
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | ||
|- | |- | ||
|action.id ||int ||идентификатор обновляемого | |action.id ||int ||идентификатор обновляемого комментария || | ||
|- | |- | ||
|} | |} | ||
Строка 128: | Строка 134: | ||
</response> | </response> | ||
</source> | </source> | ||
Текущая версия от 08:06, 31 мая 2021
Функция обновления данных в комментарии. Формат запроса:
<?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>
<dateTime></dateTime>
<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>
<itemData>
<fieldId></fieldId>
<value></value>
</itemData>
<itemData>
<fieldId></fieldId>
<value></value>
</itemData>
<!-- ... -->
</analiticData>
</analitic>
<!-- ... -->
</analitics>
<deletedAnalitics>
<key></key>
<key></key>
<!-- ... -->
</deletedAnalitics>
</action>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
id | int | идентификатор комментария | |
description | string | текст комментария | |
taskNewStatus | enum | этим комментарием меняется статус задачи на указанный | не обязательный параметр, перечень допустимых значений смотри в разделе статусы задач, попытка поменять на неправильный статус или поменять статус не последним комментарием приведет к ошибке |
notifiedList | этим комментарием необходимо уведомить следующих пользователей | ||
notifiedList.user | список пользователей, которые получат уведомление | ||
notifiedList.user.id | int | идентификатор пользователя | |
isHidden | bool | является ли комментарий скрытым от всех пользователей, за исключением списка уведомленных пользователей | не обязательное поле, по умолчанию равно 0 (false) |
dateTime | DateTime | дата/время создания - не обязательный, по умолчанию - не изменяется | может заполняться, только если авторизация была сделана под сотрудником с правами администратора |
analitics | список обновляемых аналитик | не обязательный параметр | |
analitics.analitic | узел, содержащий данные по аналитике | ||
analitic.id | int | идентификатор аналитики | список доступных аналитик можно получить при помощи функции analitic.getList |
analitic.analiticData | список строк аналитики | ||
analiticData.key | int | идентификатор строки аналитики, если в запросе этот атрибут присутствует - происходит изменения аналитики с этим идентификатором, если нет - добавление новой строки аналитики | |
analiticData.itemData | значение поля аналитики | ||
itemData.fieldId | int | идентификатор поля аналитики | идентификаторы можно получить методом feild.id |
itemData.value | string | значение поля аналитики | |
deletedAnalitics | список удаленных аналитик | ||
deletedAnalitics.key | int | ключ данных удаляемой аналитики | данное поле становится доступным после выполнения функции analitic.getData |
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>