Planfix API TaskStatus.getListOfSet

From Planfix
Revision as of 12:50, 23 August 2022 by Aliona (talk | contribs)
Jump to: navigation, search

A function for getting a list of process statuses. Returns all statuses that exist in a process's status set. To get a list of statuses that a task can be changed to at the moment, use the function task.getPossibleStatusToChange

Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="taskStatus.getListOfSet">
Name Type Value Notes int Process identifier
signature string(32) signature


<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <taskStatuses totalCount="totalCount">
        <!-- ... -->
    <!-- ... -->
Name Type Value Notes
taskStatuses root element, contains a list of task statuses
taskStatuses totalCount int number of statuses in the process's set
taskStatus root element describing the task's status
id int task status identifier
name string task status name
color string color
isActive boolean status: active (1) or inactive (0)
hasDeadline boolean deadlines are (1) or aren't tracked (0) in the given status; if deadlines are tracked in the given status and the task has the given status after the planned completion date, the task changes to overdue
texts information in languages available
text.lang string language designation (currently Russian or English) string status name in this language

An empty response will not generate an error. If there are no task statuses in the resulting selection, the response will look as follows:

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

Otherwise, an error response will be returned:

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

Go To