historical-simulation
The contract does not describe this family.
Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.
GET /api/v1/historical-datasets
Jeux historiques
Jeux geles de l'institution, recents d'abord.
historicalDatasetsList
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
product_id | query | string (uuid) | null | no |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<DatasetOut> |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/historical-datasets
Geler un jeu historique
Derniere evaluation de chaque dossier du produit, selon periode, population, exclusions.
historicalDatasetsFreeze
Parameters
No parameters.
Request body
- Content type
application/json- Type
DatasetCreateIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
201 | Successful Response | application/json | DatasetOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/historical-datasets/{dataset_id}
Un jeu historique
Criteres, comptes et empreinte d'un jeu gele.
historicalDatasetsGet
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
dataset_id | path | string (uuid) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | DatasetOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/historical-simulations
Simulations historiques
Simulations de l'institution, d'un jeu ou d'une politique (candidate ou reference).
historicalSimulationsList
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
dataset_id | query | string (uuid) | null | no | |
policy_id | query | string (uuid) | null | no |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<HistoricalSimulationOut> |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/historical-simulations
Lancer une simulation historique
Met en file le rejeu ; aucune politique ne change d'etat.
historicalSimulationsStart
Parameters
No parameters.
Request body
- Content type
application/json- Type
HistoricalSimulationCreateIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
201 | Successful Response | application/json | HistoricalSimulationOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/historical-simulations/{simulation_id}
Une simulation historique
Etat, jeu, comparaison (une fois terminee) et sceau.
historicalSimulationsGet
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
simulation_id | path | string (uuid) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | HistoricalSimulationDetailOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/historical-simulations/{simulation_id}/reconstitution
Reconstituer une simulation
Refait le rejeu sous la version du moteur enregistree et compare chaque piece.
historicalSimulationsReconstitute
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
simulation_id | path | string (uuid) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | HistoricalReconstitutionOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/historical-simulations/{simulation_id}/seal
Sceller les preuves d'une simulation
Empreinte horodatee du jeu, des versions, du moteur et des resultats.
historicalSimulationsSeal
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
simulation_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
SealRequestIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | HistoricalSimulationDetailOut |
422 | Validation Error | application/json | HTTPValidationError |