Aller au contenu principal
NEXCLARADocumentation

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éTypeRequisDescriptionContraintes
choicesarray<string>oui
maxstring | nulloui
minstring | nulloui
namestringoui
requiredbooleanoui
sectionstringoui
typestringoui
unit"none" | "ratio" | "currency" | "month" | "year"oui
valuestring | boolean | array<string> | nulloui

Employé par : policiesCreate, policiesDerive, policiesGet, policiesSetParameters

ParametersIn

Parametres fixes par l'institution. `null` remet un parametre a « non fixe ».

Type : object

PropriétéTypeRequisDescriptionContraintes
row_versionintegerouiminimum: 1
valuesmap<string, string | boolean | array<string> | null>ouimaxProperties: 64

Employé par : policiesSetParameters

PolicyCreateIn

Creation d'un brouillon a partir d'une grille initiale.

Type : object

PropriétéTypeRequisDescriptionContraintes
grid_codestringouiminLength: 3 ; maxLength: 64
product_idstring (uuid)oui

Employé par : policiesCreate

PolicyDetailOut

Version complete : definition, parametres, blocages, simulations.

Type : object

PropriétéTypeRequisDescriptionContraintes
approved_atstring (date-time) | nulloui
approved_bystring (uuid) | nulloui
archived_atstring (date-time) | nulloui
archived_reasonstring | nulloui
authorsarray<string (uuid)>oui
blockersarray<string>oui
codestringoui
created_atstring (date-time)oui
definitionobjectoui
derived_from_policy_idstring (uuid) | nulloui
effective_fromstring (date-time) | nulloui
fingerprintstringoui
grid_amplitudearray<any>ouiminItems: 2 ; maxItems: 2
idstring (uuid)oui
last_simulated_atstring (date-time) | nulloui
origin"reference_grid" | "institution"oui
parametersarray<ParameterOut>oui
product_idstring (uuid)oui
row_versionintegeroui
scalearray<any>ouiminItems: 2 ; maxItems: 2
simulation_countintegeroui
simulationsarray<SimulationOut>oui
statusPolicyStatusoui
submitted_atstring (date-time) | nulloui
submitted_bystring (uuid) | nulloui
titlestring | nulloui
updated_atstring (date-time)oui
versionintegeroui
warningsarray<string>oui

Employé par : policiesCreate, policiesDerive, policiesGet, policiesSetParameters

PolicyOut

Version de politique, sans sa definition.

Type : object

PropriétéTypeRequisDescriptionContraintes
approved_atstring (date-time) | nulloui
approved_bystring (uuid) | nulloui
archived_atstring (date-time) | nulloui
archived_reasonstring | nulloui
authorsarray<string (uuid)>oui
codestringoui
created_atstring (date-time)oui
derived_from_policy_idstring (uuid) | nulloui
effective_fromstring (date-time) | nulloui
fingerprintstringoui
idstring (uuid)oui
last_simulated_atstring (date-time) | nulloui
origin"reference_grid" | "institution"oui
product_idstring (uuid)oui
row_versionintegeroui
simulation_countintegeroui
statusPolicyStatusoui
submitted_atstring (date-time) | nulloui
submitted_bystring (uuid) | nulloui
titlestring | nulloui
updated_atstring (date-time)oui
versionintegeroui

Employé par : policiesApprove, policiesArchive, policiesList, policiesReject, policiesSimulate, policiesSubmit

PolicyRejectIn

Rejet motive par un code.

Type : object

PropriétéTypeRequisDescriptionContraintes
reasonRejectionReasonoui
row_versionintegerouiminimum: 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éTypeRequisDescriptionContraintes
effective_fromstring (date-time) | nullnon
row_versionintegerouiminimum: 1

Employé par : policiesSubmit

ReferenceGridOut

Grille initiale des Specifications, proposee a la creation.

Type : object

PropriétéTypeRequisDescriptionContraintes
categoryCreditProductCategoryoui
codestringoui
sourcestringoui
titlestringoui
validation_statusstringoui

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éTypeRequisDescriptionContraintes
conditionsarray<ConditionOut> | nulloui
explanationOperationalExplanationOut | nulloui
forced_reviewsarray<string>oui
outcome"approve" | "approve_with_conditions" | "review" | "decline" | nulloui
refused_fieldsarray<string>oui
scoreinteger | nulloui
traceobject | nulloui

Employé par : policiesSimulate

SimulationIn

Sans `cases`, rejeu des dossiers deja evalues du produit.

Type : object

PropriétéTypeRequisDescriptionContraintes
casesarray<map<string, string | boolean | null>> | nullnonminItems: 1 ; maxItems: 1000
row_versionintegerouiminimum: 1

Employé par : policiesSimulate

SimulationOut

Resume d'une simulation : comptes seulement, aucune donnee de dossier.

Type : object

PropriétéTypeRequisDescriptionContraintes
created_atstring (date-time)oui
created_bystring (uuid)oui
idstring (uuid)oui
mode"cases" | "replay"oui
policy_fingerprintstringoui
policy_idstring (uuid)oui
sample_sizeintegeroui
summaryobjectoui

Employé par : policiesCreate, policiesDerive, policiesGet, policiesSetParameters, policiesSimulate

SimulationResultOut

Simulation enregistree, version mise a jour, et cas du jeu d'essai.

Type : object

PropriétéTypeRequisDescriptionContraintes
casesarray<SimulatedCaseOut>oui
policyPolicyOutoui
scalesarray<CharacteristicScaleOut>oui
simulationSimulationOutoui

Employé par : policiesSimulate