Use this method to update a task from a document of a Codyt project. All properties to update are set in a json.
URL
(PUT) projects/tasks/{taskid}
PARAMETERS
token | The token obtained on connection | Required |
companyid | The id of the company to modify. | Required |
command | A json containing the task information (see below) | Required |
JSON format of "data" parameter
Add only the fields you want to change to a json object:
Example to update these 3 fields: { "customfields": …, "labels": …, "status": … }
| status | See ApiCodytTask for possible values. | Optional |
| deadline | The job deadline. | Optional |
| labels | Set a label: "labels": [ { "id": 10, "value": 1 }, … ] Clear a label: "labels": [ { "id": 10, "value": null }, … ] See Custom labels to get the list of labels. | Optional |
| customfields | A json array containing a list of custom field ids and values. See below for details. Example:
[ {
"Id": "CustomStr1",
"Value": "My field"
},
{
"Id": "CustomStr5",
"Value": "A-2233"
} ]
See Custom fields to get the list of custom fields. | Optional |
| assignment | A json containing assignment details (assignment type, person, etc.). | Optional |
JSON format of field "CustomFields"
| field | The custom string id such as 'CustomStr1', 'CustomStr2', etc. Use method settings/customfields to obtain all available ids. | Required |
| value | The value to set for the custom string | Required |
JSON format of field "assignment"
| mode | The allocation mode. See ApiCodytTask for allocation mode values. | Required |
| kickoff | If True, Always put the job in not started even if it should be inactive. Default value is False. | optional |
| companyid | The company which will do the job. Can be null. | optional |
| personid | The person which will do the job. Can be null. | optional |
RESULTS
None