-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3e45a09
commit 8eeafcb
Showing
4 changed files
with
873 additions
and
2 deletions.
There are no files selected for viewing
281 changes: 281 additions & 0 deletions
281
INTERVENTION-DO-creerInterventionDO-consumer-swagger.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,281 @@ | ||
| { | ||
| "openapi": "3.0.2", | ||
| "servers": [ | ||
| { | ||
| "url": "https://partner.api.bouyguestelecom.fr/v1", | ||
| "description": "Racine d'url des API PARTENAIRE en PRODUCTION" | ||
| } | ||
| ], | ||
| "paths": { | ||
| "/interventions-do": { | ||
| "post": { | ||
| "tags": [ | ||
| "creerInterventionDO" | ||
| ], | ||
| "summary": "permet de mettre à jour le document dont l'id est fourni.", | ||
| "operationId": "creerInterventionDO", | ||
| "x-secured-access": "strict", | ||
| "security": [ | ||
| { | ||
| "creerInterventionDO_auth": [ | ||
| ] | ||
| } | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "trackerId", | ||
| "required": false, | ||
| "description": "Navigation Unique Identifier", | ||
| "in": "header", | ||
| "schema": { | ||
| "type": "string", | ||
| "maxLength": 36 | ||
| } | ||
| }, | ||
| { | ||
| "name": "x-request-id", | ||
| "required": false, | ||
| "description": "Request Identifier", | ||
| "in": "header", | ||
| "schema": { | ||
| "type": "string", | ||
| "maxLength": 36 | ||
| } | ||
| }, | ||
| { | ||
| "name": "x-source", | ||
| "required": false, | ||
| "description": "Consumer application name", | ||
| "in": "header", | ||
| "schema": { | ||
| "type": "string", | ||
| "maxLength": 64 | ||
| } | ||
| } | ||
| ], | ||
| "requestBody": { | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/CreerInterventionDO" | ||
| } | ||
| } | ||
| }, | ||
| "description": "Objet intervention à déclarer chez l'OI", | ||
| "required": true | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/CreerInterventionDOOut" | ||
| } | ||
| } | ||
| }, | ||
| "description": "Operation Successful" | ||
| } | ||
| }, | ||
| "x-security-in": "IDENTITE_ET_GESTION", | ||
| "x-security-out": "IDENTITE_ET_GESTION" | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "securitySchemes": { | ||
| "creerInterventionDO_auth": { | ||
| "type": "oauth2", | ||
| "flows": { | ||
| "implicit": { | ||
| "authorizationUrl": "https://oauth2.bouyguestelecom.fr/authorize", | ||
| "scopes": { | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "schemas": { | ||
| "CreerInterventionDO": { | ||
| "description": "", | ||
| "type": "object", | ||
| "required": [ | ||
| "codeDO", | ||
| "codeOI", | ||
| "dateDebutIntevention", | ||
| "message", | ||
| "nature", | ||
| "pointMutualisation", | ||
| "refIntervDO" | ||
| ], | ||
| "properties": { | ||
| "codeDO": { | ||
| "description": "Code opérateur Interop du donneur d'ordre", | ||
| "maxLength": 4, | ||
| "type": "string" | ||
| }, | ||
| "codeOI": { | ||
| "description": "Code opérateur Interop de l'opérateur d'infrastructure", | ||
| "maxLength": 4, | ||
| "type": "string" | ||
| }, | ||
| "dateDebutIntevention": { | ||
| "description": "debut intervention", | ||
| "type": "string", | ||
| "format": "date-time" | ||
| }, | ||
| "dateFinIntervention": { | ||
| "description": "Valeur NULL si M1 Date/heure de fin réel d'intervention si M3 (format selon la norme ISO 8601)", | ||
| "type": "string", | ||
| "format": "date-time" | ||
| }, | ||
| "elementReseau": { | ||
| "description": "", | ||
| "type": "string", | ||
| "enum": [ | ||
| "PBO", | ||
| "PM", | ||
| "PTO" | ||
| ] | ||
| }, | ||
| "message": { | ||
| "description": "", | ||
| "type": "string" | ||
| }, | ||
| "messageDO": { | ||
| "description": "", | ||
| "type": "string" | ||
| }, | ||
| "nature": { | ||
| "description": "Nature finale de l'intervention, valeurs possibles : 1 = RACC PTO à construire 2 = RACC PTO existante 3 = RACC hotline 4 = SAV OC 5 = SAV OI 6 = NON FOURNIE (valeur possible permettant de rendre facultatif la fourniture de l'information)", | ||
| "type": "string", | ||
| "enum": [ | ||
| "AUTRES_TRAVAUX_PROGRAMMES", | ||
| "MAINTENANCE_OI", | ||
| "NON_FOURNIE", | ||
| "OPERATION_DE_MAINTENANCE_OC", | ||
| "RACC", | ||
| "RACC_OU_ SAV", | ||
| "REC_PM_OC", | ||
| "REPRISE_DE_MALFACON _OC", | ||
| "REPRISE_DE_MALFACON _OI", | ||
| "REPRISE_DE_MALFACONS", | ||
| "SAV" | ||
| ] | ||
| }, | ||
| "pointMutualisation": { | ||
| "$ref": "#/components/schemas/PointMutualisation" | ||
| }, | ||
| "refIntervDO": { | ||
| "description": "Référence d'intervention unique produite par le donneur d'ordre et identique sur M1 et M3", | ||
| "maxLength": 50, | ||
| "type": "string" | ||
| }, | ||
| "refPBO": { | ||
| "description": "Référence PBO (Ex: PTXXXXXXX) si disponible", | ||
| "maxLength": 100, | ||
| "type": "string" | ||
| }, | ||
| "refPTO": { | ||
| "description": "Référence PTO (Ex: FI-YYYY-YYYY) si disponible Réference prise (protocole interop)", | ||
| "maxLength": 50, | ||
| "type": "string" | ||
| }, | ||
| "referencePrestationPrise": { | ||
| "description": "", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "CreerInterventionDOOut": { | ||
| "description": "", | ||
| "type": "object", | ||
| "required": [ | ||
| "code", | ||
| "libelle" | ||
| ], | ||
| "properties": { | ||
| "code": { | ||
| "description": "0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU", | ||
| "type": "integer", | ||
| "format": "int32" | ||
| }, | ||
| "description": { | ||
| "description": "Description de l'erreur", | ||
| "maxLength": 100, | ||
| "type": "string" | ||
| }, | ||
| "libelle": { | ||
| "description": "", | ||
| "type": "string", | ||
| "enum": [ | ||
| "CHAMPS_NON_RENSEIGNE", | ||
| "CODE_OI_INCONNU", | ||
| "MAUVAIS_FORMAT", | ||
| "OK", | ||
| "PM_INCONNU" | ||
| ] | ||
| }, | ||
| "refIntervDO": { | ||
| "description": "", | ||
| "type": "string" | ||
| }, | ||
| "refIntervOI": { | ||
| "description": "Conditionnel: si Libelle_Reponse = OK Référence d'intervention unique produite par l'opérateur d'infrastructure", | ||
| "maxLength": 50, | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "PointMutualisation": { | ||
| "description": "", | ||
| "type": "object", | ||
| "required": [ | ||
| "refPM" | ||
| ], | ||
| "properties": { | ||
| "pointMutualisationTechnique": { | ||
| "$ref": "#/components/schemas/PointMutualisationTechnique" | ||
| }, | ||
| "refPM": { | ||
| "description": "Référence réglementaire du PM (ex: FI-XXXXX-XXXX)", | ||
| "maxLength": 50, | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "PointMutualisationTechnique": { | ||
| "description": "", | ||
| "type": "object", | ||
| "required": [ | ||
| "refPMTechnique" | ||
| ], | ||
| "properties": { | ||
| "refPMTechnique": { | ||
| "description": "C'est la référence du PMTechnique dans le cas d'un regroupement de plusieurs PM Techniques rattachés à un PM. Ce champ permet à l'Oc d'identifier le PM Technique à raccorder (boitier, armoire...) au PBO.", | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "info": { | ||
| "x-objetmetier": "INTERVENTION-DO", | ||
| "x-sf": "", | ||
| "x-st": "MSF", | ||
| "x-type": "partenaire", | ||
| "x-execution": "api", | ||
| "x-role": "consumer", | ||
| "title": "INTERVENTION-DO-creerInterventionDO", | ||
| "version": "1.0.239", | ||
| "description": "", | ||
| "contact": { | ||
| "name": "MOE MSF" | ||
| } | ||
| }, | ||
| "tags": [ | ||
| { | ||
| "name": "creerInterventionDO", | ||
| "description": "permet de mettre à jour le document dont l'id est fourni." | ||
| } | ||
| ] | ||
| } |
Oops, something went wrong.