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

Материал из Planfix
Перейти к: навигация, поиск
(Новая страница: «Получение списка действий с указанной аналитикой: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request meth...»)
 
Нет описания правки
 
(не показано 8 промежуточных версий 3 участников)
Строка 1: Строка 1:
Получение списка действий с указанной аналитикой:
{{#seo:
|title=ПланФикс API action.getListWithAnalitic
|titlemode=append
|keywords=планфикс, апи, api, action.getListWithAnalitic
|description=Получение списка комментариев с указанной аналитикой
}}
Получение списка комментариев с указанной аналитикой:
<source lang="xml">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
Строка 8: Строка 14:
     <id></id>
     <id></id>
   </analitic>
   </analitic>
  <task>
    <id></id>
  </task>
   <pageCurrent></pageCurrent>
   <pageCurrent></pageCurrent>
   <pageSize></pageSize>
   <pageSize></pageSize>
Строка 16: Строка 25:
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
|-
|-
|analitic.id ||int || идентификатор аналитики|| список аналитик можно получить с помощью [[ПланФикс API analitic.getList|analitic.getList / Получить список доступных аналитик в ПланФикс ]]
|analitic.id ||int || идентификатор аналитики|| список аналитик можно получить с помощью [[ПланФикс API analitic.getList| списка доступных аналитик в ПланФикс ]]
|-
| task.id ||int || если задано значение, то происходит выборка комментариев только из этой задачи || необязательный параметр
|-
|-
|-
| pageCurrent||int || текущая страница ||
| pageCurrent||int || текущая страница ||
|-
|-
| pageSize||int || размер запрашиваемой странице || не может превышать 50
| pageSize||int || размер запрашиваемой страницы || не может превышать 100
|-
|-
| signature||string(32) ||подпись ||
| signature||string(32) ||подпись ||
Строка 30: Строка 42:
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<response status="ok">
   <actions count="count" totalCounr="totalCount">
   <actions count="count" totalCount="totalCount">
     <action><!-- ... --></action>
     <action><!-- ... --></action>
     <action><!-- ... --></action>
     <action><!-- ... --></action>
Строка 40: Строка 52:
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
!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| Получить комментарий]] ||
|-
|-
|}
|}
Строка 58: Строка 70:
</response>
</response>
</source>
</source>




== Перейти ==
== Перейти ==
*[[ПланФикс API:Действия]]
*[[ПланФикс API:Комментарии]]
*[[Коды ошибок]]
*[[Коды ошибок]]
*[[Список функций]]
*[[Список функций]]

Текущая версия от 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>


Перейти