Aller au contenu principal
NEXCLARADocumentation

historical-simulation

Le contrat ne décrit pas cette famille.

Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.

GET /api/v1/historical-datasets

Jeux historiques

Jeux geles de l'institution, recents d'abord.

historicalDatasetsList

Paramètres

ParamètreEmplacementTypeRequisContraintes
product_idquerystring (uuid) | nullnon

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonarray<DatasetOut>
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/historical-datasets

Geler un jeu historique

Derniere evaluation de chaque dossier du produit, selon periode, population, exclusions.

historicalDatasetsFreeze

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
DatasetCreateIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
201Successful Responseapplication/jsonDatasetOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/historical-datasets/{dataset_id}

Un jeu historique

Criteres, comptes et empreinte d'un jeu gele.

historicalDatasetsGet

Paramètres

ParamètreEmplacementTypeRequisContraintes
dataset_idpathstring (uuid)oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonDatasetOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/historical-simulations

Simulations historiques

Simulations de l'institution, d'un jeu ou d'une politique (candidate ou reference).

historicalSimulationsList

Paramètres

ParamètreEmplacementTypeRequisContraintes
dataset_idquerystring (uuid) | nullnon
policy_idquerystring (uuid) | nullnon

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonarray<HistoricalSimulationOut>
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/historical-simulations

Lancer une simulation historique

Met en file le rejeu ; aucune politique ne change d'etat.

historicalSimulationsStart

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
HistoricalSimulationCreateIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
201Successful Responseapplication/jsonHistoricalSimulationOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/historical-simulations/{simulation_id}

Une simulation historique

Etat, jeu, comparaison (une fois terminee) et sceau.

historicalSimulationsGet

Paramètres

ParamètreEmplacementTypeRequisContraintes
simulation_idpathstring (uuid)oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonHistoricalSimulationDetailOut
422Validation Errorapplication/jsonHTTPValidationError

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

Paramètres

ParamètreEmplacementTypeRequisContraintes
simulation_idpathstring (uuid)oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonHistoricalReconstitutionOut
422Validation Errorapplication/jsonHTTPValidationError

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

Paramètres

ParamètreEmplacementTypeRequisContraintes
simulation_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
SealRequestIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonHistoricalSimulationDetailOut
422Validation Errorapplication/jsonHTTPValidationError