ONonetrust
Object Task Management

Update Task

Use this API to update an existing task for an object.

🗒 Things to Know

  • This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
put/v1/tasks/{taskId}

Request

  • Base URL
    https://hostname/api/custom-entity
  • URL
    https://hostname/api/custom-entity/v1/tasks/{taskId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: OBJECT_MANAGER, OBJECT_MANAGER_READ, OBJECT_MANAGER_WRITE, INTEGRATION

Path parameters

taskIdstring uuid required

Unique identifier of the task to update

The unique identifier of the task.

Request body

taskNamestring required

The name of the task.

descriptionstring

The description of the task.

assigneeIdstring uuid

The unique identifier of the user assigned as an assignee on the task.

assigneeEmailstring

The email address of the user assigned as an assignee on the task.

deadlinestring date-time

The date and time by which the task should be completed.

status'Open' | 'Closed'

The status of the task.

priority'LOW' | 'MEDIUM' | 'HIGH'

The priority level of the task.

isRequiredboolean

This flag indicates whether the task is required.

sourceTypestring

The type of source that created the task.

sourceIdstring uuid

The unique identifier of the source that created the task.

Example request

{
  "taskName": "Review document",
  "description": "Please review the attached document and provide feedback",
  "assigneeId": "123e4567-e89b-12d3-a456-426614174000",
  "deadline": "2023-12-31T23:59:59",
  "status": "Open",
  "priority": "MEDIUM"
}

Response

OK

idstring uuid required

The unique identifier of the task.

parentEntityIdstring uuid required

The unique identifier of the parent record where the task was created.

taskNamestring required

The name of the task.

deadlinestring 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.

descriptionstring

The description of the task.

orgGroupIdstring uuid

The unique identifier of the organization responsible for the task.

assigneeIdstring uuid

The unique identifier of the user assigned as an assignee on the task.

isActiveboolean required

This flag indicates whether the task is active.

sourceTypestring

The type of source that created the task.

sourceIdstring uuid

The unique identifier of the source that created the task.

moduleSource'assessment' | 'audit-mgmt' | 'cyber-risk' | 'data-mapping' | 'data-governance' | 'esg' | 'erm' | 'incident' | 'issue' | 'itrm' | 'program-benchmarking' | 'maturity-planning' | 'risk' | 'vendor' | 'vendor-portal' | 'compliance-automation' | 'SpeakUp' | 'EntityScoping' | 'ControlObjective' | 'exception'

The source product of the task.

presentationMode'NAVIGATION' | 'DRAWER'

The presentation mode of the task.

isCollaboratorSupportedboolean

This flag indicates whether users can be assigned as collaborators on the task.

isCollaboratorGroupSupportedboolean

This flag indicates whether user groups can be assigned as collaborators on the task.

relativeUrlstring

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.

workflowAndStageBasicInformationobject

The details of the workflow and stage.

workflowIdstring uuid

The unique identifier of the workflow.

workflowStageIdstring uuid

The unique identifier of the workflow stage.

stageNamestring

The name of the workflow stage.

stageNameKeystring

The name key of the workflow stage used for translation purposes.

badgeColorstring

The badge color of the workflow stage.

permissionsMetadataobject

The permissions metadata for the task.

createdBystring uuid

The unique identifier of the user who created the task.

createdDTstring date-time

The date and time that the task was created.

modifiedBystring uuid

The unique identifier of the user who modified the task.

modifiedDTstring date-time

The date and time that the task was modified.

completionDatestring date-time

The date and time that the task was completed.

isRequiredboolean

This flag indicates whether the task is required.

canEditRequiredTaskboolean

This flag indicates whether the task can be edited.

pastDueboolean

This flag indicates whether the task is past due.

activityKeystring

The key of the activity type used for translation purposes.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "taskName": "Document Review Task",
  "status": "Open",
  "priority": "MEDIUM",
  "deadline": "2023-12-31T23:59:59Z",
  "description": "This task requires reviewing document X and providing feedback",
  "assigneeId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "taskType": {
    "id": "type-123",
    "name": "Document Review",
    "description": "Review and approve documents"
  },
  "moduleSource": "PRIVACY_RIGHTS",
  "activity": "COMPLETE_TASK",
  "presentationMode": "DEFAULT",
  "isCollaboratorSupported": true,
  "relativeUrl": "/tasks/review/123",
  "workflowId": "workflow-456",
  "stageName": "Review",
  "isPastDue": false,
  "createdDT": "2023-01-15T14:30:00Z",
  "modifiedDT": "2023-01-20T16:45:00Z",
  "isRequired": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.