v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Subtasks

Get List of Subtasks by Criteria

Use this API to retrieve a list of all subtasks by filter criteria.

post/api/datasubject/v3/subtasks

Query parameters

includeClosedSubtasksboolean

Include closed subtasks in the response

onlyActivatedSubtasksboolean

Only include activated subtasks in the response

pageinteger

Results page you want to retrieve. Page number starts with 0 (0..N)

sizeinteger

Number of records per page. Maximum page size allowed is 500

Sorting criteria in the format: property(,asc|desc). Default sort order is subTaskId ascending.

Request body

RequestTypestring

Filter subtasks by Request Type. Only subtasks belonging to requests with this Request Type will be retrieved.

SubjectTypestring

Filter subtasks by Subject Type. Only subtasks belonging to requests with this Subject Type will be retrieved.

Organizationstring

Filter subtasks by Organization. Subtasks in this organization and related child organizations will be retrieved if includeChildOrgs is true.

SystemNamestring

Filter subtasks by integration system name. Only system subtasks associated with this system will be returned.

SubtaskStatusstring[]

SubtaskType'manual' | 'system'

Filter subtasks by type - either 'manual' for user-created subtasks or 'system' for automated system subtasks.

OpenRequestsboolean

When set to true, only subtasks belonging to open requests will be included in the results. If false or omitted, subtasks from both open and closed requests will be returned.

currentRequestStagestring[]

Filter subtasks by current request stage. Accepted values include: All default and custom request stages are supported.

subtaskCreatedStagestring[]

Filter subtasks by subtask created stage. Accepted values include: All default and custom request stages are supported.

languagestring

Specifies the language code for localized field values in the response. Translations will be provided for this language if available.

IncludeChildOrgsboolean

By default set to true if omitted. On true Subtasks of Child Organizations of the given Organization will be included.On False Subtasks of the given Organization will be included. Effective only if 'organization' value is provided.

ExactSystemNameMatchboolean

When set to true, performs exact match for SystemName instead of substring matching. This ensures only subtasks from systems with exact name match are returned. By default set to false for backward compatibility.

Example request

{
  "RequestType": "Opt Out",
  "SubjectType": "Employee",
  "Organization": "Brand A",
  "SystemName": "Office365",
  "SubtaskStatus": [
    "Assigned"
  ],
  "SubtaskType": "system",
  "OpenRequests": true,
  "SubtaskDateCreated": {
    "StartDate": "2019-05-31T12:43:24.173Z",
    "EndDate": "2019-05-31T12:44:24.173Z"
  },
  "SubtaskDateUpdated": {
    "StartDate": "2019-05-31T12:43:24.173Z",
    "EndDate": "2019-05-31T12:44:24.173Z"
  },
  "RequestDeadline": {
    "StartDate": "2019-05-31T12:43:24.173Z",
    "EndDate": "2019-05-31T12:44:24.173Z"
  },
  "RequestDateCreated": {
    "StartDate": "2019-05-31T12:43:24.173Z",
    "EndDate": "2019-05-31T12:44:24.173Z"
  },
  "currentRequestStage": [
    "NEW",
    "VERIFYING IDENTITY"
  ],
  "subtaskCreatedStage": [
    "NEW",
    "VERIFYING IDENTITY"
  ],
  "language": "en-us",
  "IncludeChildOrgs": true,
  "ExactSystemNameMatch": true
}

Response

assignedToGroupboolean

Indicates whether the subtask is assigned to a group rather than an individual.

requestApproverstring

The name of the person who approved the parent request.

requestOrgNamestring

The organization name associated with the request.

requestQueueDateCreatedstring date-time

The date when the parent request was created.

requestQueueDeadlinestring date-time

The deadline for the parent request.

requestQueueIdstring uuid

The request unique ID

requestQueueRefIdstring

The request reference ID

requesterEmailstring email

The email address of the requester

subTaskAssigneestring

The person assigned to the subtask

subTaskCreatedDatestring date-time

The date when the subtask was created

subTaskDeadlinestring date-time

The deadline for the subtask

subTaskDescriptionstring

The description of the subtask

subTaskIdstring uuid

The subtask unique ID

subTaskLastUpdatedDatestring date-time

The date when the subtask was last updated

subTaskNamestring

The name of the subtask

subTaskReminderDatestring date-time

The reminder date for the subtask

subTaskRequiredboolean

Indicates whether the subtask is required

The current status of the subtask

subTaskType'MANUAL' | 'SYSTEM_TASK'

The type of the subtask

subTaskResolutionstring

The resolution code for the subtask if completed or rejected

requestTypesstring[]

Types of the parent request

subjectTypesstring[]

Subject types of the parent request

currentRequestStagestring

The current stage of the parent request

subtaskCreatedStagestring

The stage when the subtask was created

Example response

[
  {
    "requestApprover": "John Doe",
    "requestOrgName": "Example Organization",
    "requestQueueDateCreated": "2023-08-01T10:15:30Z",
    "requestQueueDeadline": "2023-09-01T10:15:30Z",
    "requestQueueId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
    "requestQueueRefId": "SL244HWD6D",
    "requesterEmail": "requester@example.com",
    "subTaskAssignee": "Jane Smith",
    "subTaskCreatedDate": "2023-08-02T14:30:45Z",
    "subTaskDeadline": "2023-09-01T10:15:30Z",
    "subTaskDescription": "Discover all data related to the subject",
    "subTaskId": "f3e1a59e-4df0-5b2f-865d-e68658e55be",
    "subTaskLastUpdatedDate": "2023-08-15T09:20:15Z",
    "subTaskName": "Data Discovery",
    "subTaskReminderDate": "2023-08-25T10:15:30Z",
    "subTaskRequired": true,
    "subTaskStatus": "OPEN",
    "subTaskType": "MANUAL",
    "subTaskResolution": "Completed Successfully",
    "requestTypes": [
      "Data Portability",
      "Update Data"
    ],
    "subjectTypes": [
      "Customer",
      "Employee"
    ],
    "currentRequestStage": "VERIFICATION",
    "subtaskCreatedStage": "NEW"
  }
]