policies
Politiques de decision : versions, parametres, simulation, soumission, approbation, archivage.
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/policies
Versions de politique
Versions de l'institution, les plus recentes d'abord.
policiesList
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<PolicyOut> |
422 | Validation Error | application/json | HTTPValidationError |
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
Parameters
No parameters.
Request body
- Content type
application/json- Type
PolicyCreateIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
201 | Successful Response | application/json | PolicyDetailOut |
422 | Validation Error | application/json | HTTPValidationError |
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
Parameters
No parameters.
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<ReferenceGridOut> |
GET /api/v1/policies/{policy_id}
Une version
Version complete, parametres, blocages d'activation et simulations.
policiesGet
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
policy_id | path | string (uuid) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | PolicyDetailOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/policies/{policy_id}/approve
Approuver et activer
Authentification renforcee ; jamais par l'un des auteurs de la version.
policiesApprove
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
policy_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
RowVersionIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | PolicyOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/policies/{policy_id}/archive
Retirer une version
Retirer une version active est un acte d'approbateur renforce.
policiesArchive
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
policy_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
RowVersionIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | PolicyOut |
422 | Validation Error | application/json | HTTPValidationError |
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
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
policy_id | path | string (uuid) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
201 | Successful Response | application/json | PolicyDetailOut |
422 | Validation Error | application/json | HTTPValidationError |
PUT /api/v1/policies/{policy_id}/parameters
Fixer des parametres
Une version simulee retourne au brouillon : sa simulation ne vaut plus.
policiesSetParameters
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
policy_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
ParametersIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | PolicyDetailOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/policies/{policy_id}/reject
Rejeter une soumission
Retour au brouillon, avec un motif codifie.
policiesReject
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
policy_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
PolicyRejectIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | PolicyOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/policies/{policy_id}/simulations
Simuler une version
Jeu d'essai fourni, ou rejeu des dossiers deja evalues du produit.
policiesSimulate
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
policy_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
SimulationIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
201 | Successful Response | application/json | SimulationResultOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/policies/{policy_id}/submit
Soumettre a approbation
Version simulee et complete ; date d'effet jamais passee.
policiesSubmit
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
policy_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
PolicySubmitIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | PolicyOut |
422 | Validation Error | application/json | HTTPValidationError |