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

Версия от 08:29, 31 мая 2021

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

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

Название	Тип	Значение	Примечание
analitic.id	int	идентификатор аналитики	список аналитик можно получить с помощью списка доступных аналитик в ПланФикс
task.id	int	если задано значение, то происходит выборка комментариев только из этой задачи	необязательный параметр
pageCurrent	int	текущая страница
pageSize	int	размер запрашиваемой страницы	не может превышать 100
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.getListWithAnalitic
 |titlemode=append
-|keywords=планфикс, апи, api
+|keywords=планфикс, апи, api, action.getListWithAnalitic
-|description=Получение списка действий с указанной аналитикой
+|description=Получение списка комментариев с указанной аналитикой
 }}
-Получение списка действий с указанной аналитикой:
+Получение списка комментариев с указанной аналитикой:
 <source lang="xml">
 <?xml version="1.0" encoding="UTF-8"?>
@@ Строка 26: / Строка 26: @@
 !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 |-
-|analitic.id ||int || идентификатор аналитики|| список аналитик можно получить с помощью [[ПланФикс API analitic.getList|analitic.getList / Получить список доступных аналитик в ПланФикс ]]
+|analitic.id ||int || идентификатор аналитики|| список аналитик можно получить с помощью [[ПланФикс API analitic.getList| списка доступных аналитик в ПланФикс ]]
 |-
-| task.id ||int || если задано значение, то происходит выборка действий только из этой задачи || необязательный параметр
+| task.id ||int || если задано значение, то происходит выборка комментариев только из этой задачи || необязательный параметр
 |-
 |-
@@ Строка 53: / Строка 53: @@
 !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| Получить комментарий]] ||
 |-
 |}
@@ Строка 71: / Строка 71: @@
 </response>
 </source>