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.
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.
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.
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.
Créer une nouvelle demande d'exercice de droits dans Dastra
POST
/v1/ws/{workspaceId}/DataSubjectRequests
Path Parameters
Name | Type | Description |
---|---|---|
workspaceId* | String | L'Id du workspace dans lequel vous souhaitez poster la demande d'exercice de droits |
Récupérer une demande d'exercice de droits existante via son id
GET
/v1/ws/{workspaceId}/DataSubjectRequests/{id}
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 |
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
Path Parameters
Name | Type | Description |
---|---|---|
workspaceId* | String | Le workspace id que vous souhaitez requêter |
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 |
Mettre à jour une demande d'exercice de droits
PUT
/v1/ws/{workspaceId}/DataSubjectRequests/{id}
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 |
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 swagger) |
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
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 |
Changer l'étape de processus de la demande d'exercice de droits
POST
/v1/ws/{workspaceId}/DataSubjectRequests/workflow
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 |
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 |
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
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 |
Retirer le statut archiver d'une demande d'exercice de droits
POST
/v1/ws/{workspaceId}/DataSubjectRequests/restore/{id}
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 |
Dernière mise à jour