search

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 you with a Rest API to manage your data subject right request from your applications.

hashtag
The object of the data subject right request

Below is the template for a data subject right request in Dastra

chevron-rightThe object of the data subject right requesthashtag
{
  "closedByUser": {
    "id": 0,
    "displayName": "string",
    "familyName": "string",
    "givenName": "string",
    "email": "string",
    "color": "string",
    "avatarUrl": "string",
    "tenantId": 0
  },
  "area": {
    "order": 0,
    "children": [
      "string"
    ],
    "teams": [
      {
        "id": 0,
        "label": "string",
        "ref": "string",
        "areas": [
          0
        ],
        "users": [
          0
        ]
      }
    ],
    "id": 0,
    "type": "Entity",
    "parentId": 0,
    "ref": "string",
    "label": "string",
    "description": "string",
    "logoUrl": "string",
    "address": "string",
    "zipCode": "string",
    "city": "string",
    "countryCode": "str",
    "immatriculationNumber": "string",
    "phoneNumber": "string",
    "mailAddress": "string",
    "dpo": {
      "id": 0,
      "displayName": "string",
      "dateCreation": "2022-08-05T12:19:43.722Z",
      "dateUpdate": "2022-08-05T12:19:43.722Z",
      "logoUrl": "string",
      "actorType": "Physical",
      "vendorType": "B2B",
      "accessLevel": "None",
      "givenName": "string",
      "familyName": "string",
      "companyName": "string",
      "description": "string",
      "countryCode": "st",
      "readonly": true,
      "email": "string",
      "phoneNumber": "string",
      "contactName": "string",
      "contactPosition": "string",
      "immatriculationNumber": "string",
      "websiteUrl": "string",
      "address": "string",
      "zipCode": "string",
      "city": "string"
    },
    "referent": {
      "id": 0,
      "displayName": "string",
      "dateCreation": "2022-08-05T12:19:43.722Z",
      "dateUpdate": "2022-08-05T12:19:43.722Z",
      "logoUrl": "string",
      "actorType": "Physical",
      "vendorType": "B2B",
      "accessLevel": "None",
      "givenName": "string",
      "familyName": "string",
      "companyName": "string",
      "description": "string",
      "countryCode": "st",
      "readonly": true,
      "email": "string",
      "phoneNumber": "string",
      "contactName": "string",
      "contactPosition": "string",
      "immatriculationNumber": "string",
      "websiteUrl": "string",
      "address": "string",
      "zipCode": "string",
      "city": "string"
    },
    "representative": {
      "id": 0,
      "displayName": "string",
      "dateCreation": "2022-08-05T12:19:43.722Z",
      "dateUpdate": "2022-08-05T12:19:43.722Z",
      "logoUrl": "string",
      "actorType": "Physical",
      "vendorType": "B2B",
      "accessLevel": "None",
      "givenName": "string",
      "familyName": "string",
      "companyName": "string",
      "description": "string",
      "countryCode": "st",
      "readonly": true,
      "email": "string",
      "phoneNumber": "string",
      "contactName": "string",
      "contactPosition": "string",
      "immatriculationNumber": "string",
      "websiteUrl": "string",
      "address": "string",
      "zipCode": "string",
      "city": "string"
    },
    "dataProtectionAuthority": {
      "id": 0,
      "label": "string",
      "siteURL": "string",
      "phoneNumber": "string",
      "email": "[email protected]",
      "countryCode": "str",
      "address": "string",
      "city": "string",
      "zipCode": "string"
    }
  },
  "creator": {
    "id": 0,
    "displayName": "string",
    "familyName": "string",
    "givenName": "string",
    "email": "string",
    "color": "string",
    "avatarUrl": "string",
    "tenantId": 0
  },
  "operator": {
    "id": 0,
    "displayName": "string",
    "familyName": "string",
    "givenName": "string",
    "email": "string",
    "color": "string",
    "avatarUrl": "string",
    "tenantId": 0
  },
  "attachments": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "extension": "string",
      "size": 0,
      "nbDownload": 0,
      "transmitted": true,
      "fileName": "string",
      "label": "string",
      "userRequestMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "userRequestId": 0,
      "dateCreation": "2022-08-05T12:19:43.722Z",
      "dateUpdate": "2022-08-05T12:19:43.722Z",
      "creator": {
        "id": 0,
        "displayName": "string",
        "familyName": "string",
        "givenName": "string",
        "email": "string",
        "color": "string",
        "avatarUrl": "string",
        "tenantId": 0
      },
      "expiration": "2022-08-05T12:19:43.722Z",
      "dateLastDownload": "2022-08-05T12:19:43.722Z",
      "dateFileRemoved": "2022-08-05T12:19:43.722Z",
      "deleted": true,
      "expired": true,
      "color": "string"
    }
  ],
  "tags": [
    {
      "id": 0,
      "label": "string",
      "type": "DataProcessing",
      "color": "string"
    }
  ],
  "id": 0,
  "title": "string",
  "locale": "string",
  "archived": true,
  "archivedDate": "2022-08-05T12:19:43.722Z",
  "personCategory": "Prospect",
  "complex": true,
  "dateClosed": "2022-08-05T12:19:43.722Z",
  "areaId": 0,
  "state": "Open",
  "description": "string",
  "message": "string",
  "resolutionMessage": "string",
  "email": "string",
  "phoneNumber": "string",
  "givenName": "string",
  "familyName": "string",
  "dateCreation": "2022-08-05T12:19:43.722Z",
  "dateUpdate": "2022-08-05T12:19:43.722Z",
  "workFlowStep": {
    "id": 0,
    "label": "string",
    "color": "string",
    "order": 0,
    "itemLimit": 0,
    "type": "DataSubject",
    "finalStep": true,
    "initialStep": true,
    "descriptionHtml": "string",
    "mappedState": "string"
  },
  "workFlowStepId": 0,
  "channel": "Internal",
  "refId": "string",
  "userId": "string",
  "purposes": [
    "Unknown"
  ],
  "closedReason": "None",
  "closedReasonDescription": "string",
  "expiryTime": "2022-08-05T12:19:43.722Z",
  "address": "string",
  "zipCode": "string",
  "city": "string",
  "countryCode": "st",
  "nbMessages": 0,
  "nbMessagesNotViewed": 0,
  "remainingDays": 0,
  "closingTime": 0,
  "additionalDatas": "string",
  "userNotified": true,
  "dateUserNotified": "2022-08-05T12:19:43.722Z",
  "sendNotification": true,
  "emailValidationDate": "2022-08-05T12:19:43.722Z",
  "mailValidated": true,
  "referrerUrl": "string",
  "demandId": "string",
  "identityValidated": true,
  "dateIdentityValidated": "2022-08-05T12:19:43.722Z",
  "widgetId": 0
}

To retrieve the Object format of your configured custom fields, you can export a request in JSON format and obtain the JSON model.

hashtag
API's Endpoints

Here are the main Endpoints that you will need to integrate your applications with the Dastra data subject right request module.

hashtag
Create a new data subject rights request in Dastra

POST /v1​/ws​/{workspaceId}​/DataSubjectRequests

hashtag
Path Parameters

Name
Type
Description

workspaceId*

String

L'Id du workspace dans lequel vous souhaitez poster la demande d'exercice de droits

{
  "id": 0,
  "title": "string",
  "locale": "string",
  "archived": true,
  "archivedDate": "2022-08-31T10:24:32.381Z",
  "personCategory": "Prospect",
  "complex": true,
  "dateClosed": "2022-08-31T10:24:32.381Z",
  "areaId": 0,
  "state": "Open",
  "description": "string",
  "message": "string",
  "resolutionMessage": "string",
  "email": "string",
  "phoneNumber": "string",
  "givenName": "string",
  "familyName": "string",
  "dateCreation": "2022-08-31T10:24:32.381Z",
  "dateUpdate": "2022-08-31T10:24:32.381Z",
  "workFlowStep": {
    "id": 0,
    "label": "string",
    "color": "string",
    "order": 0,
    "itemLimit": 0,
    "type": "DataSubject",
    "finalStep": true,
    "initialStep": true,
    "descriptionHtml": "string",
    "mappedState": "string"
  },
  "workFlowStepId": 0,
  "channel": "Internal",
  "refId": "string",
  "userId": "string",
  "purposes": [
    "Unknown"
  ],
  "closedReason": "None",
  "closedReasonDescription": "string",
  "expiryTime": "2022-08-31T10:24:32.381Z",
  "address": "string",
  "zipCode": "string",
  "city": "string",
  "countryCode": "st",
  "nbMessages": 0,
  "nbMessagesNotViewed": 0,
  "remainingDays": 0,
  "closingTime": 0,
  "additionalDatas": "string",
  "userNotified": true,
  "dateUserNotified": "2022-08-31T10:24:32.381Z",
  "sendNotification": true,
  "emailValidationDate": "2022-08-31T10:24:32.381Z",
  "mailValidated": true,
  "referrerUrl": "string",
  "demandId": "string",
  "identityValidated": true,
  "dateIdentityValidated": "2022-08-31T10:24:32.381Z",
  "widgetId": 0
}

hashtag
Retrieve an existing data subject rights request via its ID

GET ​/v1​/ws​/{workspaceId}​/DataSubjectRequests​/{id}

hashtag
Path Parameters

Name
Type
Description

workspaceId*

String

L'id de l'espace de travail dans lequel se trouve la demande d'exercice de droits que vous souhaitez requêter

*

Integer

L'id de la demande d'exercice de droits que vous souhaitez requêter

hashtag
Retrieve a paginated list of data subject rights requests

GET ​/v1​/ws​/{workspaceId}​/DataSubjectRequests

You can pass optional search parameters to your query to filter the API response

hashtag
Path Parameters

Name
Type
Description

workspaceId*

String

Le workspace id que vous souhaitez requêter

hashtag
Query Parameters

Name
Type
Description

overtaking

Boolean

Rechercher les demandes dont le délai légal de réponse à a été dépassé

archived

Boolean

Retourner les demandes archivées

q

String

Recherche texte dans le titre de la demande

widgetId

Integer

filtrer les demandes issues d'un widget de collecte

states

Array[String]

Filtrer les demandes par état (Open, IdentityValidation, Processing, Active, Closed)

purposes

Array[String]

Filtrer les demandes par type (Unknown, Information, Access, Rectification, Erasure, Restriction, Opposition, Portability, AdvanceDirectives, AutomatedDecision)

ids

Array[Integer]

Sélectionner une liste de demandes par leurs ids

tags

Array[Integer]

Sélectionner les demandes ayant des tags spécifiques (passer un array de tagIds en query string)

page

Integer

La page que vous souhaitez requêter

size

Integer

Le nombre d'éléments retournés par page

skip

Integer

sortBy

String

Le champ sur lequel filtrer l'ordre des éléments

asc

Boolean

true pour ordonner de manière ascendante

hashtag
Update a data subject rights request

PUT /v1/ws/{workspaceId}​/DataSubjectRequests​/{id}

hashtag
Path Parameters

Name
Type
Description

workspaceId*

String

L'id de l'espace de travail dans lequel se trouve la demande d'exercice de droits que vous souhaitez supprimer

id*

Integer

L'id de la demande d'exercice de droits existante que vous souhaitez supprimer

hashtag
Request Body

Name
Type
Description

dataSubjectRequest

Object

Poster l'objet complet de la demande d'exercice de droits (voir plus haut ou notre documentation d'api swaggerarrow-up-right)

hashtag
Delete a data subject rights request via its ID

DELETE ​/v1​/ws​/{workspaceId}​/DataSubjectRequests​/{id}

Please note that this action is irreversible, and your request will be permanently deleted from our databases.

hashtag
Path Parameters

Name
Type
Description

workspaceId*

String

L'id de l'espace de travail dans lequel se trouve la demande d'exercice de droits que vous souhaitez supprimer

id*

Integer

L'id de la demande d'exercice de droits existante que vous souhaitez supprimer

hashtag
Change the process step of the data subject right request

POST /v1​/ws​/{workspaceId}​/DataSubjectRequests​/workflow

hashtag
Path Parameters

Name
Type
Description

workspaceId*

String

L'id de l'espace de travail dans lequel se trouve la demande d'exercice de droits que vous souhaitez supprimer

hashtag
Request Body

Name
Type
Description

id

Integer

L'id de la demande d'exercice de droits dont vous souhaitez modifier l'étape de processus

stepId

Integer

L'id de l'étape de processus que vous souhaitez appliquer à la demande d'exercice de droits

hashtag
Archive a data subject right request via its ID

POST /v1​/ws​/{workspaceId}​/DataSubjectRequests​/archive​/{id}

This endpoint applies the "Archived" state to the DSR request

hashtag
Path Parameters

Name
Type
Description

workspaceId

String

L'id de l'espace de travail dans lequel se trouve la demande d'exercice de droits que vous souhaitez supprimer

id

Integer

L'id de la demande d'exercice de droits que vous souhaitez archiver

hashtag
Remove archived status from a DSR request

POST ​/v1​/ws​/{workspaceId}​/DataSubjectRequests​/restore​/{id}

hashtag
Path Parameters

Name
Type
Description

workspaceId

String

L'id de l'espace de travail dans lequel se trouve la demande d'exercice de droits que vous souhaitez supprimer

id

Integrer

L'id de la demande d'exercice de droits que vous souhaitez restaurer

Last updated

Was this helpful?