Schémas : policies
Schémas dont la première opération qui les emploie appartient à la famille policies. 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é.
ParameterOut
Parametre d'une version : type, valeur fixee ou non, caractere obligatoire.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
choices | array<string> | oui | ||
max | string | null | oui | ||
min | string | null | oui | ||
name | string | oui | ||
required | boolean | oui | ||
section | string | oui | ||
type | string | oui | ||
unit | "none" | "ratio" | "currency" | "month" | "year" | oui | ||
value | string | boolean | array<string> | null | oui |
Employé par : policiesCreate, policiesDerive, policiesGet, policiesSetParameters
ParametersIn
Parametres fixes par l'institution. `null` remet un parametre a « non fixe ».
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
row_version | integer | oui | minimum: 1 | |
values | map<string, string | boolean | array<string> | null> | oui | maxProperties: 64 |
Employé par : policiesSetParameters
PolicyCreateIn
Creation d'un brouillon a partir d'une grille initiale.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
grid_code | string | oui | minLength: 3 ; maxLength: 64 | |
product_id | string (uuid) | oui |
Employé par : policiesCreate
PolicyDetailOut
Version complete : definition, parametres, blocages, simulations.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
approved_at | string (date-time) | null | oui | ||
approved_by | string (uuid) | null | oui | ||
archived_at | string (date-time) | null | oui | ||
archived_reason | string | null | oui | ||
authors | array<string (uuid)> | oui | ||
blockers | array<string> | oui | ||
code | string | oui | ||
created_at | string (date-time) | oui | ||
definition | object | oui | ||
derived_from_policy_id | string (uuid) | null | oui | ||
effective_from | string (date-time) | null | oui | ||
fingerprint | string | oui | ||
grid_amplitude | array<any> | oui | minItems: 2 ; maxItems: 2 | |
id | string (uuid) | oui | ||
last_simulated_at | string (date-time) | null | oui | ||
origin | "reference_grid" | "institution" | oui | ||
parameters | array<ParameterOut> | oui | ||
product_id | string (uuid) | oui | ||
row_version | integer | oui | ||
scale | array<any> | oui | minItems: 2 ; maxItems: 2 | |
simulation_count | integer | oui | ||
simulations | array<SimulationOut> | oui | ||
status | PolicyStatus | oui | ||
submitted_at | string (date-time) | null | oui | ||
submitted_by | string (uuid) | null | oui | ||
title | string | null | oui | ||
updated_at | string (date-time) | oui | ||
version | integer | oui | ||
warnings | array<string> | oui |
Employé par : policiesCreate, policiesDerive, policiesGet, policiesSetParameters
PolicyOut
Version de politique, sans sa definition.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
approved_at | string (date-time) | null | oui | ||
approved_by | string (uuid) | null | oui | ||
archived_at | string (date-time) | null | oui | ||
archived_reason | string | null | oui | ||
authors | array<string (uuid)> | oui | ||
code | string | oui | ||
created_at | string (date-time) | oui | ||
derived_from_policy_id | string (uuid) | null | oui | ||
effective_from | string (date-time) | null | oui | ||
fingerprint | string | oui | ||
id | string (uuid) | oui | ||
last_simulated_at | string (date-time) | null | oui | ||
origin | "reference_grid" | "institution" | oui | ||
product_id | string (uuid) | oui | ||
row_version | integer | oui | ||
simulation_count | integer | oui | ||
status | PolicyStatus | oui | ||
submitted_at | string (date-time) | null | oui | ||
submitted_by | string (uuid) | null | oui | ||
title | string | null | oui | ||
updated_at | string (date-time) | oui | ||
version | integer | oui |
Employé par : policiesApprove, policiesArchive, policiesList, policiesReject, policiesSimulate, policiesSubmit
PolicyRejectIn
Rejet motive par un code.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
reason | RejectionReason | oui | ||
row_version | integer | oui | minimum: 1 |
Employé par : policiesReject
PolicyStatus
Etats normatifs d'une version de politique.
Type : string
Valeurs admises : draft, simulation, validation, active, archived
Employé par : policiesApprove, policiesArchive, policiesCreate, policiesDerive, policiesGet, policiesList, policiesReject, policiesSetParameters, policiesSimulate, policiesSubmit
PolicySubmitIn
Soumission, avec une date d'effet proposee (maintenant si absente).
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
effective_from | string (date-time) | null | non | ||
row_version | integer | oui | minimum: 1 |
Employé par : policiesSubmit
ReferenceGridOut
Grille initiale des Specifications, proposee a la creation.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
category | CreditProductCategory | oui | ||
code | string | oui | ||
source | string | oui | ||
title | string | oui | ||
validation_status | string | oui |
Employé par : policiesReferenceGrids
RejectionReason
Motif CODIFIE d'un rejet d'approbation. Un code, pas un texte libre : le motif entre dans la chaine d'audit, qui n'accueille aucune saisie libre susceptible de porter une donnee personnelle. Le detail se discute hors de l'outil ; le motif, lui, reste.
Type : string
Valeurs admises : parameters_inadequate, simulation_insufficient, effective_date_inadequate, other
Employé par : policiesReject
SimulatedCaseOut
Issue d'un cas du jeu d'essai, dans l'ordre fourni. Pour un cas d'essai, l'explication operationnelle et la trace du calcul FICTIF sont jointes (UX0, P4) : facteurs, tranches, conditions. Elles ne sont jamais enregistrees. Pour un rejeu, elles sont absentes.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
conditions | array<ConditionOut> | null | oui | ||
explanation | OperationalExplanationOut | null | oui | ||
forced_reviews | array<string> | oui | ||
outcome | "approve" | "approve_with_conditions" | "review" | "decline" | null | oui | ||
refused_fields | array<string> | oui | ||
score | integer | null | oui | ||
trace | object | null | oui |
Employé par : policiesSimulate
SimulationIn
Sans `cases`, rejeu des dossiers deja evalues du produit.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
cases | array<map<string, string | boolean | null>> | null | non | minItems: 1 ; maxItems: 1000 | |
row_version | integer | oui | minimum: 1 |
Employé par : policiesSimulate
SimulationOut
Resume d'une simulation : comptes seulement, aucune donnee de dossier.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
created_at | string (date-time) | oui | ||
created_by | string (uuid) | oui | ||
id | string (uuid) | oui | ||
mode | "cases" | "replay" | oui | ||
policy_fingerprint | string | oui | ||
policy_id | string (uuid) | oui | ||
sample_size | integer | oui | ||
summary | object | oui |
Employé par : policiesCreate, policiesDerive, policiesGet, policiesSetParameters, policiesSimulate
SimulationResultOut
Simulation enregistree, version mise a jour, et cas du jeu d'essai.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
cases | array<SimulatedCaseOut> | oui | ||
policy | PolicyOut | oui | ||
scales | array<CharacteristicScaleOut> | oui | ||
simulation | SimulationOut | oui |
Employé par : policiesSimulate