myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
Start typing to search…

Get List of Subtasks by Criteria

post
https://{hostname}/api/datasubject/v3/subtasks

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

Query Params
boolean
Defaults to false

Include closed subtasks in the response

boolean
Defaults to false

Only include activated subtasks in the response

int32
≥ 0
Defaults to 0

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

int32
1 to 500
Defaults to 20

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

string
enum

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

Body Params
string

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

string

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

string

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

string

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

SubtaskStatus
array
SubtaskStatus
string
enum

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

Allowed:
boolean
Defaults to false

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.

SubtaskDateCreated
object

Filter subtasks by their creation date. Only subtasks created within this date range will be included in the results. Use ISO 8601 format.

SubtaskDateUpdated
object

Filter subtasks by their last update date. Only subtasks updated within this date range will be included in the results. Use ISO 8601 format.

RequestDeadline
object

A date range for outlining start date and end date. All subtasks with a Request Deadline within this range will be retrieved. Accepted date format: YYYY-MM-DDT00:HH:MM.SSSZ

RequestDateCreated
object

A date range for outlining start date and end date. All subtasks with a Request Created Date within this range will be retrieved. Accepted date format: YYYY-MM-DDT00:HH:MM.SSSZ

currentRequestStage
array of strings

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

currentRequestStage
subtaskCreatedStage
array of strings

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

subtaskCreatedStage
string
Defaults to en-us

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

boolean
Defaults to true

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.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 4 months ago

Language
Credentials
OAuth2
Missing 2 required scopes
URL
Response 
 Choose an example:
application/json
*/*
Updated 4 months ago