API integration
This page explains how to manipulate your data subject right requests directly in Dastra without integrating the javascript SDK thanks to our Rest API.
As Dastra does not integrate natively with all development platforms, we provide a Rest API to manage your data subject requests from your applications.
The data subject request object
Below is the JSON object model of a data subject request in Dastra.
To get the object format with your own custom fields, export a request in JSON format: you obtain the JSON model of your workspace.
Request identifiers are GUIDs (for example 3fa85f64-5717-4562-b3fc-2c963f66afa6). The workspace identifier is an integer.
API endpoints
Here are the main endpoints you need to integrate your applications with the Dastra data subject request module.
Create a new data subject request in Dastra
POST /v1/ws/{workspaceId}/DataSubjectRequests
Path Parameters
workspaceId*
Integer
The ID of the workspace
Request Body
title*
String
Title of the request
message
String
Text of the request
locale*
String
Language of the requester (for example fr, en)
areaId*
Integer
ID of the organizational unit of the request
email
String
Email address of the requester
dateDemand
DateTime
Date of the request (defaults to the current date)
purposes*
Array[String]
Request types concerned (at least one). Possible values: see the purposes parameter of the list endpoint below
Retrieve an existing data subject request via its ID
GET /v1/ws/{workspaceId}/DataSubjectRequests/{id}
Path Parameters
workspaceId*
Integer
The ID of the workspace that holds the data subject request
id*
GUID
The ID (GUID) of the data subject request
Retrieve a paginated list of data subject requests
GET /v1/ws/{workspaceId}/DataSubjectRequests
You can pass optional search parameters to filter the API response.
Path Parameters
workspaceId*
Integer
The ID of the workspace to query
Query Parameters
overtaking
Boolean
Search for requests whose legal response deadline has been exceeded
archived
Boolean
Return the requests in the recycle bin (false by default)
q
String
Text search in the title of the request
widgetId
Integer
Filter the requests that come from a collection form
areaId
Integer
Filter the requests of an organizational unit
states
Array[String]
Filter the requests by state (Open, IdentityValidation, Processing, Active, Closed)
purposes
Array[String]
Filter the requests by type (Unknown, Information, Access, Rectification, Erasure, Restriction, Opposition, Portability, AdvanceDirectives, AutomatedDecision, AdministrativeAccess, DPORequest, ThirdPartyRequest, DataProtectionComplaint, DoNotSellOrShare, LimitUseSensitivePersonalInformation, WithdrawalOfConsent)
ids
Array[GUID]
Select a list of requests by their IDs
tags
Array[GUID]
Select the requests that have specific tags (pass an array of tag IDs in the query string)
page
Integer
The page to retrieve (the first page is 1)
size
Integer
The number of items returned per page (20 by default)
skip
Integer
The number of items to skip (replaces page when provided)
sortBy
String
The field used to order the items
asc
Boolean
true for ascending order
Update a data subject request
PUT /v1/ws/{workspaceId}/DataSubjectRequests/{id}
Path Parameters
workspaceId*
Integer
The ID of the workspace that holds the data subject request
id*
GUID
The ID (GUID) of the data subject request
Request Body
dataSubjectRequest
Object
The complete data subject request object (see above or our Swagger API documentation). Its id field must match the ID in the URL.
The response has no content.
Delete a data subject request via its ID
DELETE /v1/ws/{workspaceId}/DataSubjectRequests/{id}
This action is irreversible: the data subject request is permanently deleted from our databases. To move it to the recycle bin without deleting it, use the archive endpoint below.
Path Parameters
workspaceId*
Integer
The ID of the workspace that holds the data subject request
id*
GUID
The ID (GUID) of the data subject request
The response has no content.
Change the process step of a data subject request
POST /v1/ws/{workspaceId}/DataSubjectRequests/workflow
Path Parameters
workspaceId*
Integer
The ID of the workspace that holds the data subject request
Request Body
id*
GUID
The ID (GUID) of the data subject request whose process step you want to change
stepId*
Integer
The ID of the process step to apply to the request
comment
String
Optional comment attached to the step change
Archive a data subject request via its ID
POST /v1/ws/{workspaceId}/DataSubjectRequests/archive/{id}
This endpoint moves the data subject request to the recycle bin ("archived" state).
Path Parameters
workspaceId*
Integer
The ID of the workspace that holds the data subject request
id*
GUID
The ID (GUID) of the data subject request to archive
The response contains the data subject request (see the object described above).
Remove the archived status from a data subject request
POST /v1/ws/{workspaceId}/DataSubjectRequests/restore/{id}
This endpoint restores a request from the recycle bin.
Path Parameters
workspaceId*
Integer
The ID of the workspace that holds the data subject request
id*
GUID
The ID (GUID) of the data subject request to restore
The response contains the data subject request (see the object described above).
Last updated
Was this helpful?