Aller au contenu principal
NEXCLARADocumentation

policies

Politiques de decision : versions, parametres, simulation, soumission, approbation, archivage.

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/policies

Versions de politique

Versions de l'institution, les plus recentes d'abord.

policiesList

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<PolicyOut>
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/policies

Creer un brouillon depuis une grille initiale

Brouillon aux parametres vides : il ne peut pas s'activer en l'etat.

policiesCreate

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
PolicyCreateIn
Requis
oui

Réponses

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

GET /api/v1/policies/reference-grids

Grilles initiales des Specifications (partie C)

Grilles proposees a la creation d'une politique, avec leur statut de validation.

policiesReferenceGrids

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonarray<ReferenceGridOut>

GET /api/v1/policies/{policy_id}

Une version

Version complete, parametres, blocages d'activation et simulations.

policiesGet

Paramètres

ParamètreEmplacementTypeRequisContraintes
policy_idpathstring (uuid)oui

Corps de la requête

Aucun corps de requête.

Réponses

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

POST /api/v1/policies/{policy_id}/approve

Approuver et activer

Authentification renforcee ; jamais par l'un des auteurs de la version.

policiesApprove

Paramètres

ParamètreEmplacementTypeRequisContraintes
policy_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
RowVersionIn
Requis
oui

Réponses

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

POST /api/v1/policies/{policy_id}/archive

Retirer une version

Retirer une version active est un acte d'approbateur renforce.

policiesArchive

Paramètres

ParamètreEmplacementTypeRequisContraintes
policy_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
RowVersionIn
Requis
oui

Réponses

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

POST /api/v1/policies/{policy_id}/derive

Nouvelle version a partir d'une version existante

Corriger ou revenir en arriere : toujours une nouvelle version.

policiesDerive

Paramètres

ParamètreEmplacementTypeRequisContraintes
policy_idpathstring (uuid)oui

Corps de la requête

Aucun corps de requête.

Réponses

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

PUT /api/v1/policies/{policy_id}/parameters

Fixer des parametres

Une version simulee retourne au brouillon : sa simulation ne vaut plus.

policiesSetParameters

Paramètres

ParamètreEmplacementTypeRequisContraintes
policy_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
ParametersIn
Requis
oui

Réponses

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

POST /api/v1/policies/{policy_id}/reject

Rejeter une soumission

Retour au brouillon, avec un motif codifie.

policiesReject

Paramètres

ParamètreEmplacementTypeRequisContraintes
policy_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
PolicyRejectIn
Requis
oui

Réponses

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

POST /api/v1/policies/{policy_id}/simulations

Simuler une version

Jeu d'essai fourni, ou rejeu des dossiers deja evalues du produit.

policiesSimulate

Paramètres

ParamètreEmplacementTypeRequisContraintes
policy_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
SimulationIn
Requis
oui

Réponses

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

POST /api/v1/policies/{policy_id}/submit

Soumettre a approbation

Version simulee et complete ; date d'effet jamais passee.

policiesSubmit

Paramètres

ParamètreEmplacementTypeRequisContraintes
policy_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
PolicySubmitIn
Requis
oui

Réponses

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