OneTrust Platform — Task Management

{"openapi":"3.1.0","info":{"title":"Platform - Task Management","description":"The Task Management APIs are used to integrate external systems and streamline the flow of data for tasks created across the OneTrust Platform.","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my.onetrust.com/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}},"servers":[{"url":"https://{hostname}","variables":{"hostname":{"default":"hostname","description":"The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."}}}],"tags":[{"name":"Tasks","description":"The Tasks APIs are used to manage tasks, including creation, updates, and retrieval.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-task-management.json"}}],"x-onetrust":{"spec-label":"OpenAPI 3.1.0"},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"paths":{"/api/task-management/v1/tasks":{"post":{"operationId":"createTaskUsingPOST","summary":"Create Task","description":"Use this API to create a new task for an object.\n\n> 🗒 Things to Know\n> \n> - This API currently supports issue tasks. Support for tasks on additional objects may be made available in the future.","tags":["Tasks"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-task-management.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskCreateRequest"}}}},"responses":{"201":{"description":"Task created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInformation"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["ISSUE"]}]}},"/api/task-management/v1/tasks/{taskId}":{"get":{"operationId":"getTaskByIdAndTaskTypeNameKeyUsingGET","summary":"Get Task","description":"Use this API to retrieve a specific task on an object. The response will include details such as the status, priority, and deadline.\n\n> 🗒 Things to Know\n> \n> - This API currently supports issue tasks. Support for tasks on additional objects may be made available in the future.","tags":["Tasks","Tasks"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-task-management.json"},"parameters":[{"name":"taskId","in":"path","description":"The unique identifier of the task.","required":true,"schema":{"description":"UUID format of the task identifier","type":"string","format":"uuid"},"example":"123e4567-e89b-12d3-a456-426614174000"},{"name":"taskTypeNameKey","in":"query","description":"The source product of the task.","required":true,"schema":{"description":"String identifier for the task type service","type":"string","enum":["Issue"],"minLength":1},"example":"issue"}],"responses":{"200":{"description":"Task found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInformation"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["ISSUE_READ"]}]},"put":{"operationId":"updateTaskUsingPUT","summary":"Update Task","description":"Use this API to update an existing task for an object.\n\n> 🗒 Things to Know\n> \n> - This API currently supports issue tasks. Support for tasks on additional objects may be made available in the future.","tags":["Tasks"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-task-management.json"},"parameters":[{"name":"taskId","in":"path","description":"The unique identifier of the task.","required":true,"schema":{"description":"UUID format of the task identifier","type":"string","format":"uuid"},"example":"123e4567-e89b-12d3-a456-426614174000"},{"name":"taskTypeNameKey","in":"query","description":"The source product of the task.","required":true,"schema":{"description":"String identifier for the task type service","type":"string","enum":["Issue"],"minLength":1},"example":"issue"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskUpdateRequest"}}}},"responses":{"200":{"description":"Task updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInformation"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["ISSUE"]}]}}},"components":{"schemas":{"TaskCollaboratorDto":{"type":"object","properties":{"collaboratorId":{"description":"The unique identifier of the user assigned as a collaborator on the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"collaboratorEmail":{"description":"The email address of the user assigned as a collaborator on the task.","type":"string","example":"collaborator@example.com","maxLength":255,"minLength":0},"type":{"description":"The type of collaborator. ","type":"string","example":"USER","enum":["USER","GROUP"]}},"example":{"collaboratorId":"123e4567-e89b-12d3-a456-426614174000","collaboratorEmail":"collaborator@example.com","type":"USER"},"required":["type"]},"TaskContextInformation":{"type":"object","properties":{"parameters":{"description":"This parameter can be used to store task details in key value pairs.","additionalProperties":{"type":"object"},"example":{"userId":12345,"isActive":true,"metadata":{"createdBy":"admin"}},"type":"object"}}},"TaskUpdateRequest":{"type":"object","properties":{"taskName":{"description":"The name of the task.","type":"string","example":"Review document","maxLength":512,"minLength":0},"description":{"description":"The description of the task.","type":"string","example":"Please review the attached document and provide feedback","maxLength":2000,"minLength":0},"assigneeId":{"description":"The unique identifier of the user assigned as an assignee on the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"assigneeEmail":{"description":"The email address of the user assigned as an assignee on the task.","type":"string","example":"user@example.com","maxLength":255,"minLength":0},"collaborators":{"description":"The details of the collaborators assigned to the task.","type":"array","items":{"$ref":"#/components/schemas/TaskCollaboratorDto"}},"deadline":{"description":"The date and time by which the task should be completed.","type":"string","format":"date-time","example":"2023-12-31T23:59:59"},"status":{"description":"The status of the task.","type":"string","example":"Open","enum":["Open","Closed"]},"context":{"description":"The contextual details of the task.","$ref":"#/components/schemas/TaskContextInformation"},"priority":{"description":"The priority level of the task.","type":"string","example":"MEDIUM","default":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"isRequired":{"description":"This flag indicates whether the task is required.","type":"boolean","example":false},"sourceType":{"description":"The type of source that created the task.","type":"string","example":"RULES","maxLength":16,"minLength":0},"sourceId":{"description":"The unique identifier of the source that created the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}},"example":{"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"},"required":["taskName"]},"AttributeValue":{"type":"object","properties":{"valueKey":{"description":"The name key of the attribute used for translation purposes.","type":"string","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","maxLength":255,"minLength":1},"value":{"description":"The name of the attribute.","type":"string","example":"Document Review Team","maxLength":255,"minLength":1}},"example":{"valueKey":"f47ac10b-58cc-4372-a567-0e02b2c3d479","value":"Document Review Team"},"required":["value","valueKey"]},"DueDateInfo":{"type":"object","properties":{"date":{"description":"The date and time that the task is due.","type":"string","format":"date-time","example":"2023-12-31T23:59:59Z"},"color":{"description":"The color code for displaying the task due date.","type":"string","example":"#FF0000","maxLength":7,"minLength":1},"icon":{"description":"The icon of the task due date.","type":"string","example":"clock-warning","maxLength":50,"minLength":1},"textKey":{"description":"The text key for the task due date used for translation purposes.","type":"string","example":"TaskRegistry.DueDate.Overdue","maxLength":255,"minLength":1},"numberOfDays":{"description":"The number of days until or past the task due date.","type":"integer","format":"int64","example":5}},"example":{"date":"2023-12-31T23:59:59Z","color":"#FF0000","icon":"clock-warning","textKey":"TaskRegistry.DueDate.Overdue","numberOfDays":5},"required":["color","date","icon","numberOfDays","textKey"]},"TaskAssignmentInformation":{"type":"object","properties":{"userInfo":{"description":"The details of the users or user groups responsible for the task.","$ref":"#/components/schemas/UserInformation"},"assigneeId":{"description":"The unique identifier of the user or user group assigned to the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"description":"The type of assignee or collaborator. ","type":"string","example":"USER","enum":["USER","GROUP"]},"isCollaborator":{"description":"This flag indicates whether the user or user group was added as a collaborator.","type":"boolean","example":false}},"example":{"taskId":"123e4567-e89b-12d3-a456-426614174000","userInfo":{"id":"123e4567-e89b-12d3-a456-426614174001","name":"John Doe"},"assigneeId":"123e4567-e89b-12d3-a456-426614174000","type":"USER","isCollaborator":false},"required":["assigneeId","isCollaborator","type"]},"TaskInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"parentEntityId":{"description":"The unique identifier of the parent record where the task was created.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"taskName":{"description":"The name of the task.","type":"string","example":"Review Document XYZ","maxLength":255,"minLength":1},"taskType":{"description":"The details of the task type.","$ref":"#/components/schemas/TaskTypeInformation"},"deadline":{"description":"The date and time by which the task should be completed.","type":"string","format":"date-time","example":"2023-12-31T23:59:59Z"},"status":{"description":"The status of the task.","type":"string","example":"Open","enum":["Open","Closed"]},"priority":{"description":"The priority level of the task.","type":"string","example":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"description":{"description":"The description of the task.","type":"string","example":"This task requires reviewing document X and providing feedback","maxLength":4000},"orgGroupId":{"description":"The unique identifier of the organization responsible for the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","deprecated":true},"orgGroupAttribute":{"description":"The attribute details of the organization responsible for the task.","$ref":"#/components/schemas/AttributeValue"},"assigneeId":{"description":"The unique identifier of the user assigned as an assignee on the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"isActive":{"description":"This flag indicates whether the task is active.","type":"boolean","example":true,"default":"true"},"sourceType":{"description":"The type of source that created the task.","type":"string","example":"RULES","maxLength":50},"sourceId":{"description":"The unique identifier of the source that created the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"moduleSource":{"description":"The source product of the task.","type":"string","example":"ASSESSMENT","enum":["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"]},"taskAssignmentInformations":{"description":"The details of the task assignment.","type":"array","items":{"$ref":"#/components/schemas/TaskAssignmentInformation"}},"Presentation Mode":{"description":"The presentation mode of the task.","type":"string","example":"NAVIGATION","enum":["NAVIGATION","DRAWER"]},"isCollaboratorSupported":{"description":"This flag indicates whether users can be assigned as collaborators on the task.","type":"boolean","example":true},"isCollaboratorGroupSupported":{"description":"This flag indicates whether user groups can be assigned as collaborators on the task.","type":"boolean","example":true},"relativeUrl":{"description":"The relative URL associated with the task.","type":"string","example":"/tasks/review/123","maxLength":255,"minLength":1},"Activity":{"description":"The type of activity for the task.","type":"string","example":"COMPLETE_TASK","enum":["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"]},"workflowAndStageBasicInformation":{"description":"The details of the workflow and stage.","type":"object"},"workflowId":{"description":"The unique identifier of the workflow associated with the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"workflowStageId":{"description":"The unique identifier of the workflow stage associated with the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"stageName":{"description":"The name of the workflow stage.","type":"string","example":"Review","maxLength":255,"minLength":1},"stageNameKey":{"description":"The name key of the workflow stage used for translation purposes.","type":"string","example":"TaskRegistry.Stage.Review","maxLength":255,"minLength":1},"badgeColor":{"description":"The badge color of the workflow stage.","type":"string","example":"#4287f5","maxLength":7,"minLength":4},"dueDateInfo":{"description":"The details of the task due date.","$ref":"#/components/schemas/DueDateInfo"},"Permissions Metadata":{"description":"The permissions metadata for the task.","type":"object","example":{"canEdit":true,"canDelete":false,"canChangeStatus":true,"canReassign":true,"canComment":true,"canAddAttachment":true},"additionalProperties":{"type":"boolean"}},"createdBy":{"description":"The unique identifier of the user who created the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","deprecated":true},"createdByAttribute":{"description":"The attribute details of the user who created the task.","$ref":"#/components/schemas/AttributeValue"},"createdDT":{"description":"The date and time that the task was created.","type":"string","format":"date-time","example":"2023-01-15T14:30:00Z"},"modifiedBy":{"description":"The unique identifier of the user who modified the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","deprecated":true},"modifiedByAttribute":{"description":"The attribute details of the user who modified the task.","$ref":"#/components/schemas/AttributeValue"},"modifiedDT":{"description":"The date and time that the task was modified.","type":"string","format":"date-time","example":"2023-01-20T16:45:00Z"},"completionDate":{"description":"The date and time that the task was completed.","type":"string","format":"date-time","example":"2023-01-25T09:15:00Z"},"isRequired":{"description":"This flag indicates whether the task is required.","type":"boolean","example":true},"canEditRequiredTask":{"description":"This flag indicates whether the task can be edited.","type":"boolean","example":false},"pastDue":{"description":"This flag indicates whether the task is past due.","type":"boolean"},"activityKey":{"description":"The key used to identify the type of activity for the task.","type":"string","deprecated":true}},"example":{"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},"required":["deadline","id","isActive","parentEntityId","priority","status","taskName","taskType"]},"TaskTypeInformation":{"type":"object","properties":{"name":{"description":"The name of the task type.","type":"string","example":"DOCUMENT_REVIEW","maxLength":100,"minLength":1},"nameKey":{"description":"The name key of the task type used for translation purposes.","type":"string","example":"TaskRegistry.TaskType.DocumentReview","maxLength":255,"minLength":1},"module":{"description":"The source product of the task type.","type":"string","example":"ASSESSMENT","maxLength":100,"minLength":1},"moduleNameTranslationKey":{"description":"The name key of the source product used for translation purposes.","type":"string","example":"TaskRegistry.Module.Assessment","maxLength":255,"minLength":1},"id":{"description":"The unique identifier of the task type.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"label":{"description":"The display label of the task type.","type":"string","example":"Document Review","maxLength":255,"minLength":1},"icon":{"description":"The icon of the task type.","type":"string","example":"document-check","maxLength":50,"minLength":1}},"example":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"DOCUMENT_REVIEW","nameKey":"TaskRegistry.TaskType.DocumentReview","module":"ASSESSMENT","moduleNameTranslationKey":"TaskRegistry.Module.Assessment","label":"Document Review","icon":"document-check"},"required":["id","label","module","moduleNameTranslationKey","name","nameKey"]},"UserInformation":{"type":"object","properties":{"User Name":{"description":"The name of the user or user group.","type":"string","example":"John Doe","maxLength":255,"minLength":1},"User Name With Attributes":{"description":"The name of the user or user group with additional attributes.","type":"string","example":"John Doe (Manager)","maxLength":255,"minLength":1}},"example":{"name":"John Doe","nameWithAttributes":"John Doe (Manager)"}},"TaskCreateRequest":{"type":"object","properties":{"parentEntityId":{"description":"The unique identifier of the parent record where the task was created.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"taskName":{"description":"The name of the task.","type":"string","example":"Review document","maxLength":512,"minLength":0},"description":{"description":"The description of the task.","type":"string","example":"Please review the attached document and provide feedback","maxLength":2000,"minLength":0},"orgGroupId":{"description":"The unique identifier of the organization responsible for the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"taskTypeNameKey":{"description":"The key that identifies the type of activity for the task.","type":"string","example":"REVIEW_TASK","maxLength":100,"minLength":1},"assigneeId":{"description":"The unique identifier of the user assigned as an assignee on the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"assigneeEmail":{"description":"The email address of the user assigned as an assignee on the task.","type":"string","example":"user@example.com","maxLength":255,"minLength":0},"collaborators":{"description":"The details of the collaborators assigned to the task.","type":"array","items":{"$ref":"#/components/schemas/TaskCollaboratorDto"}},"deadline":{"description":"The date and time by which the task should be completed.","type":"string","format":"date-time","example":"2023-12-31T23:59:59"},"context":{"description":"The contextual details of the task.","$ref":"#/components/schemas/TaskContextInformation"},"isActive":{"description":"This flag indicates whether the task is active.","type":"boolean","example":true,"default":"true"},"sourceType":{"description":"The type of source that created the task.","type":"string","example":"RULES","maxLength":16,"minLength":0},"sourceId":{"description":"The unique identifier of the source that created the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"resourceId":{"description":"The unique identifier of the resource.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"resourceTypeNameKey":{"description":"The key used to identify the type of resource.","type":"string","example":"ASSESSMENT","maxLength":100,"minLength":1},"moduleSource":{"description":"The source product of the task.","type":"string","example":"ASSESSMENT","enum":["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"]},"priority":{"description":"The priority level of the task.","type":"string","example":"MEDIUM","default":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"isRequired":{"description":"This flag indicates whether the task is required.","type":"boolean","example":false,"default":"false"}},"example":{"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"},"required":["orgGroupId","parentEntityId","taskName","taskTypeNameKey"]}},"securitySchemes":{"OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"ISSUE":"Task Management Scope gives the user access to read/write/delete operations used for Task Management.","ISSUE_READ":"Task Management Scope gives the user access to read operations used for Task Management."}}}}}}}