Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Request Queues

Create Request

Use this API to create a new request for the specified web form.

🗒 Things to Know

post/api/datasubject/v2/requestqueues/{templateId}

Path parameters

templateIdstring uuid required

Every request is created against a webform template. The template ID is the GUID corresponding to a particular webform. This can be obtained from the url by navigating to the webform. e.g. in this url, 'https://trial.onetrust.com/app/#/pia/dsar/webform/manage/6519ffd5-fe6b-4804-8dfc-1c2ae2da212d', '6519ffd5-fe6b-4804-8dfc-1c2ae2da212d' is the templateId.

Request body

firstNamestring

First name of the respondent.

lastNamestring

Last name of the respondent.

emailstring

Email address of the respondent.

languagestring

The ISO language code for OneTrust supported languages. Examples: en-us for English, de for German, fr for French, etc.

additionalDataobject

Additional fields in key value format, required for request processing. These could be webform or non webform fields

requestTypesstring[]

Respondents privacy request type. This should match with the webform request type.

subjectTypesstring[]

Respondents subject type or relation ship with tenant. This should match with the webform subject type.

multiselectFieldsobject
requestTraceIdstring uuid

Unique trace id for request. This can be used to avoid creating duplicate request.

Example request

{
  "firstName": "Test",
  "lastName": "User",
  "email": "testuser@onetrust.com",
  "language": "en-us",
  "additionalData": {
    "key": "value"
  },
  "requestTraceId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "attachments": [
    {
      "fileName": "sample.txt",
      "fileId": "3b47744c-eebf-44bb-bf4c-680966a448dc",
      "statusId": 10,
      "resourcePath": "/storage/attachments/sample.txt"
    }
  ]
}

Response

Created

requestQueueRefIdstring

Reference ID of the request. This is a 10-character ID that is unique to each request.

requestQueueIdstring uuid

The request GUID

firstNamestring

First name of the data subject.

lastNamestring

Last name of the data subject.

organizationstring

Organization to which this request is assigned.

statusstring

Current stage of the request. Various stages in the order of progression are: New, Verifying identity, In progress, Rejected, Complete.

requestTypesstring[]

Request types selected while submitting the request.

deadlinestring date-time

Deadline for the request.

isExtendedboolean

Returns true if the request complete time is being extended.

dateCreatedstring date-time

Date on which request is submitted.

dateUpdatedstring date-time

Last activity date on the request.

subjectTypesstring[]

Subject types selected while submitting the request. Subject type can be: Prospective Employee, Student, Customer, Contractor, Employee, Patient.

approverstring

Approver or assignee for the request.

languagestring

Language in which the request is created.

countryCodestring

The code for the country as per ISO 3166. e.g. US for the United States, DE for Germany.

countryNamestring

Name of the country.

emailstring

Email provided while submitting the request.

workflowstring

Name of the request workflow.

webformstring

Name of the webform.

dateCompletedstring date-time

Date on which the request is completed.

resolutionstring

Resolution selected if the request is rejected.

remainingDaysForMaxDeadlineinteger

Legal Deadline + Maximum Number of Extension Days based on country of request + Total Pause days.

maxDeadlineExtensionDatestring date-time

Legal Deadline + Maximum Number of Extension Days based on country of request + Total Pause days.

assignedToGroupboolean

Indicates if the request reviewer is assigned to a usergroup or not.

additionalStatuses'0' | '10'

Status of the request timer, such as PAUSED or ACTIVE.

Example response

{
  "requestQueueRefId": "SL244HWD6D",
  "requestQueueId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "firstName": "Jonny",
  "lastName": "Sardar",
  "organization": "my own org",
  "status": "NEW",
  "requestTypes": [
    "Data Portability, Update Data"
  ],
  "deadline": "2019-09-08T12:49:47.920Z",
  "dateCreated": "2019-08-09T12:49:47.983Z",
  "dateUpdated": "2019-09-25T06:50:15.470Z",
  "subjectTypes": [
    "Student"
  ],
  "approver": "Jonny Sardar Sadmin",
  "language": "en-us",
  "countryCode": "DZ",
  "countryName": "Algeria",
  "email": "abcd@gmail.com",
  "workflow": "Default Workflow",
  "webform": "!! Nikki",
  "dateCompleted": "2019-05-31T12:43:24.173Z",
  "resolution": "Not a privacy-related request",
  "remainingDaysForMaxDeadline": 30,
  "maxDeadlineExtensionDate": "2023-09-08T12:49:47.920Z",
  "additionalStatuses": "PAUSED"
}