search

Intégration de l'API

Cette page vous explique comment manipuler directement vos demandes d'exercice de droits dans Dastra sans intégrer le SDK javascript grâce à notre API Rest.

Dastra ne s'intégrant pas nativement à toutes les plateformes de développement, nous mettons à votre disposition une API Rest pour gérer vos demandes d'exercice de droits depuis vos applications.

hashtag
Le JSON de l'objet demande d'exercice de droits

Vous trouverez ci-dessous le modèle objet au format JSON d'une demande d'exercice de droits dans Dastra.

chevron-rightL'objet demande d'exercice de droitshashtag
{
    "customFields": {
      "13_long": "1234567891234",
      "13_html": "1234567891234"
    },
    "closedByUser": null,
    "area": {
      "order": XXX,
      "children": [],
      "permissions": [],
      "id": XXX,
      "type": "Entity",
      "parentId": null,
      "ref": null,
      "label": "Moulinsart",
      "description": null,
      "logoUrl": null,
      "address": null,
      "zipCode": null,
      "city": null,
      "countryCode": "BE",
      "immatriculationNumber": null,
      "phoneNumber": null,
      "mailAddress": null,
      "dpo": null,
      "referent": null,
      "representative": null,
      "dataProtectionAuthority": null
    },
    "creator": null,
    "operator": null,
    "operatorId": null,
    "attachments": [],
    "messages": [],
    "tags": [],
    "id": XXX,
    "title": "",
    "locale": "fr",
    "archived": false,
    "archivedDate": null,
    "subjectCategoryId": null,
    "subjectCategory": null,
    "complex": false,
    "dateClosed": null,
    "areaId": XX,
    "state": "Open",
    "description": null,
    "message": null,
    "resolutionMessage": null,
    "email": "",
    "phoneNumber": null,
    "givenName": "",
    "familyName": null,
    "dateDemand": "2023-09-18T10:31:30.6882299",
    "dateCreation": "2023-09-18T10:31:30.6882299",
    "dateUpdate": null,
    "workFlowStep": {
      "id": 22290,
      "label": "Nouveau",
      "color": "#1E8EE1",
      "order": 0,
      "itemLimit": null,
      "type": "DataSubjectRequest",
      "finalStep": false,
      "initialStep": true,
      "authorizedRole": null,
      "authorizedRoleId": null,
      "descriptionHtml": null,
      "mappedState": "Open"
    },
    "workFlowStepId": XX,
    "channel": "Widget",
    "refId": null,
    "userId": null,
    "purposes": [
      "Rectification"
    ],
    "closedReason": "None",
    "closedReasonDescription": null,
    "expiryTime": "2023-10-18T10:31:30.68823",
    "address": null,
    "zipCode": null,
    "city": null,
    "countryCode": null,
    "nbMessages": 0,
    "nbMessagesNotViewed": 0,
    "nbMessagesIncoming": 0,
    "lastMessageDate": null,
    "remainingDays": -6,
    "closingTime": null,
    "additionalDatas": {
      "givenName": null,
      "13_long": "XX",
      "13_html": "XX"
    },
    "userNotified": false,
    "dateUserNotified": null,
    "sendNotification": false,
    "emailValidationDate": "2023-09-18T10:31:53.8554799",
    "mailValidated": true,
    "referrerUrl": "",
    "demandId": "",
    "identityValidated": false,
    "dateIdentityValidated": null,
    "widgetId": 0  
  }
]

Pour récupérer le format Objet de votre configurée avec des champs personnalisés, vous pouvez faire un export d'une demande au format JSON et obtenir ainsi le modèle JSON.

hashtag
Les EndPoints de l'API

Voici les principaux Endpoints qui vous seront utiles pour intégrer vos applications avec le module exercice de droits de Dastra.

hashtag
Créer une nouvelle demande d'exercice de droits dans 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
Récupérer une demande d'exercice de droits existante via son 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
Récupérer une liste paginée de demandes d'exercice de droits

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

Vous pouvez passer des paramètres de recherche optionnels à votre requête pour filtrer la réponse de l'API

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
Mettre à jour une demande d'exercice de droits

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
Supprimer une demande d'exercice de droits via son id

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

Attention, cette action est irréversible, la demande d'exercice de droit sera supprimée définitivement de nos bases de données

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
Changer l'étape de processus de la demande d'exercice de droits

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
Archiver une demande d'exercice de droit via son Id

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

Ce endpoint applique le state "Archived" à la demande d'exercice de droits

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
Retirer le statut archiver d'une demande d'exercice de droits

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

Mis à jour

Ce contenu vous a-t-il été utile ?