Planfix API TaskStatus.getListOfSet: Difference between revisions
From Planfix
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
}} | }} | ||
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 | 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: | Request format: | ||
| Line 27: | Line 28: | ||
|- | |- | ||
|} | |} | ||
Response: | Response: | ||
| Line 51: | Line 53: | ||
</response> | </response> | ||
</source> | </source> | ||
{| class="wikitable" style="margin-top: 1em; width:100% " | {| class="wikitable" style="margin-top: 1em; width:100% " | ||
!width="150"|Name !!width="200"| Type !!width="50%"| Value !! Notes | !width="150"|Name !!width="200"| Type !!width="50%"| Value !! Notes | ||
| Line 77: | Line 80: | ||
|- | |- | ||
|} | |} | ||
An empty response will not generate an error. If there are no task statuses in the resulting selection, the response will look as follows: | An empty response will not generate an error. If there are no task statuses in the resulting selection, the response will look as follows: | ||
Revision as of 12:50, 23 August 2022
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">
<account></account>
<sid></sid>
<taskStatusSet>
<id></id>
</taskStatusSet>
<signature></signature>
</request>| Name | Type | Value | Notes |
|---|---|---|---|
| taskStatusSet.id | int | Process identifier | |
| signature | string(32) | signature |
Response:
<?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>| 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) | |
| text.name | 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>
</response>
Otherwise, an error response will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>