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é | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
idempotency_key | string | oui | minLength: 8 ; maxLength: 64 | |
kind | "completed" | "not_applicable" | oui | ||
reference | string | null | non | minLength: 3 ; maxLength: 80 | |
waiver | "assisted_entry_only" | null | non |
Employé par : pilotAttestStep
AttestationOut
Acte enregistre sur une etape.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
attested_at | string (date-time) | oui | ||
attested_by | string (uuid) | oui | ||
id | string (uuid) | oui | ||
kind | "completed" | "not_applicable" | oui | ||
reference | string | null | oui | ||
replayed | boolean | non | Vrai si la cle d'idempotence a rejoue un acte existant. | default: false |
waiver | "assisted_entry_only" | null | oui |
Employé par : pilotAttestStep, pilotJourney
EngagementOut
Ouverture du parcours.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
definition_version | integer | oui | ||
id | string (uuid) | oui | ||
opened_at | string (date-time) | oui | ||
opened_by | string (uuid) | oui |
Employé par : pilotJourney, pilotOpenEngagement
MilestoneOut
Jalon : atteint quand ses etapes obligatoires sont reglees. Aucun pourcentage.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
milestone | string | oui | ||
reached | boolean | oui | ||
required_settled | integer | oui | ||
required_total | integer | oui | ||
required_unavailable | integer | oui |
Employé par : pilotJourney
NextOut
Maintenant, en attente de, a venir.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
now | array<string> | oui | ||
upcoming | array<string> | oui | ||
waiting_on | array<WaitingOut> | oui |
Employé par : pilotJourney
PilotEntitlementsOut
Perimetre applique par CONTROL (dimension D), sans montant.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
dossier_cap | integer | null | oui | ||
ends_on | string (date) | null | oui | ||
modules | array<string> | oui | ||
pilot | boolean | oui | ||
revision | integer | oui | ||
starts_on | string (date) | oui |
Employé par : pilotJourney
PilotJourneyOut
Le parcours du pilote de l'institution, pour ce lecteur.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
definition_version | integer | oui | ||
engagement | EngagementOut | null | oui | ||
entitlements | PilotEntitlementsOut | null | oui | ||
journey | string | oui | ||
milestones | array<MilestoneOut> | oui | ||
next | NextOut | oui | ||
stage | "framework" | "configured" | "collecting" | "dataset_frozen" | oui | ||
steps | array<PilotStepOut> | oui |
Employé par : pilotJourney
PilotStepOut
Etape du parcours, et ce qui fonde son etat.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
actionable | boolean | oui | Le lecteur detient la permission d'agir maintenant. | |
approver | string | null | oui | Permission de la fonction qui approuve. | |
attestation | AttestationOut | null | oui | ||
blockers | array<string> | oui | ||
code | string | oui | ||
completion | "computed" | "attested" | "unavailable" | oui | ||
counts | map<string, integer> | null | oui | Comptes de l'etape ; `null` si le lecteur n'a pas la lecture du module. | |
criterion_met | boolean | oui | ||
milestone | string | oui | ||
owner_module | string | oui | ||
planned_slice | string | null | oui | ||
required | boolean | oui | ||
responsible | string | oui | Permission de la fonction qui agit. | |
state | "blocked" | "available" | "in_progress" | "awaiting_approval" | "completed" | "not_applicable" | "unavailable" | oui | ||
unavailable_reason | string | null | oui | ||
waivers | array<"assisted_entry_only"> | oui |
Employé par : pilotJourney
WaitingOut
Etape qui attend une autre fonction.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
permission | string | oui | ||
step | string | oui |
Employé par : pilotJourney