ONonetrust
Tasks

Create Task

Use this API to create a new 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.
post/api/task-management/v1/tasks

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/task-management/v1/tasks
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ISSUE

Request body

parentEntityIdstring uuid required

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

taskNamestring required

The name of the task.

descriptionstring

The description of the task.

orgGroupIdstring uuid required

The unique identifier of the organization responsible for the task.

taskTypeNameKeystring required

The key that identifies the type of activity for 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.

isActiveboolean

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.

resourceIdstring uuid

The unique identifier of the resource.

resourceTypeNameKeystring

The key used to identify the type of resource.

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.

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

The priority level of the task.

isRequiredboolean

This flag indicates whether the task is required.

Example request

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

Response

Task created successfully

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

Presentation Mode'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 associated with the task.

workflowStageIdstring uuid

The unique identifier of the workflow stage associated with the task.

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.

Permissions Metadataobject

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 used to identify the type of activity for the task.

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
}

Changes

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