Planfix API task.changeStatus

From Planfix
Revision as of 09:41, 6 March 2024 by Dmitri (talk | contribs) (→‎Go To)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Changes a task's status. Function call format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="task.changeStatus">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
    <general></general>
  </task>
  <status></status>
  <dateTime></dateTime>
  <signature></signature>
</request>
Name Type Value Notes
task.id int task identifier
general int task number (if given, used instead of ID)
status enum new task status

Possible values come from the System task statuses section; or status IDs received as a result of calling the taskStatus.getListOfSet function Invalid parameter value: DECLINED (use a different function to decline tasks)

dateTime DateTime activation date when changing to status On hold required field for status ON HOLD
signature string(32) signature


Response:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <task>
    <id></id>
  </task>
</response>
Name Type Value Notes
task.id int ID of the task with the updated status


Otherwise, an error response will be returned:

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


Go To