Update

Operation: Update

Updates a task.


POST /api/v01/Task/rest/Update
Content-Type: application/json


Request body

Accepts the same fields as Create, plus the following:


FieldTypeDescription
TaskData.TaskID / TaskData.TaskKey / TaskData.IntegrationIDstringTask key; exactly one is required
TaskKeyFieldstringLeading key name
TaskData.ResolutionIDstringResolution
TaskData.VotesnumberVote counter
TaskData.LabelsarrayMultiple labels
TaskData.ComponentsarrayMultiple components
TaskData.FixVersionsarrayMultiple versions


Additional query parameters (passed in the URL, not the body):


ParameterValueEffect
DescriptionHTML stringOverwrites the task's RTE description
SendNotification_F'0' / '1'Send notifications to subscribers and watchers


Validation

  • One of the task keys must be present: TaskID, TaskKey, or IntegrationID.
  • ProjectID or ProjectCode must be provided.
  • Without TaskData or without the listed keys — HTTP 500, "Wrong parameters".


Side effects

  • When a new Description is supplied in the query parameters: the previous description is read from the attachments subsystem; an HTML diff is generated (with added/removed fragments highlighted); a history entry is created and the diff is saved into it as a separate RTE attachment.
  • If SendNotification_F=1, notifications are sent to interested parties.


Response

Success:


{
  "status": "Success",
  "statusCode": 200,
  "details": {
    "TaskKey": "PROJ-42",
    "TaskID": "0000004242"
  }
}


Example

Change the assignee and status of task PROJ-42 without sending notifications:


POST /api/v01/Task/rest/Update
Content-Type: application/json

{
  "TaskKeyField": "TaskKey",
  "TaskData": {
    "TaskKey": "PROJ-42",
    "ProjectCode": "PROJ",
    "AssigneeID": "0000005678",
    "StatusID": "20"
  }
}