diff --git a/E-Intervention-DO-v2.0.0.OAS3.yaml b/E-Intervention-DO-v2.0.0.OAS3.yaml index 6cdd6dd..0b52a5f 100644 --- a/E-Intervention-DO-v2.0.0.OAS3.yaml +++ b/E-Intervention-DO-v2.0.0.OAS3.yaml @@ -9,33 +9,12 @@ paths: post: tags: - creerInterventionDO - summary: '' + summary: 'Flux M1: Message transmis par le DO à l’OI pour notifier le début d’intervention.' 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 + parameters: [] requestBody: content: application/json: @@ -50,36 +29,19 @@ paths: schema: $ref: '#/components/schemas/CreerInterventionDOOut' description: Operation Successful - x-security-in: IDENTITE_ET_GESTION - x-security-out: IDENTITE_ET_GESTION + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' put: tags: - modifierInterventionDO - summary: '' + summary: 'Flux M3: Le message M3 déclare la fin d’intervention du DO' operationId: modifierInterventionDO x-secured-access: none - 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 + parameters: [] requestBody: content: application/json: @@ -94,39 +56,24 @@ paths: schema: $ref: '#/components/schemas/ModifierInterventionDOOut' description: Operation Successful + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-security-in: IDENTITE_ET_GESTION x-security-out: IDENTITE_ET_GESTION /interventions-do/compte-rendu: post: tags: - compteRenduInterventionDO - summary: '' + summary: 'Flux M3 optionel: Compte rendu de fin d''intervention DO' operationId: compteRenduInterventionDO x-secured-access: strict security: - compteRenduInterventionDO_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 + parameters: [] requestBody: content: application/json: @@ -141,39 +88,24 @@ paths: schema: $ref: '#/components/schemas/CompteRenduInterventionDOOut' description: Operation Successful + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-security-in: IDENTITE_ET_GESTION x-security-out: IDENTITE_ET_GESTION /interventions-do/test-intermediaire: post: tags: - - demanderTestIntermediareInterventionDO - summary: '' - operationId: demanderTestIntermediareInterventionDO + - demanderTestIntermediaireInterventionDO + summary: 'Flux M3TX: demande de test intermediaire' + operationId: demanderTestIntermediaireInterventionDO x-secured-access: strict security: - - demanderTestIntermediareInterventionDO_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 + - demanderTestIntermediaireInterventionDO_auth: [] + parameters: [] requestBody: content: application/json: @@ -188,24 +120,33 @@ paths: schema: $ref: '#/components/schemas/DemanderTestIntermediaireInterventionDOOut' description: Operation Successful + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-security-in: IDENTITE_ET_GESTION x-security-out: IDENTITE_ET_GESTION components: securitySchemes: compteRenduInterventionDO_auth: type: oauth2 + x-habilitations: [] flows: implicit: authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize scopes: {} creerInterventionDO_auth: type: oauth2 + x-habilitations: [] flows: implicit: authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize scopes: {} - demanderTestIntermediareInterventionDO_auth: + demanderTestIntermediaireInterventionDO_auth: type: oauth2 + x-habilitations: [] flows: implicit: authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize @@ -228,7 +169,7 @@ components: description: Code opérateur Interop de l'opérateur d'infrastructure maxLength: 4 type: string - lignesImpactes: + lignesImpactees: description: '' type: array items: @@ -253,7 +194,7 @@ components: type: object required: - code - - libelle + - refInterventionDO properties: code: description: 0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU @@ -263,15 +204,6 @@ components: description: Description de l'erreur maxLength: 100 type: string - libelle: - description: '' - type: string - enum: - - CHAMPS_NON_RENSEIGNE - - CODE_OI_INCONNU - - MAUVAIS_FORMAT - - OK - - REF_INTERV_INCONNUE refIntervOI: description: 'Conditionnel: si Libelle_Reponse = OK Référence d''intervention unique produite par l''opérateur d''infrastructure' maxLength: 50 @@ -321,17 +253,17 @@ components: 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 + - '1' + - '2' + - '20' + - '21' + - '22' + - '4' + - '41' + - '5' + - '6' + - '60' + - '61' pointMutualisation: $ref: '#/components/schemas/PointMutualisation' refIntervDO: @@ -354,7 +286,7 @@ components: type: object required: - code - - libelle + - refIntervDO properties: code: description: 0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU @@ -364,15 +296,6 @@ components: 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 @@ -419,7 +342,8 @@ components: type: string numeroTest: description: '' - type: string + type: integer + format: int32 refIntervDO: description: Référence d'intervention unique produite par le donneur d'ordre et identique sur M1 et M3 maxLength: 50 @@ -432,7 +356,6 @@ components: type: object required: - code - - libelle - numeroTest - refInterventionDO properties: @@ -444,21 +367,10 @@ components: description: Description de l'erreur maxLength: 100 type: string - libelle: - description: '' - type: string - enum: - - CHAMPS_NON_RENSEIGNE - - CODE_OI_INCONNU - - INCOHERENCE - - MAUVAIS_FORMAT - - OK - - REF_INTERV_INCONNUE - - TEST_PRECEDENT_DEJA_EMIS - - TEST_PRECEDENT_NON_ACQUITTE numeroTest: description: '' - type: string + type: integer + format: int32 refIntervOI: description: 'Conditionnel: si Libelle_Reponse = OK Référence d''intervention unique produite par l''opérateur d''infrastructure' maxLength: 50 @@ -530,6 +442,7 @@ components: - nature - pointMutualisation - refIntervDO + - testFinFroid properties: codeDO: description: Code opérateur Interop du donneur d'ordre @@ -561,19 +474,19 @@ components: 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 + - '1' + - '2' + - '20' + - '21' + - '22' + - '4' + - '41' + - '5' + - '6' + - '60' + - '61' pointMutualisation: - $ref: '#/components/schemas/PointMutualisation1' + $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 @@ -589,12 +502,15 @@ components: referencePrestationPrise: description: '' type: string + testFinFroid: + description: '' + type: string ModifierInterventionDOOut: description: '' type: object required: - code - - libelle + - refInterventionDO properties: code: description: 0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU @@ -604,16 +520,6 @@ components: description: Description de l'erreur maxLength: 100 type: string - libelle: - description: '' - type: string - enum: - - CHAMPS_NON_RENSEIGNE - - CODE_OI_INCONNU - - M3TX_NON_DEMANDE - - MAUVAIS_FORMAT - - OK - - PM_INCONNU refIntervOI: description: 'Conditionnel: si Libelle_Reponse = OK Référence d''intervention unique produite par l''opérateur d''infrastructure' maxLength: 50 @@ -626,64 +532,68 @@ components: type: object required: - refPM + - refPMTechnique properties: - pointMutualisationTechnique: - $ref: '#/components/schemas/PointMutualisationTechnique' - refPM: - description: 'Référence réglementaire du PM (ex: FI-XXXXX-XXXX)' - maxLength: 50 - type: string - PointMutualisation1: - description: '' - type: object - required: - - refPM - properties: - pointMutualisationTechnique: - $ref: '#/components/schemas/PointMutualisationTechnique1' 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 - PointMutualisationTechnique1: - description: '' + ErrorResponse: + description: Description d'une erreur fonctionnelle type: object required: - - refPMTechnique + - error 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. + error: + description: Le code erreur permet de discriminer les différentes erreurs type: string + enum: + - CHAMPS_NON_RENSEIGNE + - CODE_OI_INCONNU + - MAUVAIS_FORMAT + - PM_INCONNU + - REF_INTERV_INCONNUE + - INCOHERENCE + - TEST_PRECEDENT_DEJA_EMIS + - TEST_PRECEDENT_NON_ACQUITTE + - M3TX_NON_DEMANDE + error_description: + description: Description de l'erreur, si possible fixe pour un même code erreur + type: string + maxLength: 256 + error_uri: + description: L'URI de description de l'erreur + type: string + error_parameters: + description: Les paramètres de l'erreur + type: array + items: + type: string + maxLength: 64 info: x-objetmetier: INTERVENTION-DO x-sf: '' x-st: MSF x-type: partenaire x-execution: api - x-role: consumer + x-role: provider title: INTERVENTION-DO - version: 1.0.269 - description: "Spécification des ressources qui devront être exposées par les différents acteurs impliqués par le protocole E-Intervention." + version: 1.0.287 + description: '' contact: name: MOE MSF tags: - name: creerInterventionDO - description: '' + description: 'Flux M1: Message transmis par le DO à l’OI pour notifier le début d’intervention.' - name: compteRenduInterventionDO - description: '' - - name: demanderTestIntermediareInterventionDO - description: '' + description: 'Flux M3 optionel: Compte rendu de fin d''intervention DO' + - name: demanderTestIntermediaireInterventionDO + description: 'Flux M3TX: demande de test intermediaire' - name: modifierInterventionDO - description: '' + description: 'Flux M3: Le message M3 déclare la fin d’intervention du DO' externalDocs: description: "Groupe Interop'Fibre" url: "https://www.interop-fibre.fr/" \ No newline at end of file diff --git a/E-Intervention-OI-v2.0.0.OAS3.yaml b/E-Intervention-OI-v2.0.0.OAS3.yaml index 9d6dd53..edfd442 100644 --- a/E-Intervention-OI-v2.0.0.OAS3.yaml +++ b/E-Intervention-OI-v2.0.0.OAS3.yaml @@ -9,33 +9,12 @@ paths: post: tags: - creerInterventionOI - summary: '' + summary: "Flux M2: Début d’intervention DO transmis par l’OI aux autres OCs presents au PM." operationId: creerInterventionOI x-secured-access: strict security: - creerInterventionOI_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 + parameters: [] requestBody: content: application/json: @@ -50,38 +29,23 @@ paths: schema: $ref: '#/components/schemas/CreerInterventionOIOut' description: Operation Successful + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-security-in: IDENTITE_ET_GESTION x-security-out: IDENTITE_ET_GESTION put: tags: - modifierInterventionOI - summary: '' - operationId: modifierCreationInterventionOI + summary: "Flux M4: la fin de l'intervention notifier par l'OI" + operationId: modifierInterventionOI x-secured-access: strict security: - modifierInterventionOI_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 + parameters: [] requestBody: content: application/json: @@ -96,39 +60,24 @@ paths: schema: $ref: '#/components/schemas/ModifierInterventionOIOut' description: Operation Successful + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-security-in: IDENTITE_ET_GESTION x-security-out: IDENTITE_ET_GESTION /interventions-oi/compte-rendu: - put: + post: tags: - - modifierInterventionOI - summary: '' - operationId: modifierInterventionOI + - compteRenduInterventionOI + summary: "Flux M3 optionnel: compte rendu de fin d'intervention relié par l'OI" + operationId: compteRenduInterventionOI x-secured-access: strict security: - - modifierInterventionOI_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 + - compteRenduInterventionOI_auth: [] + parameters: [] requestBody: content: application/json: @@ -143,39 +92,24 @@ paths: schema: $ref: '#/components/schemas/CompteRenduInterventionOIOut' description: Operation Successful + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-security-in: IDENTITE_ET_GESTION x-security-out: IDENTITE_ET_GESTION /interventions-oi/notification-impacte-clients-oc: post: tags: - notifierImpacteClientsOC - summary: '' + summary: "Flux M5TX: Impacts clients identifiés par l’OC" operationId: notifierImpacteClientsOC x-secured-access: strict security: - notifierImpacteClientsOC_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 + parameters: [] requestBody: content: application/json: @@ -190,39 +124,24 @@ paths: schema: $ref: '#/components/schemas/ClientImpacteParInterventionOut' description: Operation Successful + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-security-in: IDENTITE_ET_GESTION x-security-out: IDENTITE_ET_GESTION /interventions-oi/notification-impacte-clients-oi-do: post: tags: - notifierImpacteClientsOIDO - summary: '' + summary: "Flux M6TX: Impacts clients relayés par l’OI au DO" operationId: notifierImpacteClientsOIDO x-secured-access: strict security: - notifierImpacteClientsOIDO_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 + parameters: [] requestBody: content: application/json: @@ -237,39 +156,24 @@ paths: schema: $ref: '#/components/schemas/NotifierImpacteClientsOIDOOut' description: Operation Successful + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-security-in: IDENTITE_ET_GESTION x-security-out: IDENTITE_ET_GESTION /interventions-oi/test-intermediaire: post: tags: - - demanderTestIntermediareInterventionOI - summary: '' - operationId: demanderTestIntermediareInterventionOI + - demanderTestIntermediaireInterventionOI + summary: "Flux M4TX: Demande de test DO relayée par l’OI" + operationId: demanderTestIntermediaireInterventionOI x-secured-access: strict security: - - demanderTestIntermediareInterventionOI_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 + - demanderTestIntermediaireInterventionOI_auth: [] + parameters: [] requestBody: content: application/json: @@ -284,103 +188,179 @@ paths: schema: $ref: '#/components/schemas/DemanderTestIntermediaireInterventionOIOut' description: Operation Successful + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-security-in: IDENTITE_ET_GESTION x-security-out: IDENTITE_ET_GESTION components: securitySchemes: + compteRenduInterventionOI_auth: + type: oauth2 + x-habilitations: [] + flows: + implicit: + authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize + scopes: {} creerInterventionOI_auth: type: oauth2 + x-habilitations: [] flows: implicit: authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize scopes: {} - demanderTestIntermediareInterventionOI_auth: + demanderTestIntermediaireInterventionOI_auth: type: oauth2 + x-habilitations: [] flows: implicit: authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize scopes: {} modifierInterventionOI_auth: type: oauth2 + x-habilitations: [] flows: implicit: authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize scopes: {} notifierImpacteClientsOC_auth: type: oauth2 + x-habilitations: [] flows: implicit: authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize scopes: {} notifierImpacteClientsOIDO_auth: type: oauth2 + x-habilitations: [] flows: implicit: authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize scopes: {} schemas: ClientHSOC: - description: 'Conditionnel : au moins 1 client KO Liste des routes optiques de chaque client HS au PM dont l''heure de coupure est comprise dans l''intervalle' + description: "Conditionnel : au moins 1 client KO Liste des routes optiques de chaque client HS au PM dont l'heure de coupure est comprise dans l'intervalle" type: object required: - dateChangementEtat + - fibre + - nomModulePM + - positionCoupleurOC - positionModulePM + - refPBO - refPTO + - tube properties: couleurJarretiere: - description: '' + description: "" type: string dateChangementEtat: description: Date/heure de début de coupure pour le client (format selon la norme ISO 8601) type: string format: date-time fibre: - description: '' + description: "" maxLength: 50 type: string nomModulePM: - description: '' + description: "" type: string numeroSerieONT: - description: '' + description: "" type: string positionCoupleurOC: - description: '' + description: "" type: string positionModulePM: - description: '' + description: "" maxLength: 100 type: string refPBO: - description: '' + description: "" maxLength: 100 type: string refPTO: - description: '' + description: "" maxLength: 50 type: string referencePrestationPrise: - description: '' + description: "" + type: string + tube: + description: "" + maxLength: 50 + type: string + ClientHSOC1: + description: "Conditionnel : au moins 1 client KO Liste des routes optiques de chaque client HS au PM dont l'heure de coupure est comprise dans l'intervalle" + type: object + required: + - dateChangementEtat + - fibre + - nomModulePM + - positionCoupleurOC + - positionModulePM + - refPBO + - refPTO + - tube + properties: + couleurJarretiere: + description: "" + type: string + dateChangementEtat: + description: "" + type: string + format: date-time + fibre: + description: "" + maxLength: 50 + type: string + nomModulePM: + description: "" + type: string + numeroSerieONT: + description: "" + type: string + positionCoupleurOC: + description: "" + type: string + positionModulePM: + description: "" + maxLength: 100 + type: string + refPBO: + description: "" + maxLength: 100 + type: string + refPTO: + description: "" + maxLength: 50 + type: string + referencePrestationPrise: + description: "" type: string reserveReparationOI: - description: '' + description: "" type: boolean tube: - description: '' + description: "" maxLength: 50 type: string ClientImpacteOCParIntervention: - description: '' + description: "" type: object required: + - clientHSOC - codeOcImpacte - - iterationTest + - ligneClientRetablie - message - referenceIntervOI - testCloture properties: clientHSOC: - description: '' + description: "" type: array items: $ref: '#/components/schemas/ClientHSOC' @@ -388,39 +368,35 @@ components: description: Code opérateur Interop de celui ayant des clients impactés maxLength: 4 type: string - demandeReparation: - description: '' + demandeReapartion: + description: "" type: array items: $ref: '#/components/schemas/DemandeReparation' - iterationTest: - description: '' - type: integer - format: int32 ligneClientRetablie: - description: '' + description: "" type: array items: $ref: '#/components/schemas/LigneClientRetablie' message: - description: '' + description: "" type: string numeroTest: - description: '' - type: string + description: "" + type: integer + format: int32 referenceIntervOI: description: Référence d’intervention unique produite par l'OI maxLength: 50 type: string testCloture: - description: '' + description: "" type: string ClientImpacteParInterventionOut: - description: '' + description: "" type: object required: - code - - libelle - numeroTest - referenceIntervOI properties: @@ -432,23 +408,15 @@ components: description: Description de l'erreur maxLength: 100 type: string - libelle: - description: '' - type: string - enum: - - CHAMPS_NON_RENSEIGNE - - ERREUR_ITERATION - - MAUVAIS_FORMAT - - OK - - REF_INTERV_OI_INCONNUE numeroTest: - description: '' - type: string + description: "" + type: integer + format: int32 referenceIntervOI: - description: '' + description: "" type: string CompteRenduInterventionOI: - description: '' + description: "" type: object required: - codeOI @@ -459,29 +427,28 @@ components: description: Code opérateur Interop de l'opérateur d'infrastructure maxLength: 4 type: string - lignesImpactes: - description: '' + lignesImpactees: + description: "" type: array items: $ref: '#/components/schemas/LigneImpacte' lignesRetablies: - description: '' + description: "" type: array items: $ref: '#/components/schemas/LigneRetablie' message: - description: '' + description: "" type: string refIntervOI: description: Référence d’intervention unique produite par l’OI dans R M1/R M3 maxLength: 50 type: string CompteRenduInterventionOIOut: - description: '' + description: "" type: object required: - code - - libelle - refInterventionOI properties: code: @@ -492,28 +459,18 @@ components: description: Description de l'erreur maxLength: 100 type: string - libelle: - description: '' - type: string - enum: - - CHAMPS_NON_RENSEIGNE - - CODE_OI_INCONNU - - INCOHERENCE - - MAUVAIS_FORMAT - - OK - - PM_INCONNU refInterventionOI: - description: '' + description: "" type: string CreerInterventionOI: - description: '' + description: "" type: object required: - codeOI - dateDebutIntevention - - dateFinIntervention - message - refIntervOI + - refPBO properties: codeOI: description: Code opérateur Interop de l'opérateur d'infrastructure @@ -523,18 +480,14 @@ components: description: Date/heure de début réel d'intervention (format selon la norme ISO 8601) type: string format: date-time - dateFinIntervention: - description: Valeur NULL si M2 Date/heure de fin réel d'intervention si M4 (format selon la norme ISO 8601) - type: string - format: date-time description: - description: '' + description: "" type: string elementReseau: - description: '' + description: "" type: string message: - description: '' + description: "" type: string pointMutualisation: $ref: '#/components/schemas/PointMutualisation' @@ -542,13 +495,14 @@ components: description: Référence d’intervention unique produite par l’OI dans R M1/R M3 maxLength: 50 type: string + refPBO: + description: "" + type: string CreerInterventionOIOut: - description: '' + description: "" type: object required: - code - - libelle - - nombreTestOC - refInterventionOI properties: code: @@ -559,36 +513,24 @@ components: 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 - nombreTestOC: - description: '' - type: string refInterventionOI: - description: '' + description: "" type: string DemandeReparation: - description: '' + description: "" type: object required: - codeDO properties: codeDO: - description: '' + description: "" type: string reparation: - description: '' + description: "" default: false type: boolean DemanderTestIntermediaireInterventionOI: - description: '' + description: "" type: object required: - codeOI @@ -604,32 +546,32 @@ components: maxLength: 4 type: string dateTest: - description: '' + description: "" type: string format: date-time infosIntervention: - description: '' + description: "" type: array items: $ref: '#/components/schemas/InfoIntervention' message: - description: '' + description: "" type: string natureTest: - description: '' + description: "" type: string numeroTest: - description: '' - type: string + description: "" + type: integer + format: int32 refIntervOI: - description: '' + description: "" type: string DemanderTestIntermediaireInterventionOIOut: - description: '' + description: "" type: object required: - code - - libelle - numeroTest properties: code: @@ -640,124 +582,166 @@ components: description: Description de l'erreur maxLength: 100 type: string - libelle: - description: '' - type: string - enum: - - CHAMPS_NON_RENSEIGNE - - CODE_OI_INCONNU - - INCOHERENCE - - MAUVAIS_FORMAT - - OK - - REF_INTERVOI_INCONNUE - - TEST_NON_REALISE numeroTest: - description: '' - type: string + description: "" + type: integer + format: int32 refIntervOI: - description: 'Conditionnel: si Libelle_Reponse = OK Référence d''intervention unique produite par l''opérateur d''infrastructure' + description: "Conditionnel: si Libelle_Reponse = OK Référence d'intervention unique produite par l'opérateur d'infrastructure" maxLength: 50 type: string InfoIntervention: - description: '' + description: "" type: object properties: refPbo: - description: 'Référence PBO (Ex: PTXXXXXXX) si disponible' + description: "Référence PBO (Ex: PTXXXXXXX) si disponible" maxLength: 100 type: string LigneClientRetablie: - description: 'Conditionnel : au moins 1 client KO Liste des routes optiques de chaque client HS au PM dont l''heure de coupure est comprise dans l''intervalle' + description: "Conditionnel : au moins 1 client KO Liste des routes optiques de chaque client HS au PM dont l'heure de coupure est comprise dans l'intervalle" type: object required: - dateChangementEtat + - fibre + - nomModulePm - positionModulePM + - refPBO - refPTO + - tube properties: dateChangementEtat: description: Date/heure de début de coupure pour le client (format selon la norme ISO 8601) type: string format: date-time fibre: - description: '' + description: "" maxLength: 50 type: string nomModulePm: - description: '' + description: "" + type: string + numeroSerieONT: + description: "" + type: string + positionModulePM: + description: "" + maxLength: 100 + type: string + refPBO: + description: "" + maxLength: 100 + type: string + refPTO: + description: "" + maxLength: 50 + type: string + referencePrestationPrise: + description: "" + type: string + tube: + description: "" + maxLength: 50 + type: string + LigneClientRetablie1: + description: "Conditionnel : au moins 1 client KO Liste des routes optiques de chaque client HS au PM dont l'heure de coupure est comprise dans l'intervalle" + type: object + required: + - dateChangementEtat + - fibre + - nomModulePM + - positionModulePM + - refPBO + - refPTO + - referencePrestationPrise + - tube + properties: + dateChangementEtat: + description: "" + type: string + format: date-time + fibre: + description: "" + maxLength: 50 + type: string + nomModulePM: + description: "" type: string numeroSerieONT: - description: '' + description: "" type: string positionModulePM: - description: '' + description: "" maxLength: 100 type: string refPBO: - description: '' + description: "" maxLength: 100 type: string refPTO: - description: '' + description: "" maxLength: 50 type: string referencePrestationPrise: - description: '' + description: "" type: string tube: - description: '' + description: "" maxLength: 50 type: string LigneImpacte: - description: '' + description: "" type: object properties: refPTO: - description: '' + description: "" type: string referencePrestationPrise: - description: '' + description: "" type: string repaCodeOC: - description: '' + description: "" type: string repaOCDemandee: - description: '' + description: "" type: string retMessage: - description: '' + description: "" type: string retStatut: - description: '' + description: "" type: string retTypo: - description: '' + description: "" type: string serialNumberONT: - description: '' + description: "" type: string LigneRetablie: - description: '' + description: "" type: object properties: refPTO: - description: '' + description: "" type: array items: type: string referencePrestationPrise: - description: '' + description: "" type: string serialNumberONT: - description: '' + description: "" type: string ModifierInterventionOI: - description: '' + description: "" type: object required: - codeOI - dateDebutIntevention - message + - pointMutualisation - refIntervOI + - testFinFroid properties: codeOI: description: Code opérateur Interop de l'opérateur d'infrastructure @@ -772,26 +756,28 @@ components: type: string format: date-time description: - description: '' + description: "" type: string elementReseau: - description: '' + description: "" type: string message: - description: '' + description: "" type: string pointMutualisation: - $ref: '#/components/schemas/PointMutualisation1' + $ref: '#/components/schemas/PointMutualisation' refIntervOI: description: Référence d’intervention unique produite par l’OI dans R M1/R M3 maxLength: 50 type: string + testFinFroid: + description: "" + type: string ModifierInterventionOIOut: - description: '' + description: "" type: object required: - code - - libelle - refInterventionOI properties: code: @@ -802,24 +788,16 @@ components: description: Description de l'erreur maxLength: 100 type: string - libelle: - description: '' - type: string - enum: - - CHAMPS_NON_RENSEIGNE - - CODE_OI_INCONNU - - INCOHERENCE - - MAUVAIS_FORMAT - - OK - - PM_INCONNU refInterventionOI: - description: '' + description: "" type: string NotifierImpacteClientsOIDO: - description: '' + description: "" type: object required: + - clientHSOC - codeOCImpacte + - ligneClientRetablie - message - multiInterventionOI - nombreOC @@ -827,45 +805,45 @@ components: - reparation properties: clientHSOC: - description: '' + description: "" type: array items: - $ref: '#/components/schemas/ClientHSOC' + $ref: '#/components/schemas/ClientHSOC1' codeOCImpacte: description: Code opérateur Interop de celui ayant des clients impactés maxLength: 4 type: string ligneClientRetablie: - description: '' + description: "" type: array items: - $ref: '#/components/schemas/LigneClientRetablie' + $ref: '#/components/schemas/LigneClientRetablie1' message: - description: '' + description: "" type: string multiInterventionOI: - description: '' + description: "" type: boolean nombreOC: - description: '' + description: "" type: integer format: int32 numeroTest: - description: '' - type: string + description: "" + type: integer + format: int32 referenceIntervOI: description: Référence d’intervention unique produite par l'OI maxLength: 50 type: string reparation: - description: '' + description: "" type: boolean NotifierImpacteClientsOIDOOut: - description: '' + description: "" type: object required: - code - - libelle - numeroTest - referenceIntervOI properties: @@ -877,83 +855,87 @@ components: description: Description de l'erreur maxLength: 100 type: string - libelle: - description: '' - type: string - enum: - - CHAMPS_NON_RENSEIGNE - - MAUVAIS_FORMAT - - OK - - REF_INTERV_OI_INCONNUE numeroTest: - description: '' - type: string + description: "" + readOnly: true + type: integer + format: int32 referenceIntervOI: - description: '' + description: "" 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 - PointMutualisation1: - description: '' + description: "" type: object required: - refPM + - refPMTechnique properties: - pointMutualisationTechnique: - $ref: '#/components/schemas/PointMutualisationTechnique1' refPM: - description: 'Référence réglementaire du PM (ex: FI-XXXXX-XXXX)' + 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. + 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 - PointMutualisationTechnique1: - description: '' + ErrorResponse: + description: Description d'une erreur fonctionnelle type: object required: - - refPMTechnique + - error 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. + error: + description: Le code erreur permet de discriminer les différentes erreurs + type: string + enum: + - CHAMPS_NON_RENSEIGNE + - CODE_OI_INCONNU + - MAUVAIS_FORMAT + - PM_INCONNU + - REF_INTERV_OI_INCONNUE + - INCOHERENCE + - TEST_PRECEDENT_DEJA_EMIS + - TEST_PRECEDENT_NON_ACQUITTE + - M3TX_NON_DEMANDE + - DELAI_NON_RESPECTE + - ERREUR_ITERATION + error_description: + description: Description de l'erreur, si possible fixe pour un même code erreur + type: string + maxLength: 256 + error_uri: + description: L'URI de description de l'erreur type: string + error_parameters: + description: Les paramètres de l'erreur + type: array + items: + type: string + maxLength: 64 info: x-objetmetier: INTERVENTION-OI - x-sf: '' + x-sf: "" x-st: MSF x-type: partenaire x-execution: api - x-role: consumer + x-role: provider title: INTERVENTION-OI - version: 1.0.269 - description: "Spécification des ressources qui devront être exposées par les différents acteurs impliqués par le protocole E-Intervention." + version: 1.0.287 + description: "" + contact: + name: MOE MSF tags: - - name: demanderTestIntermediareInterventionOI - description: '' + - name: demanderTestIntermediaireInterventionOI + description: "Flux M4TX: Demande de test DO relayée par l’OI" - name: modifierInterventionOI - description: '' + description: "Flux M4: la fin de l'intervention notifier par l'OI" - name: creerInterventionOI - description: '' + description: "Flux M2 : Début d’intervention DO transmis par l’OI aux autres OCs presents au PM." + - name: compteRenduInterventionOI + description: "Flux M3 optionnel: compte rendu de fin d'intervention relié par l'OI" - name: notifierImpacteClientsOC - description: '' + description: "Flux M5TX: Impacts clients identifiés par l’OC" - name: notifierImpacteClientsOIDO - description: '' + description: "Flux M6TX: Impacts clients relayés par l’OI au DO" externalDocs: description: "Groupe Interop'Fibre" url: "https://www.interop-fibre.fr/" \ No newline at end of file