Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Tasks
Tasks

Get Task

Use this API to retrieve a specific task on an object. The response will include details such as the status, priority, and deadline.

🗒 Things to Know

  • This API currently supports issue tasks. Support for tasks on additional objects may be made available in the future.
get/api/task-management/v1/tasks/{taskId}

Path parameters

taskIdstring uuid required

UUID format of the task identifier

The unique identifier of the task.

Query parameters

taskTypeNameKey'Issue' required

String identifier for the task type service

The source product of the task.

Response

Task found

idstring uuid required

Unique identifier for the task

parentEntityIdstring uuid required

Identifier of the parent entity

taskNamestring required

Name of the task

deadlinestring date-time required

Deadline for completing the task

status'Open' | 'Closed' required

Current status of the task

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

Priority level of the task

descriptionstring

Detailed description of the task

orgGroupIdstring uuid

Organization group identifier associated with the task (deprecated)

assigneeIdstring uuid

ID of the task assignee

isActiveboolean required

Indicates if the task is active

sourceTypestring

The source type that created the task

sourceIdstring uuid

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

Source module for the task

presentationMode'NAVIGATION' | 'DRAWER'

The presentation mode for the task

isCollaboratorSupportedboolean

Indicates if collaborators are supported for this task

isCollaboratorGroupSupportedboolean

Indicates if collaborator groups are supported for this task

relativeUrlstring

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'

Activity type for the task

workflowAndStageBasicInformationobject

Basic information about workflow and current stage

workflowIdstring uuid

ID of the workflow associated with the task

workflowStageIdstring uuid

ID of the workflow stage associated with the task

stageNamestring

Name of the current workflow stage

stageNameKeystring

Translation key for the stage name

badgeColorstring

Color of the badge for the current stage

permissionsMetadataobject

Metadata about permissions for this task

createdBystring uuid

ID of the user who created the task (deprecated)

createdDTstring date-time

Date and time when the task was created

modifiedBystring uuid

ID of the user who last modified the task (deprecated)

modifiedDTstring date-time

Date and time when the task was last modified

completionDatestring date-time

Date and time when the task was completed

isRequiredboolean

Indicates if the task is required

canEditRequiredTaskboolean

Indicates if a required task can be edited

pastDueboolean
activityKeystring

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
}