Aller au contenu principal
NEXCLARADocumentation

Schémas : trust

Schémas dont la première opération qui les emploie appartient à la famille trust. Un schéma partagé est décrit une seule fois, ici, et lié depuis toutes les opérations qui l'emploient.

Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.

AccessReportIn

Emission du releve d'acces, qui clot la demande.

Type : object

PropriétéTypeRequisDescriptionContraintes
row_versionintegerouiminimum: 1

Employé par : trustAccessReport

ApplicantConsentsOut

Consentements du demandeur d'un dossier.

Type : object

PropriétéTypeRequisDescriptionContraintes
application_idstring (uuid)oui
historyarray<ConsentEventOut>oui
purposesarray<ConsentPurposeOut>oui
statusesarray<ConsentStatusOut>oui

Employé par : applicationsConsents, applicationsRecordConsent

AuditIntegrityOut

Verification complete de la chaine de l'institution.

Type : object

PropriétéTypeRequisDescriptionContraintes
first_invalid_sequenceinteger | nulloui
head_hashstringoui
head_sequenceintegeroui
intactbooleanoui
reasonstring | nulloui
verified_atstring (date-time)oui
verified_eventsintegeroui

Employé par : trustComplianceReport

ComplianceReportOut

Rapport de conformite d'une periode (dates incluses, UTC).

Type : object

PropriétéTypeRequisDescriptionContraintes
generated_atstring (date-time)oui
period_endstring (date)oui
period_startstring (date)oui
sectionsComplianceSectionsOutoui

Employé par : trustComplianceReport

ComplianceSectionsOut

Les cinq sections du rapport.

Type : object

PropriétéTypeRequisDescriptionContraintes
audit_integrityAuditIntegrityOutoui
consentsConsentsReportOutoui
consultationsConsultationsReportOutoui
data_rightsRightsReportOutoui
retentionRetentionReportOutoui

Employé par : trustComplianceReport

ConsentEventOut

Evenement de consentement, avec son empreinte.

Type : object

PropriétéTypeRequisDescriptionContraintes
evidence_referencestring | nulloui
fingerprintstringoui
idstring (uuid)oui
kind"granted" | "withdrawn"oui
purpose_idstring (uuid)oui
recorded_atstring (date-time)oui
recorded_bystring (uuid)oui

Employé par : applicationsConsents, applicationsRecordConsent

ConsentIn

Recueil ou retrait pour le demandeur du dossier.

Type : object

PropriétéTypeRequisDescriptionContraintes
evidence_referencestring | nullnonReference de la piece dans l'archive de l'institution ; jamais un contenu.maxLength: 80
kind"granted" | "withdrawn"oui
purpose_idstring (uuid)oui

Employé par : applicationsRecordConsent

ConsentPurposeIn

Nouvelle version de finalite ; la version active du meme code est retiree.

Type : object

PropriétéTypeRequisDescriptionContraintes
codestringouiminLength: 2 ; maxLength: 48
gates"credit_evaluation" | nullnonTraitement conditionne : sans consentement en vigueur, il est refuse.
label_enstringouiminLength: 1 ; maxLength: 160
label_frstringouiminLength: 1 ; maxLength: 160

Employé par : trustCreatePurpose

ConsentPurposeOut

Version de finalite.

Type : object

PropriétéTypeRequisDescriptionContraintes
codestringoui
created_atstring (date-time)oui
gates"credit_evaluation" | nulloui
idstring (uuid)oui
label_enstring | nulloui
label_frstringoui
retired_atstring (date-time) | nulloui
status"active" | "retired"oui
versionintegeroui

Employé par : applicationsConsents, applicationsRecordConsent, trustCreatePurpose, trustListPurposes, trustRetirePurpose

ConsentStatusOut

Etat d'une finalite active pour le demandeur.

Type : object

PropriétéTypeRequisDescriptionContraintes
purposeConsentPurposeOutoui
state"granted" | "withdrawn" | nulloui

Employé par : applicationsConsents, applicationsRecordConsent

ConsentsReportOut

Consentements par finalite et refus d'evaluation.

Type : object

PropriétéTypeRequisDescriptionContraintes
evaluations_refusedintegeroui
purposesarray<PurposeReportOut>oui

Employé par : trustComplianceReport

ConsultationsReportOut

Consultations journalisees de la periode (P56).

Type : object

PropriétéTypeRequisDescriptionContraintes
access_reportsintegeroui
attestation_downloadsintegeroui
by_viewmap<string, integer>oui
distinct_usersintegeroui
dossier_consultationsintegeroui
evidence_exportsintegeroui
support_consultationsintegeroui
worklist_pagesintegeroui

Employé par : trustComplianceReport

PurgeRunOut

Execution de purge (l'attestation se telecharge a part).

Type : object

PropriétéTypeRequisDescriptionContraintes
by_categorymap<string, integer>oui
by_reasonmap<string, integer>oui
by_resourcemap<string, integer>oui
executed_bystringoui
finished_atstring (date-time)oui
idstring (uuid)oui
itemsintegeroui
manifest_sha256stringoui
signedbooleanoui
started_atstring (date-time)oui

Employé par : trustPurgeRuns

PurposeReportOut

Une version de finalite dans le rapport.

Type : object

PropriétéTypeRequisDescriptionContraintes
codestringoui
gates"credit_evaluation" | nulloui
granted_in_periodintegeroui
granted_nowintegeroui
idstring (uuid)oui
status"active" | "retired"oui
versionintegeroui
withdrawn_in_periodintegeroui
withdrawn_nowintegeroui

Employé par : trustComplianceReport

RefusalIn

Refus motive, par un code.

Type : object

PropriétéTypeRequisDescriptionContraintes
ground"legal_retention_obligation" | "ongoing_contract" | "legal_claims" | "identity_not_verified" | "manifestly_unfounded"oui
row_versionintegerouiminimum: 1

Employé par : trustRefuseRightsRequest

RetentionCategory

Categorie de donnees purgeables. Liste fermee, donnees reelles.

Type : string

Valeurs admises : evaluated_application_inputs, draft_application_inputs, unlinked_import_rows

Employé par : trustConfirmRetention

RetentionIn

Duree confirmee pour une categorie, en jours.

Type : object

PropriétéTypeRequisDescriptionContraintes
daysintegerouiminimum: 1 ; maximum: 36500

Employé par : trustConfirmRetention

RetentionOut

Durees de conservation de l'institution.

Type : object

PropriétéTypeRequisDescriptionContraintes
rulesarray<RetentionRuleOut>oui

Employé par : trustConfirmRetention, trustRetention

RetentionReportOut

Durees, purges de la periode, elements echus.

Type : object

PropriétéTypeRequisDescriptionContraintes
destroyed_by_categorymap<string, integer>oui
last_run_atstring (date-time) | nulloui
pending_nowmap<string, integer>oui
purge_runsintegeroui
rulesarray<RetentionRuleReportOut>oui

Employé par : trustComplianceReport

RetentionRuleOut

Duree en vigueur d'une categorie et elements echus.

Type : object

PropriétéTypeRequisDescriptionContraintes
category"evaluated_application_inputs" | "draft_application_inputs" | "unlinked_import_rows"oui
confirmed_atstring (date-time) | nulloui
confirmed_bystring (uuid) | nulloui
daysintegeroui
erased_fieldsarray<string>oui
maximum_daysintegeroui
minimum_daysintegeroui
pendinginteger | nullouiElements echus a purger au prochain passage ; `null` si non confirmee.
provisional_daysintegeroui
state"provisional" | "confirmed"oui

Employé par : trustConfirmRetention, trustRetention

RetentionRuleReportOut

Duree en vigueur dans le rapport.

Type : object

PropriétéTypeRequisDescriptionContraintes
category"evaluated_application_inputs" | "draft_application_inputs" | "unlinked_import_rows"oui
confirmed_atstring (date-time) | nulloui
daysintegeroui
state"provisional" | "confirmed"oui

Employé par : trustComplianceReport

RightsReportOut

Demandes de droits de la periode et en cours.

Type : object

PropriétéTypeRequisDescriptionContraintes
awaiting_purge_nowintegeroui
open_nowintegeroui
overdue_nowintegeroui
receivedmap<string, integer>oui
received_by_statusmap<string, integer>oui
response_daysintegeroui

Employé par : trustComplianceReport

RightsRequestIn

Demande a enregistrer. La reference sert a trouver la personne ; elle n'est pas gardee.

Type : object

PropriétéTypeRequisDescriptionContraintes
applicant_referencestringouiminLength: 1 ; maxLength: 64
kind"access" | "rectification" | "erasure"oui
received_atstring (date-time) | nullnonReception anterieure (courrier) ; maintenant par defaut.
received_via"in_person" | "postal_mail" | "electronic"oui

Employé par : trustRegisterRightsRequest

RightsRequestOut

Demande d'exercice d'un droit.

Type : object

PropriétéTypeRequisDescriptionContraintes
completed_atstring (date-time) | nulloui
decided_atstring (date-time) | nulloui
due_atstring (date-time)oui
idstring (uuid)oui
kind"access" | "rectification" | "erasure"oui
outcome"access_report_issued" | "no_data" | "rectified_at_source" | "erased" | nulloui
overduebooleanoui
purge_run_idstring (uuid) | nulloui
received_atstring (date-time)oui
received_via"in_person" | "postal_mail" | "electronic"oui
refusal_ground"legal_retention_obligation" | "ongoing_contract" | "legal_claims" | "identity_not_verified" | "manifestly_unfounded" | nulloui
report_sha256string | nulloui
row_versionintegeroui
status"open" | "awaiting_purge" | "completed" | "refused"oui
subject_foundbooleanoui

Employé par : trustAcceptErasure, trustCompleteRectification, trustGetRightsRequest, trustListRightsRequests, trustRefuseRightsRequest, trustRegisterRightsRequest

RightsTransitionIn

Ecriture sans autre donnee que la version lue.

Type : object

PropriétéTypeRequisDescriptionContraintes
row_versionintegerouiminimum: 1

Employé par : trustAcceptErasure, trustCompleteRectification