Planfix API task.changeStatus: Difference between revisions

From Planfix
Jump to: navigation, search
(Created page with "{{#seo: |title=Planfix API task.changeStatus |titlemode=append |keywords=планфикс, задачи, статусы, апи, api |description=Planfix API task.changeStatus }} Changes a task's status. Function call format: <source lang="xml"> <?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></...")
 
No edit summary
Line 31: Line 31:
Possible values come from the [[Planfix API: System task statuses|System task statuses]] section; or status IDs received as a result of calling the [[Planfix API taskStatus.getListOfSet|taskStatus.getListOfSet]] function Invalid parameter value: DECLINED (use a different function to decline tasks)
Possible values come from the [[Planfix API: System task statuses|System task statuses]] section; or status IDs received as a result of calling the [[Planfix API taskStatus.getListOfSet|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'''
|dateTime || DateTime  || activation date when changing to status ''On hold''|| required field for status '''ON HOLD'''
|-
|-
|signature ||string(32) || signature||
|signature ||string(32) || signature||

Revision as of 12:09, 11 August 2023

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