Aller au contenu principal
NEXCLARADocumentation

Schémas : pilot

Schémas dont la première opération qui les emploie appartient à la famille pilot. 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é.

AttestationIn

Acte sur une etape : piece recue (reference) ou non-application (motif).

Type : object

PropriétéTypeRequisDescriptionContraintes
idempotency_keystringouiminLength: 8 ; maxLength: 64
kind"completed" | "not_applicable"oui
referencestring | nullnonminLength: 3 ; maxLength: 80
waiver"assisted_entry_only" | nullnon

Employé par : pilotAttestStep

AttestationOut

Acte enregistre sur une etape.

Type : object

PropriétéTypeRequisDescriptionContraintes
attested_atstring (date-time)oui
attested_bystring (uuid)oui
idstring (uuid)oui
kind"completed" | "not_applicable"oui
referencestring | nulloui
replayedbooleannonVrai si la cle d'idempotence a rejoue un acte existant.default: false
waiver"assisted_entry_only" | nulloui

Employé par : pilotAttestStep, pilotJourney

EngagementOut

Ouverture du parcours.

Type : object

PropriétéTypeRequisDescriptionContraintes
definition_versionintegeroui
idstring (uuid)oui
opened_atstring (date-time)oui
opened_bystring (uuid)oui

Employé par : pilotJourney, pilotOpenEngagement

MilestoneOut

Jalon : atteint quand ses etapes obligatoires sont reglees. Aucun pourcentage.

Type : object

PropriétéTypeRequisDescriptionContraintes
milestonestringoui
reachedbooleanoui
required_settledintegeroui
required_totalintegeroui
required_unavailableintegeroui

Employé par : pilotJourney

NextOut

Maintenant, en attente de, a venir.

Type : object

PropriétéTypeRequisDescriptionContraintes
nowarray<string>oui
upcomingarray<string>oui
waiting_onarray<WaitingOut>oui

Employé par : pilotJourney

PilotEntitlementsOut

Perimetre applique par CONTROL (dimension D), sans montant.

Type : object

PropriétéTypeRequisDescriptionContraintes
dossier_capinteger | nulloui
ends_onstring (date) | nulloui
modulesarray<string>oui
pilotbooleanoui
revisionintegeroui
starts_onstring (date)oui

Employé par : pilotJourney

PilotJourneyOut

Le parcours du pilote de l'institution, pour ce lecteur.

Type : object

PropriétéTypeRequisDescriptionContraintes
definition_versionintegeroui
engagementEngagementOut | nulloui
entitlementsPilotEntitlementsOut | nulloui
journeystringoui
milestonesarray<MilestoneOut>oui
nextNextOutoui
stage"framework" | "configured" | "collecting" | "dataset_frozen"oui
stepsarray<PilotStepOut>oui

Employé par : pilotJourney

PilotStepOut

Etape du parcours, et ce qui fonde son etat.

Type : object

PropriétéTypeRequisDescriptionContraintes
actionablebooleanouiLe lecteur detient la permission d'agir maintenant.
approverstring | nullouiPermission de la fonction qui approuve.
attestationAttestationOut | nulloui
blockersarray<string>oui
codestringoui
completion"computed" | "attested" | "unavailable"oui
countsmap<string, integer> | nullouiComptes de l'etape ; `null` si le lecteur n'a pas la lecture du module.
criterion_metbooleanoui
milestonestringoui
owner_modulestringoui
planned_slicestring | nulloui
requiredbooleanoui
responsiblestringouiPermission de la fonction qui agit.
state"blocked" | "available" | "in_progress" | "awaiting_approval" | "completed" | "not_applicable" | "unavailable"oui
unavailable_reasonstring | nulloui
waiversarray<"assisted_entry_only">oui

Employé par : pilotJourney

WaitingOut

Etape qui attend une autre fonction.

Type : object

PropriétéTypeRequisDescriptionContraintes
permissionstringoui
stepstringoui

Employé par : pilotJourney