Planfix API task.updateCustomData: Difference between revisions
From Planfix
Line 69: | Line 69: | ||
== | == Go To == | ||
*[[Planfix API:Tasks]] | *[[Planfix API:Tasks]] | ||
*[[Error codes XML API v1|Error codes]] | *[[Error codes XML API v1|Error codes]] | ||
*[[List of functions]] | *[[List of functions]] |
Latest revision as of 11:35, 15 March 2024
A function for updating a task's custom fields. If a user doesn't have permissions to modify a task and therefore can't use the task.update function, they can still update custom fields.
Request format:
<?xml version="1.0" encoding="UTF-8"?>
<request method="task.updateCustomData">
<account></account>
<sid></sid>
<task>
<id></id>
<general></general>
<customData>
<customValue>
<id></id>
<value></value>
</customValue>
<!-- ... -->
</customData>
</task>
<signature></signature>
</request>
Name | Type | Value | Notes |
---|---|---|---|
id | int | ID of the task being updated | |
general | int | task number (if given, used instead of ID) | |
customData | values of task custom fields | ||
customData.customValue.id | task custom field identifier | ||
customData.customValue.value | custom task field value | (for task set, employee list, and directory entry set field types, separate identifiers with commas in square brackets) |
Response when function is successfully executed:
<?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 being updated |
Otherwise, an error response will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>