ПланФикс API action.getList: различия между версиями

Текущая версия от 08:22, 31 мая 2021

Получение списка комментариев в задаче:

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.getList">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
    <general></general>
  </task>
  <contact>
    <general></general>
  </contact>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <sort></sort>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
task (contact)		задача/контакт, из которого получаем комментарии — должен присутствовать только один узел (или task или contact)
task.id	int	идентификатор задачи
task.general	int	номер задачи (если задан, используется вместо id)
contact.general	int	номер контакта
pageCurrent	int	текущая страница
pageSize	int	размер запрашиваемой страницы	не может превышать 100
sort	enum: {asc,desc}	сортировка списка	необязательный параметр, по умолчанию desc
signature	string(32)	подпись

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <actions count="count" totalCount="totalCount">
    <action><!-- ... --></action>
    <action><!-- ... --></action>
    <!-- ... -->
  </actions>
</response>

Название	Тип	Значение
actions		корневой узел содержащий список комментариев
actions count	int	количество комментариев в ответе
actions totalCount	int	количество комментариев удовлетворяющих запросу
action		комментарий, описание параметра смотри в разделе Получить комментарий

В противном случае будет возвращен ответ с ошибкой:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Перейти

@@ Строка 2: / Строка 2: @@
 |title=ПланФикс API action.getList
 |titlemode=append
-|keywords=планфикс, действия, апи, api
+|keywords=планфикс, комментарии, апи, api, action.getList
-|description=Получение списка действий в задаче
+|description=Получение списка комментариев в задаче
 }}
-Получение списка действий в задаче:
+Получение списка комментариев в задаче:
 <source lang="xml">
 <?xml version="1.0" encoding="UTF-8"?>
@@ Строка 28: / Строка 28: @@
 !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 |-
-|task (contact) || ||задача/контакт, из которого получаем действие - должен присутствовать только один узел (или task или contact) ||
+|task (contact) || ||задача/контакт, из которого получаем комментарии — должен присутствовать только один узел (или task или contact) ||
 |-
 |task.id ||int ||идентификатор задачи ||
@@ Строка 60: / Строка 60: @@
 !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 |-
-|'''actions ''' || ||корневой узел содержащий список действий ||
+|'''actions ''' || ||корневой узел содержащий список комментариев ||
 |-
-|'''actions ''' count|| int||количество действий в ответе ||
+|'''actions ''' count|| int||количество комментариев в ответе ||
 |-
-|'''actions ''' totalCount||int || количество действий удовлетворяющих запросу ||
+|'''actions ''' totalCount||int || количество комментариев удовлетворяющих запросу ||
 |-
-|action || || действие. описание параметра смотри в разделе [[ПланФикс API action.get|action.get / Получить действие]] ||
+|action || || комментарий, описание параметра смотри в разделе [[ПланФикс API action.get| Получить комментарий]] ||
 |-
 |}
@@ Строка 78: / Строка 78: @@
 </response>
 </source>