ПланФикс API action.add — различия между версиями
Материал из ПланФикс
								
												
				Seva (обсуждение | вклад)  | 
				Seva (обсуждение | вклад)   | 
				||
| Строка 19: | Строка 19: | ||
     </notifiedList>  |      </notifiedList>  | ||
     <isHidden></isHidden>  |      <isHidden></isHidden>  | ||
| + |     <analitics>  | ||
| + |       <analitic>  | ||
| + |         <id></id>  | ||
| + |         <analiticData>  | ||
| + |           <itemData>  | ||
| + |             <id></id>  | ||
| + |             <value></value>  | ||
| + |           </itemData>  | ||
| + |           <itemData>  | ||
| + |             <id></id>  | ||
| + |             <value></value>  | ||
| + |           </itemData>  | ||
| + |           <!-- ... -->  | ||
| + |         </analiticData>  | ||
| + |       </analitic>  | ||
| + |       <analitic>  | ||
| + |         <id></id>  | ||
| + |         <analiticData>  | ||
| + |           <itemData>  | ||
| + |             <id></id>  | ||
| + |             <value></value>  | ||
| + |           </itemData>  | ||
| + |           <itemData>  | ||
| + |             <id></id>  | ||
| + |             <value></value>  | ||
| + |           </itemData>  | ||
| + |           <!-- ... -->  | ||
| + |         </analiticData>  | ||
| + |       </analitic>  | ||
| + |       <!-- ... -->  | ||
| + |     </analitics>  | ||
   </action>  |    </action>  | ||
   <sirnature></sirnature>  |    <sirnature></sirnature>  | ||
| Строка 41: | Строка 72: | ||
|-  | |-  | ||
|isHidden ||bool || является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей || не обязательное поле, по умолчанию равно 0 (false)  | |isHidden ||bool || является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей || не обязательное поле, по умолчанию равно 0 (false)  | ||
| + | |-  | ||
| + | |analitics  ||  || задается (прикрепляется) список аналитики  || не обязательный параметр  | ||
| + | |-  | ||
| + | |analitics.analitic  ||  || узел, содержащий данные по прикрепляемой аналитике ||  | ||
| + | |-  | ||
| + | |analitic.id  || int  || идентификатор аналитики || список доступных аналитик можно получить при помощи функции [[ПланФикс API analitic.getList|analitic.getList]]  | ||
| + | |-  | ||
| + | |analitic.analiticData  ||  || список значений полей  ||  | ||
| + | |-  | ||
| + | |analiticData.itemData  ||  || значение одного из параметров ||  | ||
| + | |-  | ||
| + | |itemData.feildId  || int  || идентификатор параметра || идентификатор параметра равен [[ПланФикс API analitic.getOptions|feild.id]]  | ||
| + | |-  | ||
| + | |itemData.value  || string || значение ||  | ||
|-  | |-  | ||
|}  | |}  | ||
Версия 09:24, 22 декабря 2010
Добавление действия. Неполная версия функции, будет доробатываться:
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.add">
  <account></account>
  <sid></sid>
  <action>
    <description></description>
    <task>
      <id></id>
    </task>
    <taskNewStatus></taskNewStatus>
    <notifiedList>
      <user>
        <id></id>
        <id></id>
        <!-- ... -->
      </user>
    </notifiedList>
    <isHidden></isHidden>
    <analitics>
      <analitic>
        <id></id>
        <analiticData>
          <itemData>
            <id></id>
            <value></value>
          </itemData>
          <itemData>
            <id></id>
            <value></value>
          </itemData>
          <!-- ... -->
        </analiticData>
      </analitic>
      <analitic>
        <id></id>
        <analiticData>
          <itemData>
            <id></id>
            <value></value>
          </itemData>
          <itemData>
            <id></id>
            <value></value>
          </itemData>
          <!-- ... -->
        </analiticData>
      </analitic>
      <!-- ... -->
    </analitics>
  </action>
  <sirnature></sirnature>
</request>| Название | Тип | Значение | Примечание | 
|---|---|---|---|
| description | string | текст с описанием действия, комментарий | |
| task | задача, в рамках которой выполняется это действие | ||
| task.id | int | идентификатор задачи | |
| taskNewStatus | enum | этим действием меняется статус задачи на указанный | не обязательный параметр, перечень допустимых значений смотри в разделе статусы задач | 
| notifiedList | этим действием необходимо уведомить следующих пользователей | необязательный параметрполе | |
| notifiedList.user | список пользователей которые получат уведомление | ||
| notifiedList.user.id | int | идентификатор пользователя | |
| isHidden | bool | является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей | не обязательное поле, по умолчанию равно 0 (false) | 
| analitics | задается (прикрепляется) список аналитики | не обязательный параметр | |
| analitics.analitic | узел, содержащий данные по прикрепляемой аналитике | ||
| analitic.id | int | идентификатор аналитики | список доступных аналитик можно получить при помощи функции analitic.getList | 
| analitic.analiticData | список значений полей | ||
| analiticData.itemData | значение одного из параметров | ||
| itemData.feildId | int | идентификатор параметра | идентификатор параметра равен feild.id | 
| itemData.value | string | значение | 
Результат удачного выполнения запроса:
<?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>
