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

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
 
(не показано 6 промежуточных версий этого же участника)
Строка 1: Строка 1:
Функция для получения списка статусов набора. Возвращает все статусы, которые присутствуют в наборе.  
Функция для получения списка статусов процесса. Возвращает все статусы, которые присутствуют в наборе статусов процесса.  
Для получения статусов в который можно перевести задачу в данный момент существует функция [[ПланФикс API task.getPossibleStatusToChange|task.getPosibleStatusToChange]]
Для получения статусов в который можно перевести задачу в данный момент существует функция [[ПланФикс API task.getPossibleStatusToChange|task.getPossibleStatusToChange]]


Формат запроса:
Формат запроса:
Строка 17: Строка 17:
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
|-
|-
|taskStatusSet.id || int || Идентификатор набора статусов ||
|taskStatusSet.id || int || Идентификатор процесса ||
|-
|-
|signature ||string(32) || подпись ||
|signature ||string(32) || подпись ||
Строка 31: Строка 31:
       <id></id>
       <id></id>
       <name></name>
       <name></name>
      <color></color>
      <isActive></isActive>
      <hasDeadline></hasDeadline>
      <texts>
        <text>
          <lang></lang>
          <name></name>
        </text>
        <!-- ... -->
      </texts>
     </taskStatus>
     </taskStatus>
     <!-- ... -->
     <!-- ... -->
Строка 41: Строка 51:
|'''taskStatuses''' || || корневой элемент, содержит список статусов задач ||
|'''taskStatuses''' || || корневой элемент, содержит список статусов задач ||
|-
|-
|'''taskStatuses''' totalCount||int ||количество статусов в наборе ||
|'''taskStatuses''' totalCount||int ||количество статусов в наборе процесса||
|-
|-
|taskStatus|| || корневой элемент, описывающий статус задачи ||
|taskStatus|| || корневой элемент, описывающий статус задачи ||
Строка 48: Строка 58:
|-
|-
|name ||string || название статуса задачи||
|name ||string || название статуса задачи||
|-
|color||string || цвет||
|-
|isActive ||boolean || статус активен (1) или неактивен (0) ||
|-
|hasDeadline ||boolean || отслеживаются (1) или не отслеживаются (0) сроки задач в этом статусе, если сроки в данном статусе отслеживаются и задача находится в данном статусе после даты планируемого завершения, она становится просроченной ||
|-
|texts|| || информация на доступных языках ||
|-
|text.lang|| string || обозначение языка (на текущий момент Ru/En) ||
|-
|text.name|| string || название статуса на этом языке ||
|-
|-
|}
|}


Пустой ответ не '''генерирует ошибку'''. Если в результирующую выборку не попадают никакие группы проектов, то ответ будет иметь следующую форму:
Пустой ответ не '''генерирует ошибку'''. Если в результирующую выборку не попадают никакие статусы задач, то ответ будет иметь следующую форму:
<source lang="xml">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>

Текущая версия от 13:51, 18 января 2018

Функция для получения списка статусов процесса. Возвращает все статусы, которые присутствуют в наборе статусов процесса. Для получения статусов в который можно перевести задачу в данный момент существует функция task.getPossibleStatusToChange

Формат запроса: 

<?xml version="1.0" encoding="UTF-8"?>
<request method="taskStatus.getListOfSet">
  <account></account>
  <sid></sid>
  <taskStatusSet>
     <id></id>
  </taskStatusSet>
  <signature></signature>
</request>
Название Тип Значение Примечание
taskStatusSet.id int Идентификатор процесса
signature string(32) подпись

Ответ: 

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <taskStatuses totalCount="totalCount">
    <taskStatus>
      <id></id>
      <name></name>
      <color></color>
      <isActive></isActive>
      <hasDeadline></hasDeadline>
      <texts>
        <text>
          <lang></lang>
          <name></name>
        </text>
        <!-- ... -->
      </texts>
    </taskStatus>
    <!-- ... -->
  </taskStatuses>
</response>
Название Тип Значение Примечание
taskStatuses корневой элемент, содержит список статусов задач
taskStatuses totalCount int количество статусов в наборе процесса
taskStatus корневой элемент, описывающий статус задачи
id int идентификатор статуса задачи
name string название статуса задачи
color string цвет
isActive boolean статус активен (1) или неактивен (0)
hasDeadline boolean отслеживаются (1) или не отслеживаются (0) сроки задач в этом статусе, если сроки в данном статусе отслеживаются и задача находится в данном статусе после даты планируемого завершения, она становится просроченной
texts информация на доступных языках
text.lang string обозначение языка (на текущий момент Ru/En)
text.name string название статуса на этом языке

Пустой ответ не генерирует ошибку. Если в результирующую выборку не попадают никакие статусы задач, то ответ будет иметь следующую форму: 

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <taskStatuses totalCount="0"></taskStatuses>
</response>

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

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


Перейти

Источник — http://planfix.com/ru/help/index.php?title=ПланФикс_API_taskStatus.getListOfSet&oldid=14013