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.
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.
Pour obtenir le format de l'objet avec vos champs personnalisés, exportez une demande au format JSON : vous récupérez ainsi le modèle JSON de votre espace de travail.
Les identifiants des demandes sont des GUID (par exemple 3fa85f64-5717-4562-b3fc-2c963f66afa6). L'identifiant de l'espace de travail est un entier.
Les endpoints de l'API
Voici les principaux endpoints qui vous seront utiles pour intégrer vos applications avec le module Exercices des droits de Dastra.
Créer une nouvelle demande d'exercice de droits dans Dastra
POST /v1/ws/{workspaceId}/DataSubjectRequests
Paramètres d'URL
workspaceId*
Integer
L'identifiant de l'espace de travail
Corps de la requête
title*
String
Titre de la demande
message
String
Texte de la demande
locale*
String
Langue du demandeur (par exemple fr, en)
areaId*
Integer
Identifiant de l'unité organisationnelle de la demande
email
String
Adresse e-mail du demandeur
dateDemand
DateTime
Date de la demande (par défaut, la date du jour)
purposes*
Array[String]
Types de demande concernés (au moins un). Valeurs possibles : voir le paramètre purposes de la liste ci-dessous
Récupérer une demande d'exercice de droits existante via son identifiant
GET /v1/ws/{workspaceId}/DataSubjectRequests/{id}
Paramètres d'URL
workspaceId*
Integer
L'identifiant de l'espace de travail dans lequel se trouve la demande d'exercice de droits
id*
GUID
L'identifiant (GUID) de la demande d'exercice de droits
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 pour filtrer la réponse de l'API.
Paramètres d'URL
workspaceId*
Integer
L'identifiant de l'espace de travail à interroger
Paramètres de requête
overtaking
Boolean
Rechercher les demandes dont le délai légal de réponse est dépassé
archived
Boolean
Retourner les demandes de la corbeille (false par défaut)
q
String
Recherche texte dans le titre de la demande
widgetId
Integer
Filtrer les demandes issues d'un formulaire de collecte
areaId
Integer
Filtrer les demandes d'une unité organisationnelle
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, AdministrativeAccess, DPORequest, ThirdPartyRequest, DataProtectionComplaint, DoNotSellOrShare, LimitUseSensitivePersonalInformation, WithdrawalOfConsent)
ids
Array[GUID]
Sélectionner une liste de demandes par leurs identifiants
tags
Array[GUID]
Sélectionner les demandes ayant des tags spécifiques (passer un tableau d'identifiants de tags en query string)
page
Integer
La page à récupérer (la première page est 1)
size
Integer
Le nombre d'éléments retournés par page (20 par défaut)
skip
Integer
Le nombre d'éléments à ignorer (remplace page s'il est fourni)
sortBy
String
Le champ utilisé pour ordonner les éléments
asc
Boolean
true pour un tri ascendant
Mettre à jour une demande d'exercice de droits
PUT /v1/ws/{workspaceId}/DataSubjectRequests/{id}
Paramètres d'URL
workspaceId*
Integer
L'identifiant de l'espace de travail dans lequel se trouve la demande d'exercice de droits
id*
GUID
L'identifiant (GUID) de la demande d'exercice de droits
Corps de la requête
dataSubjectRequest
Object
L'objet complet de la demande d'exercice de droits (voir plus haut ou notre documentation d'API Swagger). Son champ id doit correspondre à l'identifiant de l'URL.
La réponse n'a pas de contenu.
Supprimer une demande d'exercice de droits via son identifiant
DELETE /v1/ws/{workspaceId}/DataSubjectRequests/{id}
Attention, cette action est irréversible : la demande d'exercice de droits est supprimée définitivement de nos bases de données. Pour la déplacer dans la corbeille sans la supprimer, utilisez l'endpoint d'archivage ci-dessous.
Paramètres d'URL
workspaceId*
Integer
L'identifiant de l'espace de travail dans lequel se trouve la demande d'exercice de droits
id*
GUID
L'identifiant (GUID) de la demande d'exercice de droits
La réponse n'a pas de contenu.
Changer l'étape de processus de la demande d'exercice de droits
POST /v1/ws/{workspaceId}/DataSubjectRequests/workflow
Paramètres d'URL
workspaceId*
Integer
L'identifiant de l'espace de travail dans lequel se trouve la demande d'exercice de droits
Corps de la requête
id*
GUID
L'identifiant (GUID) de la demande d'exercice de droits dont vous souhaitez modifier l'étape de processus
stepId*
Integer
L'identifiant de l'étape de processus à appliquer à la demande
comment
String
Commentaire optionnel associé au changement d'étape
Archiver une demande d'exercice de droits via son identifiant
POST /v1/ws/{workspaceId}/DataSubjectRequests/archive/{id}
Cet endpoint déplace la demande d'exercice de droits dans la corbeille (état « archivée »).
Paramètres d'URL
workspaceId*
Integer
L'identifiant de l'espace de travail dans lequel se trouve la demande d'exercice de droits
id*
GUID
L'identifiant (GUID) de la demande d'exercice de droits à archiver
La réponse contient la demande d'exercice de droits (voir l'objet décrit plus haut).
Retirer le statut archivé d'une demande d'exercice de droits
POST /v1/ws/{workspaceId}/DataSubjectRequests/restore/{id}
Cet endpoint restaure une demande depuis la corbeille.
Paramètres d'URL
workspaceId*
Integer
L'identifiant de l'espace de travail dans lequel se trouve la demande d'exercice de droits
id*
GUID
L'identifiant (GUID) de la demande d'exercice de droits à restaurer
La réponse contient la demande d'exercice de droits (voir l'objet décrit plus haut).
Mis à jour
Ce contenu vous a-t-il été utile ?