Planfix API TaskStatus.getSetList: Difference between revisions
From Planfix
(Created page with "{{#seo: |title=TaskStatus.getSetList/ Get a list of processes |titlemode=append |keywords=Planfix, planfix, getSetList, Get a list, TaskStatus, Task status |description=TaskSt...") |
No edit summary |
||
| Line 20: | Line 20: | ||
|- | |- | ||
|} | |} | ||
Response: | Response: | ||
| Line 34: | Line 35: | ||
</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 56: | Line 59: | ||
</response> | </response> | ||
</source> | </source> | ||
Otherwise, an error response will be returned: | Otherwise, an error response will be returned: | ||
Revision as of 12:34, 23 August 2022
Function for getting a list of task processes. Request format:
<?xml version="1.0" encoding="UTF-8"?>
<request method="taskStatus.getSetList">
<account></account>
<sid></sid>
<signature></signature>
</request>| Name | Type | Value | Notes |
|---|---|---|---|
| signature | string(32) | signature |
Response:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<taskStatusSets totalCount="totalCount">
<taskStatusSet>
<id></id>
<name></name>
</taskStatusSet>
<!-- ... -->
</taskStatusSets>
</response>
| Name | Type | Value | Notes |
|---|---|---|---|
| taskStatusSets | root element, contains a list of task processes | ||
| taskStatusSets totalCount | int | number of task processes | |
| taskStatusSet | root element that describes the process in the list | ||
| id | int | process identifier | |
| name | string | process name |
An empty response will not generate an error. If there are no processes in the resulting selection, the response will look as follows:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<taskStatusSets totalCount="0"></taskStatusSets>
</response>
Otherwise, an error response will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>