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

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

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

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

Название	Тип	Значение	Примечание
fromDate	DateTime	начало периода
toDate	DateTime	конец периода
pageCurrent	int	текущая страница
pageSize	int	размер запрашиваемой страницы	не может превышать 100
sort	enum: {asc,desc}	сортировка списка	необязательный параметр, по умолчанию desc
task.id	int	идентификатор задачи	необязательный параметр, по умолчанию выбираются комментарии по всем задачам
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.getListByPeriod
 |titlemode=append
-|keywords=планфикс, действия, апи, api
+|keywords=планфикс, комментарии, апи, api, action.getListByPeriod
 |description= ПланФикс API action.getListByPeriod
 }}
-Получение списка всех действий за заданный период времени:
+Получение списка всех комментариев за заданный период времени:
 <source lang="xml">
 <?xml version="1.0" encoding="UTF-8"?>
@@ Строка 36: / Строка 36: @@
 | sort||enum: {asc,desc} || сортировка списка || необязательный параметр, по умолчанию desc
 |-
-| task.id||int || идентификатор задачи || необязательный параметр, по умолчанию выбираются действия по всем задачам
+| task.id||int || идентификатор задачи || необязательный параметр, по умолчанию выбираются комментарии по всем задачам
 |-
 | signature||string(32) ||подпись ||
@@ Строка 56: / Строка 56: @@
 !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| Получить комментарий]] ||
 |-
 |}
@@ Строка 74: / Строка 74: @@
 </response>
 </source>