Schemas: policies

Schemas whose first using operation belongs to the policies family. A shared schema is described once, here, and linked from every operation that uses it.

Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.

`ParameterOut`

Parametre d'une version : type, valeur fixee ou non, caractere obligatoire.

Type : object

Property	Type	Required
`choices`	`array<string>`	yes
`max`	`string \| null`	yes
`min`	`string \| null`	yes
`name`	`string`	yes
`required`	`boolean`	yes
`section`	`string`	yes
`type`	`string`	yes
`unit`	`"none" \| "ratio" \| "currency" \| "month" \| "year"`	yes
`value`	`string \| boolean \| array<string> \| null`	yes

Used by : policiesCreate, policiesDerive, policiesGet, policiesSetParameters

`ParametersIn`

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

Type : object

Property	Type	Required	Description	Constraints
`row_version`	`integer`	yes		minimum: 1
`values`	`map<string, string \| boolean \| array<string> \| null>`	yes		maxProperties: 64

Used by : policiesSetParameters

`PolicyCreateIn`

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

Type : object

Property	Type	Required	Description	Constraints
`grid_code`	`string`	yes		minLength: 3 ; maxLength: 64
`product_id`	`string (uuid)`	yes

Used by : policiesCreate

`PolicyDetailOut`

Version complete : definition, parametres, blocages, simulations.

Type : object

Property	Type	Required	Constraints
`approved_at`	`string (date-time) \| null`	yes
`approved_by`	`string (uuid) \| null`	yes
`archived_at`	`string (date-time) \| null`	yes
`archived_reason`	`string \| null`	yes
`authors`	`array<string (uuid)>`	yes
`blockers`	`array<string>`	yes
`code`	`string`	yes
`created_at`	`string (date-time)`	yes
`definition`	`object`	yes
`derived_from_policy_id`	`string (uuid) \| null`	yes
`effective_from`	`string (date-time) \| null`	yes
`fingerprint`	`string`	yes
`grid_amplitude`	`array<any>`	yes	minItems: 2 ; maxItems: 2
`id`	`string (uuid)`	yes
`last_simulated_at`	`string (date-time) \| null`	yes
`origin`	`"reference_grid" \| "institution"`	yes
`parameters`	`array<ParameterOut>`	yes
`product_id`	`string (uuid)`	yes
`row_version`	`integer`	yes
`scale`	`array<any>`	yes	minItems: 2 ; maxItems: 2
`simulation_count`	`integer`	yes
`simulations`	`array<SimulationOut>`	yes
`status`	`PolicyStatus`	yes
`submitted_at`	`string (date-time) \| null`	yes
`submitted_by`	`string (uuid) \| null`	yes
`title`	`string \| null`	yes
`updated_at`	`string (date-time)`	yes
`version`	`integer`	yes
`warnings`	`array<string>`	yes

Used by : policiesCreate, policiesDerive, policiesGet, policiesSetParameters

`PolicyOut`

Version de politique, sans sa definition.

Type : object

Property	Type	Required
`approved_at`	`string (date-time) \| null`	yes
`approved_by`	`string (uuid) \| null`	yes
`archived_at`	`string (date-time) \| null`	yes
`archived_reason`	`string \| null`	yes
`authors`	`array<string (uuid)>`	yes
`code`	`string`	yes
`created_at`	`string (date-time)`	yes
`derived_from_policy_id`	`string (uuid) \| null`	yes
`effective_from`	`string (date-time) \| null`	yes
`fingerprint`	`string`	yes
`id`	`string (uuid)`	yes
`last_simulated_at`	`string (date-time) \| null`	yes
`origin`	`"reference_grid" \| "institution"`	yes
`product_id`	`string (uuid)`	yes
`row_version`	`integer`	yes
`simulation_count`	`integer`	yes
`status`	`PolicyStatus`	yes
`submitted_at`	`string (date-time) \| null`	yes
`submitted_by`	`string (uuid) \| null`	yes
`title`	`string \| null`	yes
`updated_at`	`string (date-time)`	yes
`version`	`integer`	yes

Used by : policiesApprove, policiesArchive, policiesList, policiesReject, policiesSimulate, policiesSubmit

`PolicyRejectIn`

Rejet motive par un code.

Type : object

Property	Type	Required	Description	Constraints
`reason`	`RejectionReason`	yes
`row_version`	`integer`	yes		minimum: 1

Used by : policiesReject

`PolicyStatus`

Etats normatifs d'une version de politique.

Type : string

Allowed values : draft, simulation, validation, active, archived

Used by : policiesApprove, policiesArchive, policiesCreate, policiesDerive, policiesGet, policiesList, policiesReject, policiesSetParameters, policiesSimulate, policiesSubmit

`PolicySubmitIn`

Soumission, avec une date d'effet proposee (maintenant si absente).

Type : object

Property	Type	Required	Description	Constraints
`effective_from`	`string (date-time) \| null`	no
`row_version`	`integer`	yes		minimum: 1

Used by : policiesSubmit

`ReferenceGridOut`

Grille initiale des Specifications, proposee a la creation.

Type : object

Property	Type	Required
`category`	`CreditProductCategory`	yes
`code`	`string`	yes
`source`	`string`	yes
`title`	`string`	yes
`validation_status`	`string`	yes

Used by : 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

Allowed values : parameters_inadequate, simulation_insufficient, effective_date_inadequate, other

Used by : 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

Property	Type	Required
`conditions`	`array<ConditionOut> \| null`	yes
`explanation`	`OperationalExplanationOut \| null`	yes
`forced_reviews`	`array<string>`	yes
`outcome`	`"approve" \| "approve_with_conditions" \| "review" \| "decline" \| null`	yes
`refused_fields`	`array<string>`	yes
`score`	`integer \| null`	yes
`trace`	`object \| null`	yes

Used by : policiesSimulate

`SimulationIn`

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

Type : object

Property	Type	Required	Description	Constraints
`cases`	`array<map<string, string \| boolean \| null>> \| null`	no		minItems: 1 ; maxItems: 1000
`row_version`	`integer`	yes		minimum: 1

Used by : policiesSimulate

`SimulationOut`

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

Type : object

Property	Type	Required
`created_at`	`string (date-time)`	yes
`created_by`	`string (uuid)`	yes
`id`	`string (uuid)`	yes
`mode`	`"cases" \| "replay"`	yes
`policy_fingerprint`	`string`	yes
`policy_id`	`string (uuid)`	yes
`sample_size`	`integer`	yes
`summary`	`object`	yes

Used by : policiesCreate, policiesDerive, policiesGet, policiesSetParameters, policiesSimulate

`SimulationResultOut`

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

Type : object

Property	Type	Required
`cases`	`array<SimulatedCaseOut>`	yes
`policy`	`PolicyOut`	yes
`scales`	`array<CharacteristicScaleOut>`	yes
`simulation`	`SimulationOut`	yes

Used by : policiesSimulate