ПланФикс API action.get — различия между версиями
Материал из ПланФикс
Seva (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
Строка 97: | Строка 97: | ||
|id ||int ||идентификатор действия || | |id ||int ||идентификатор действия || | ||
|- | |- | ||
− | |description || || || | + | |description ||string ||описание действия || |
|- | |- | ||
− | |type || || || | + | |type ||enum ||тип действия || список возможных значений смотри в разделе [[ПланФикс API:Список типов действий|типы действий]] |
|- | |- | ||
− | |statusChange || || || | + | |statusChange || || наличие данного узла свидетельствует о том, что этим действием был изменен статус задачи || |
|- | |- | ||
− | |statusChange.oldStatus || || || | + | |statusChange.oldStatus ||enum || старый статус || список допустимых значений смотри [[ПланФикс API:Статусы задач|статусы задач]] |
|- | |- | ||
− | |statusChange.newStatus || || || | + | |statusChange.newStatus ||enum || новый статус ||список допустимых значений смотри [[ПланФикс API:Статусы задач|статусы задач]] |
|- | |- | ||
− | |isNotRead || || || | + | |isNotRead ||bool || действие не помечено как прочитанное || |
|- | |- | ||
− | |dateTime || || || | + | |dateTime ||DateTime ||дата добавления действия || |
|- | |- | ||
− | |timeTracker || || || | + | |timeTracker || ||Если узел есть, этим действием был заполнен там треккинг || |
|- | |- | ||
− | |timeTracker.workDate || || || | + | |timeTracker.workDate ||DateTime ||дата тайм трекинга || |
|- | |- | ||
− | |timeTracker.beginTime || || || | + | |timeTracker.beginTime ||Time ||время начала работ || |
|- | |- | ||
− | |timeTracker.endTime || || || | + | |timeTracker.endTime ||Time ||время окончания действия || |
|- | |- | ||
− | |timeTracker.workKind || || || | + | |timeTracker.workKind || ||тип выполненных работ || |
|- | |- | ||
− | |timeTracker.workKind.id || || || | + | |timeTracker.workKind.id ||int ||идентификатор типа работ || |
|- | |- | ||
− | |timeTracker.workKind.name || || || | + | |timeTracker.workKind.name ||string || название типа работ || |
|- | |- | ||
− | |timeTracker.workKind.workType || || || | + | |timeTracker.workKind.workType || ||вид выполненных работ || |
|- | |- | ||
− | |timeTracker.workKind.workType.id || || || | + | |timeTracker.workKind.workType.id ||int ||идентификатор выполненных работ || |
|- | |- | ||
− | |timeTracker.workKind.workType.name || || || | + | |timeTracker.workKind.workType.name ||string || название выполненных работ|| |
|- | |- | ||
− | |task || || || | + | |task || ||в рамках какой задачи выполнялся || |
|- | |- | ||
− | |task.id || || || | + | |task.id ||int ||идентификатор задачи || |
|- | |- | ||
− | |task.title || || || | + | |task.title ||string || название задачи || |
|- | |- | ||
− | |owner || || || | + | |owner || || пользователь, который создал действие || |
|- | |- | ||
− | |owner.id || || || | + | |owner.id ||int || идентификатор действия || |
|- | |- | ||
− | |owner.name || || || | + | |owner.name ||string || имя пользователя || |
|- | |- | ||
− | |project || || || | + | |project || ||в рамках какого проекта был создано действие || |
|- | |- | ||
− | |project.id || || || | + | |project.id || int|| идентификатор проекта|| |
|- | |- | ||
− | |project.title || || || | + | |project.title ||string || название проекта || |
|- | |- | ||
− | |taskExpectDateChanged || || || | + | |taskExpectDateChanged || || если задан данный узел, то этим действием было изменено время окончание задачи || |
|- | |- | ||
− | |taskExpectDateChanged.oldDate || || || | + | |taskExpectDateChanged.oldDate ||DateTime || прежнее время || |
|- | |- | ||
− | |taskExpectDateChanged.newDate || || || | + | |taskExpectDateChanged.newDate ||DateTime || новое время || |
|- | |- | ||
− | |files || || || | + | |files || || список файлов прикрепленных этим действием|| |
|- | |- | ||
− | |files.file || || || | + | |files.file || || узел, описывающий файл|| |
|- | |- | ||
− | |files.file.id || || || | + | |files.file.id ||int ||идентификатор файла || |
|- | |- | ||
− | | | + | |files.file.name ||string ||имя файла || |
|- | |- | ||
− | |notifiedList | + | |notifiedList || ||список пользователей которых должны уведомить о действии || |
|- | |- | ||
− | |notifiedList.user | + | |notifiedList.user || || пользователь || |
|- | |- | ||
− | |notifiedList.user. | + | |notifiedList.user.id ||int || идентификатор пользователя || |
|- | |- | ||
− | | | + | |notifiedList.user.name ||string || имя пользователя || |
|- | |- | ||
− | |reminder.date || || || | + | |reminder || || напомнить о действии || |
+ | |- | ||
+ | |reminder.date ||DateTime || дата напоминания || | ||
|- | |- | ||
|} | |} |
Версия 12:47, 23 августа 2010
Функция получения информации о действии. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.get">
<account></account>
<sid></sid>
<action>
<id></id>
</action>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
action.id | int | идентификатор действия | |
signature | string(32) | подпись |
Ответ:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<action>
<id></id>
<description></description>
<type></type>
<statusChange>
<oldStatus></oldStatus>
<newStatus></newStatus>
</statusChange>
<isNotRead></isNotRead>
<dateTime></dateTime>
<timeTracker>
<workDate></workDate>
<beginTime></beginTime>
<endTime></endTime>
<workKind>
<id></id>
<name></name>
<workType>
<id></id>
<name></name>
</workType>
</workKind>
</timeTracker>
<task>
<id></id>
<title></title>
</task>
<owner>
<id></id>
<name></name>
</owner>
<project>
<id></id>
<title></title>
</project>
<taskExpectDateChanged>
<oldDate></oldDate>
<newDate></newDate>
</taskExpectDateChanged>
<files>
<file>
<id></id>
<name></name>
</file>
<file>
<id></id>
<name></name>
</file>
<!-- ... -->
</files>
<notifiedList>
<user>
<id></id>
<name></name>
</user>
<user>
<id></id>
<name></name>
</user>
<!-- ... -->
</notifiedList>
<reminder>
<date></date>
</reminder>
</action>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
id | int | идентификатор действия | |
description | string | описание действия | |
type | enum | тип действия | список возможных значений смотри в разделе типы действий |
statusChange | наличие данного узла свидетельствует о том, что этим действием был изменен статус задачи | ||
statusChange.oldStatus | enum | старый статус | список допустимых значений смотри статусы задач |
statusChange.newStatus | enum | новый статус | список допустимых значений смотри статусы задач |
isNotRead | bool | действие не помечено как прочитанное | |
dateTime | DateTime | дата добавления действия | |
timeTracker | Если узел есть, этим действием был заполнен там треккинг | ||
timeTracker.workDate | DateTime | дата тайм трекинга | |
timeTracker.beginTime | Time | время начала работ | |
timeTracker.endTime | Time | время окончания действия | |
timeTracker.workKind | тип выполненных работ | ||
timeTracker.workKind.id | int | идентификатор типа работ | |
timeTracker.workKind.name | string | название типа работ | |
timeTracker.workKind.workType | вид выполненных работ | ||
timeTracker.workKind.workType.id | int | идентификатор выполненных работ | |
timeTracker.workKind.workType.name | string | название выполненных работ | |
task | в рамках какой задачи выполнялся | ||
task.id | int | идентификатор задачи | |
task.title | string | название задачи | |
owner | пользователь, который создал действие | ||
owner.id | int | идентификатор действия | |
owner.name | string | имя пользователя | |
project | в рамках какого проекта был создано действие | ||
project.id | int | идентификатор проекта | |
project.title | string | название проекта | |
taskExpectDateChanged | если задан данный узел, то этим действием было изменено время окончание задачи | ||
taskExpectDateChanged.oldDate | DateTime | прежнее время | |
taskExpectDateChanged.newDate | DateTime | новое время | |
files | список файлов прикрепленных этим действием | ||
files.file | узел, описывающий файл | ||
files.file.id | int | идентификатор файла | |
files.file.name | string | имя файла | |
notifiedList | список пользователей которых должны уведомить о действии | ||
notifiedList.user | пользователь | ||
notifiedList.user.id | int | идентификатор пользователя | |
notifiedList.user.name | string | имя пользователя | |
reminder | напомнить о действии | ||
reminder.date | DateTime | дата напоминания |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>
Значение code | Расшифровка |
---|---|
0000 | неизвестная ошибка |