--- title: "Update Task" method: PUT path: "/api/task-management/v1/tasks/{taskId}" tags: ["Tasks"] --- # Update Task `PUT /api/task-management/v1/tasks/{taskId}` ## Request - Base URL: `https://hostname` - URL: `https://hostname/api/task-management/v1/tasks/{taskId}` - Auth: OAuth 2 - Client credentials - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `ISSUE` Use this API to update an existing task for an object. > 🗒 Things to Know > > - This API currently supports issue tasks. Support for tasks on additional objects may be made available in the future. ## Path parameters - `taskId` string, uuid, required: UUID format of the task identifier ## Query parameters - `taskTypeNameKey` 'Issue', required: String identifier for the task type service ## Request body - TaskUpdateRequest - `taskName` string, required: The name of the task. - `description` string: The description of the task. - `assigneeId` string, uuid: The unique identifier of the user assigned as an assignee on the task. - `assigneeEmail` string: The email address of the user assigned as an assignee on the task. - `collaborators` TaskCollaboratorDto[]: The details of the collaborators assigned to the task. - `collaboratorId` string, uuid: The unique identifier of the user assigned as a collaborator on the task. - `collaboratorEmail` string: The email address of the user assigned as a collaborator on the task. - `type` 'USER' | 'GROUP', required: The type of collaborator. - `deadline` string, date-time: The date and time by which the task should be completed. - `status` 'Open' | 'Closed': The status of the task. - `context` TaskContextInformation - `parameters` object: This parameter can be used to store task details in key value pairs. - `priority` 'LOW' | 'MEDIUM' | 'HIGH': The priority level of the task. - `isRequired` boolean: This flag indicates whether the task is required. - `sourceType` string: The type of source that created the task. - `sourceId` string, uuid: The unique identifier of the source that created the task. ## Response `200` Task updated successfully - TaskInformation - `id` string, uuid, required: The unique identifier of the task. - `parentEntityId` string, uuid, required: The unique identifier of the parent record where the task was created. - `taskName` string, required: The name of the task. - `taskType` TaskTypeInformation, required - `name` string, required: The name of the task type. - `nameKey` string, required: The name key of the task type used for translation purposes. - `module` string, required: The source product of the task type. - `moduleNameTranslationKey` string, required: The name key of the source product used for translation purposes. - `id` string, uuid, required: The unique identifier of the task type. - `label` string, required: The display label of the task type. - `icon` string: The icon of the task type. - `deadline` string, date-time, required: The date and time by which the task should be completed. - `status` 'Open' | 'Closed', required: The status of the task. - `priority` 'LOW' | 'MEDIUM' | 'HIGH', required: The priority level of the task. - `description` string: The description of the task. - `orgGroupId` string, uuid: The unique identifier of the organization responsible for the task. - `orgGroupAttribute` AttributeValue - `valueKey` string, required: The name key of the attribute used for translation purposes. - `value` string, required: The name of the attribute. - `assigneeId` string, uuid: The unique identifier of the user assigned as an assignee on the task. - `isActive` boolean, required: This flag indicates whether the task is active. - `sourceType` string: The type of source that created the task. - `sourceId` string, uuid: The unique identifier of the source that created the task. - `moduleSource` 'ASSESSMENT' | 'AUDIT' | 'CYBER_RISK' | 'DATA_MAPPING' | 'DATA_GOVERNANCE' | 'ESG' | 'ERM' | 'INCIDENT' | 'ISSUE' | 'ITRM' | 'PROGRAM_BENCHMARKING' | 'MATURITY_PLANNING' | 'RISK' | 'VENDOR' | 'VENDOR_PORTAL' | 'COMPLIANCE_MGMT' | 'SPEAK_UP' | 'ENTITY_SCOPE' | 'CONTROL_OBJECTIVE' | 'EXCEPTION': The source product of the task. - `taskAssignmentInformations` TaskAssignmentInformation[]: The details of the task assignment. - `userInfo` UserInformation - `User Name` string: The name of the user or user group. - `User Name With Attributes` string: The name of the user or user group with additional attributes. - `assigneeId` string, uuid, required: The unique identifier of the user or user group assigned to the task. - `type` 'USER' | 'GROUP', required: The type of assignee or collaborator. - `isCollaborator` boolean, required: This flag indicates whether the user or user group was added as a collaborator. - `Presentation Mode` 'NAVIGATION' | 'DRAWER': The presentation mode of the task. - `isCollaboratorSupported` boolean: This flag indicates whether users can be assigned as collaborators on the task. - `isCollaboratorGroupSupported` boolean: This flag indicates whether user groups can be assigned as collaborators on the task. - `relativeUrl` string: The relative URL associated with the task. - `Activity` 'COMPLETE_TASK' | 'REVIEW_DSARSUBTASK' | 'APPROVE_RISK' | 'RESPOND_TO_ASSESSMENT' | 'COMPLETE_AUDIT' | 'REVIEW_REQUEST' | 'COURSE_COMPLETION_PENDING' | 'REVIEW_ASSESSMENT' | 'REVIEW_INCIDENT' | 'IMPLEMENT_CONTROL' | 'RISK_TREATMENT' | 'REVIEW_FINDING' | 'ACKNOWLEDGE_TO_ATTESTATION' | 'REVIEW_INITIATIVE' | 'COMPLETE_DISCLOSURE' | 'COMPLETE_DISCLOSURE_ATTESTATION' | 'EVIDENCE_TASK' | 'COMPLETE_DISC_QUESTIONNAIRE' | 'COMPLIANCE_INITIATIVE' | 'REVIEW_ISSUE' | 'CASE_ASSIGNED' | 'SPEAK_UP_QUESTION_ASSIGNED' | 'CONTROL_OBJECTIVE' | 'REVIEW_EXCEPTION': The type of activity for the task. - `workflowAndStageBasicInformation` object: The details of the workflow and stage. - `workflowId` string, uuid: The unique identifier of the workflow associated with the task. - `workflowStageId` string, uuid: The unique identifier of the workflow stage associated with the task. - `stageName` string: The name of the workflow stage. - `stageNameKey` string: The name key of the workflow stage used for translation purposes. - `badgeColor` string: The badge color of the workflow stage. - `dueDateInfo` DueDateInfo - `date` string, date-time, required: The date and time that the task is due. - `color` string, required: The color code for displaying the task due date. - `icon` string, required: The icon of the task due date. - `textKey` string, required: The text key for the task due date used for translation purposes. - `numberOfDays` integer, required: The number of days until or past the task due date. - `Permissions Metadata` object: The permissions metadata for the task. - `createdBy` string, uuid: The unique identifier of the user who created the task. - `createdByAttribute` AttributeValue - `valueKey` string, required: The name key of the attribute used for translation purposes. - `value` string, required: The name of the attribute. - `createdDT` string, date-time: The date and time that the task was created. - `modifiedBy` string, uuid: The unique identifier of the user who modified the task. - `modifiedByAttribute` AttributeValue - `valueKey` string, required: The name key of the attribute used for translation purposes. - `value` string, required: The name of the attribute. - `modifiedDT` string, date-time: The date and time that the task was modified. - `completionDate` string, date-time: The date and time that the task was completed. - `isRequired` boolean: This flag indicates whether the task is required. - `canEditRequiredTask` boolean: This flag indicates whether the task can be edited. - `pastDue` boolean: This flag indicates whether the task is past due. - `activityKey` string: The key used to identify the type of activity for the task. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview). - `500`: Internal Server Error --- [API](https://skmtc.dev/onetrust/apis/platform-task-management.md) - [All operations](https://skmtc.dev/onetrust/apis/platform-task-management/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/platform-task-management/revisions/cd5f1deef5e8?raw)