Create Request

post

https://{hostname}/api/datasubject/v2/requestqueues/{templateId}

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

🗒
Things to Know

Visibility rules configured for the web form associated to the specified template will not be inherited after request creation. For more information, see Configuring Dynamic Fields with Visibility Rules.

Path Params

templateId

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.ezproxy.utas.edu.au/app/#/pia/dsar/webform/manage/6519ffd5-fe6b-4804-8dfc-1c2ae2da212d',
'6519ffd5-fe6b-4804-8dfc-1c2ae2da212d' is the templateId.

Body Params

firstName

string

First name of the respondent.

lastName

string

Last name of the respondent.

string

Email address of the respondent.

language

string

length ≥ 1

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

additionalData

object

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

requestTypes

array of strings

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

requestTypes

subjectTypes

array of strings

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

subjectTypes

multiselectFields

object

requestTraceId

uuid

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

attachments

array of objects

File attachment details for request.

attachments

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

201Created

429Too Many Requests. For more information, see API Rate Limits.