ПланФикс API: Комментарии: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
(Новая страница: « == action.add Добавить действие == == action.update Обновить действие == == action.get Получить действие == == ac...»)
 
Строка 5: Строка 5:


== action.get Получить действие ==
== action.get Получить действие ==
Запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.get">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <id></id>
</request>
</source>
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <action>
    <id></id>
    <description></description>
    <type></type>
    <!-- узел присутствует если действие изменило статус -->
    <statusChange>
      <oldStatus>с какого</oldStatus>
      <newStatus>на какой</newStatus>
    </statusChange>
    <isNotRead>{true|false}</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>
  </action>
</response>
</source>
Значение поля '''type''' смотри в разделе константы [[#Типы действий|Типы действий]]


== action.getList Получить список действий ==
== action.getList Получить список действий ==

Версия от 10:54, 10 августа 2010

action.add Добавить действие

action.update Обновить действие

action.get Получить действие

Запрос:

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.get">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <id></id>
</request>

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <action>
    <id></id>
    <description></description>
    <type></type>
    <!-- узел присутствует если действие изменило статус -->
    <statusChange>
      <oldStatus>с какого</oldStatus>
      <newStatus>на какой</newStatus>
    </statusChange>
    <isNotRead>{true|false}</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>
  </action>
</response>

Значение поля type смотри в разделе константы Типы действий

action.getList Получить список действий

Константы

Ошибки

Перейти

ПланФикс API