openapi: 3.2.0 info: title: Mef events subscription API version: '1.0' description: 'Operations tagged events subscription across 38 of this provider''s published API definitions: mef-lso-allegro-alarm-management-openapi.yml, mef-lso-allegro-fault-management-openapi.yml, mef-lso-allegro-performance-monitoring-openapi.yml, mef-lso-allegro-service-function-test-openapi.yml, mef-lso-allegro-service-inventory-management-openapi.yml, mef-lso-allegro-service-ordering-management-openapi.yml, mef-lso-cantata-appointment-management-openapi.yml, mef-lso-cantata-billing-management-openapi.yml, mef-lso-cantata-circuit-impairment-and-maintenance-openapi.yml, mef-lso-cantata-geographic-address-management-openapi.yml, mef-lso-cantata-product-catalog-openapi.yml, mef-lso-cantata-product-offering-qualification-management-openapi.yml, mef-lso-cantata-product-order-management-openapi.yml, mef-lso-cantata-quote-management-openapi.yml, mef-lso-cantata-trouble-ticket-management-openapi.yml, mef-lso-cantata-workorder-management-openapi.yml, mef-lso-interlude-alarm-management-openapi.yml, mef-lso-interlude-fault-management-openapi.yml, mef-lso-interlude-performance-monitoring-openapi.yml, mef-lso-interlude-service-function-test-openapi.yml, mef-lso-interlude-service-inventory-management-openapi.yml, mef-lso-interlude-service-ordering-management-openapi.yml, mef-lso-legato-alarm-management-openapi.yml, mef-lso-legato-fault-management-openapi.yml, mef-lso-legato-performance-monitoring-openapi.yml, mef-lso-legato-service-function-test-openapi.yml, mef-lso-legato-service-inventory-management-openapi.yml, mef-lso-legato-service-ordering-management-openapi.yml, mef-lso-sonata-appointment-management-openapi.yml, mef-lso-sonata-billing-management-openapi.yml, mef-lso-sonata-circuit-impairment-and-maintenance-openapi.yml, mef-lso-sonata-geographic-address-management-openapi.yml, mef-lso-sonata-product-catalog-openapi.yml, mef-lso-sonata-product-offering-qualification-management-openapi.yml, mef-lso-sonata-product-order-management-openapi.yml, mef-lso-sonata-quote-management-openapi.yml, mef-lso-sonata-trouble-ticket-management-openapi.yml, mef-lso-sonata-workorder-management-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://{serverBase}/mefApi/allegro/alarmManagement/v3/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/allegro/faultManagement/v3/ variables: serverBase: default: mplify.com description: The base hostname of the SOF (Service Orchestration Function) server. - url: https://{serverBase}/mefApi/allegro/performanceMonitoring/v5/ variables: serverBase: default: mplify.com description: The base hostname of the SOF (Service Orchestration Function) server. - url: https://{serverBase}/mefApi/allegro/serviceFunctionTesting/v3/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/allegro/serviceInventory/v2/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/allegro/serviceOrderingManagement/v1/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/cantata/appointment/v3/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/cantata/customerBillManagement/v3/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/cantata/cimIncident/v1/ variables: serverBase: description: The base of Seller's URL. default: mef.net - url: https://{serverBase}/mefApi/cantata/geographicAddressManagement/v2/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: http://{serverBase}/mefApi/cantata/productCatalog/v4/ variables: serverBase: description: The base of Buyer's URL. default: mplify.net - url: https://{serverBase}/mefApi/cantata/productOfferingQualification/v8/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/cantata/quoteManagement/v4/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/cantata/troubleTicket/v5/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/cantata/workOrderManagement/v3/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/interlude/alarmManagement/v3/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/interlude/faultManagement/v3/ variables: serverBase: default: mplify.com description: The base hostname of the SOF (Service Orchestration Function) server. - url: https://{serverBase}/mefApi/interlude/performanceMonitoring/v5/ variables: serverBase: default: mplify.com description: The base hostname of the SOF (Service Orchestration Function) server. - url: https://{serverBase}/mefApi/interlude/serviceFunctionTesting/v3/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/interlude/serviceInventory/v2/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/interlude/serviceOrderingManagement/v1/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/legato/alarmManagement/v3/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/legato/faultManagement/v3/ variables: serverBase: default: mplify.com description: The base hostname of the SOF (Service Orchestration Function) server. - url: https://{serverBase}/mefApi/legato/performanceMonitoring/v5/ variables: serverBase: default: mplify.com description: The base hostname of the SOF (Service Orchestration Function) server. - url: https://{serverBase}/mefApi/legato/serviceFunctionTesting/v3/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/legato/serviceInventory/v7/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/legato/serviceOrderingManagement/v6/ variables: serverBase: description: The base of SOF's URL. default: mplify.net - url: https://{serverBase}/mefApi/sonata/appointment/v3/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/sonata/customerBillManagement/v3/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/sonata/cimIncident/v1/ variables: serverBase: description: The base of Seller's URL. default: mef.net - url: https://{serverBase}/mefApi/sonata/geographicAddressManagement/v8/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: http://{serverBase}/mefApi/sonata/productCatalog/v4/ variables: serverBase: description: The base of Buyer's URL. default: mplify.net - url: https://{serverBase}/mefApi/sonata/productOfferingQualification/v8/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/sonata/productOrderingManagement/v11/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/sonata/quoteManagement/v10/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/sonata/troubleTicket/v5/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/sonata/workOrderManagement/v3/ variables: serverBase: description: The base of Seller's URL. default: mplify.net tags: - name: events subscription paths: /hub: post: tags: - events subscription summary: Register a listener description: The Buyer/Client or Administrator requests to subscribe to Alarm Notifications. operationId: registerListener requestBody: description: Data containing the callback endpoint to deliver the information. content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/EventSubscriptionInput' required: true responses: '201': description: Subscribed content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/EventSubscription' '400': description: Bad Request content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error400' '401': description: Unauthorized content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error403' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '501': description: Method not implemented. content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error501' servers: - url: https://{serverBase}/mefApi/allegro/alarmManagement/v3/ variables: serverBase: description: The base of SOF's URL. default: mplify.net /hub/{id}: get: tags: - events subscription summary: Retrieves a Hub by ID. description: The Buyer/Client requests detailed information about a single Notification Hub based on the Hub Identifier. operationId: retrieveHub parameters: - name: id in: path description: Identifier of the Hub required: true schema: type: string responses: '200': description: Success content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/EventSubscription' '400': description: Bad Request content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error400' '401': description: Unauthorized content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error404' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '501': description: Method not implemented. content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error501' delete: tags: - events subscription summary: Unregister a listener description: The Buyer/Client or Administrator requests to unsubscribe from Alarm Notifications. operationId: unregisterListener parameters: - name: id in: path description: The id of the registered listener required: true schema: type: string responses: '204': description: Deleted '400': description: Bad request content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error400' '401': description: Unauthorized content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error404' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '501': description: Method not implemented. content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error501' servers: - url: https://{serverBase}/mefApi/allegro/alarmManagement/v3/ variables: serverBase: description: The base of SOF's URL. default: mplify.net components: schemas: Error400Code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body ' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found ' type: string enum: - notFound required: - code Error403: description: Forbidden. This code indicates that the server understood the request but refuses to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users' $ref: '#/components/schemas/Error403Code' required: - code EventSubscriptionInput: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Alarm Notification API (alarmNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for ''callback'': "https://buyer.mplify.com/listenerEndpoint", the alarm event notification will be sent to: `https://buyer.mplify.com/listenerEndpoint/mefApi/allegro/alarmNotification/v3/listener/`' type: string query: description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = createAlarm''. To subscribe for more than one event type, put the values separated by a comma: `eventType=alarmCreateEvent, alarmAttributeValueChangeEvent`. The possible values are enumerated by Event type enums in alarmNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription: required: - id allOf: - $ref: '#/components/schemas/EventSubscriptionInput' - description: This resource is used to respond to notification subscriptions. type: object properties: id: description: An identifier of this Event Subscription assigned when a resource is created. type: string Error401: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired ' $ref: '#/components/schemas/Error401Code' required: - code Error401Code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired ' type: string enum: - missingCredentials - invalidCredentials Error400: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body ' $ref: '#/components/schemas/Error400Code' required: - code Error501: description: Not Implemented. Used in case Seller is not supporting an optional operation (https://tools.ietf.org/html/rfc7231#section-6.6.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notImplemented: Method not supported by the server' type: string enum: - notImplemented required: - code Error500: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request. ' type: string enum: - internalError required: - code Error403Code: description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users' type: string enum: - accessDenied - forbiddenRequester - tooManyUsers Error: description: 'Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. ' type: object properties: message: description: Text that provides mode details and corrective actions related to the error. This can be shown to a client user. type: string reason: description: Text that explains the reason for the error. This can be shown to a client user. type: string maxLength: 255 referenceError: description: URL pointing to documentation describing the error type: string format: uri required: - reason Error400Code_2: type: string description: "One of the following error codes:\n- missingQueryParameter: The URI is missing a required query-string \n parameter.\n- missingQueryValue: The URI is missing a required query-string \n parameter value.\n- invalidQuery: The query section of the URI is invalid.\n- invalidBody: The request has an invalid body." enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_2: allOf: - $ref: '#/components/schemas/Error_2' - type: object properties: code: type: string description: "The following error code:\n- notFound: A current representation of the target resource \n not found." enum: - notFound required: - code description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) Error403_2: allOf: - $ref: '#/components/schemas/Error_2' - type: object properties: code: $ref: '#/components/schemas/Error403Code_2' description: Error code required: - code description: Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3) EventSubscriptionInput_2: type: object description: This class is used to register for Notifications. properties: callback: type: string description: 'This callback value must be set to the *host* property from Fault Management Notification API (faultNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for ''callback'': "https://bus.mplify.com/listenerEndpoint", the Fault Management Job state change event notification will be sent to `https://bus.mplify.com/listenerEndpoint/mefApi/allegro/faultManagement/v3/listener/faultManagementJobStateChangeEvent`' query: type: string description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = faultManagementReportStateChangeEvent''. To subscribe for more than one event type, put the values separated by a comma: `eventType=faultManagementReportStateChangeEvent,faultManagementJobCreateEvent`. The possible values are enumerated by Event type enums in faultNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' required: - callback EventSubscription_2: type: object description: This resource is used to respond to notification subscriptions. properties: callback: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. id: type: string description: An identifier of this Event Subscription assigned when a resource is created. query: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. required: - callback - id Error401_2: allOf: - $ref: '#/components/schemas/Error_2' - type: object properties: code: $ref: '#/components/schemas/Error401Code_2' description: Error code required: - code description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)''' Error401Code_2: type: string description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired.' enum: - missingCredentials - invalidCredentials Error400_2: allOf: - $ref: '#/components/schemas/Error_2' - type: object properties: code: $ref: '#/components/schemas/Error400Code_2' description: Error code required: - code description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)''' Error501_2: allOf: - $ref: '#/components/schemas/Error_2' - type: object properties: code: type: string description: 'The following error code: - notImplemented: Method not supported by the server.' enum: - notImplemented required: - code description: Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231#section-6.6.2) Error500_2: allOf: - $ref: '#/components/schemas/Error_2' - type: object properties: code: type: string description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' enum: - internalError required: - code description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) Error403Code_2: type: string description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users.' enum: - accessDenied - forbiddenRequester - tooManyUsers Error_2: type: object description: Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. properties: message: type: string description: Text that provides more details and corrective actions related to the error. This can be shown to a client user. reason: type: string description: Text that explains the reason for the error. This can be shown to a client user. maxLength: 255 referenceError: type: string description: URL pointing to documentation describing the error. format: uri required: - reason Error400Code_3: type: string description: "One of the following error codes:\n- missingQueryParameter: The URI is missing a required query-string \n parameter\n- missingQueryValue: The URI is missing a required query-string \n parameter value\n- invalidQuery: The query section of the URI is invalid\n- invalidBody: The request has an invalid body." enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_3: allOf: - $ref: '#/components/schemas/Error_3' - type: object properties: code: type: string description: "The following error code:\n- notFound: A current representation of the target resource \n not found." enum: - notFound required: - code description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) Error403_3: allOf: - $ref: '#/components/schemas/Error_3' - type: object properties: code: $ref: '#/components/schemas/Error403Code_3' required: - code description: Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3) EventSubscriptionInput_3: type: object description: This class is used to register for Notifications. properties: callback: type: string description: 'This callback value must be set to the *host* property from Performance Notification API (performanceNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for ''callback'': "https://bus.mplify.com/listenerEndpoint", the performance job state change event notification will be sent to `https://bus.mplify.com/listenerEndpoint/mefApi/allegro/performanceMonitoring/v5/listener/performanceJobStateChangeEvent`.' query: type: string description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = performanceReportStateChangeEvent''. To subscribe for more than one event type, put the values separated by a comma: `eventType=performanceReportStateChangeEvent,performanceJobCreateEvent`. The possible values are enumerated by Event type enums in performanceNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' required: - callback EventSubscription_3: type: object description: This resource is used to respond to notification subscriptions. properties: callback: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. id: type: string description: An identifier of this Event Subscription assigned when a resource is created. query: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. required: - callback - id Error401_3: allOf: - $ref: '#/components/schemas/Error_3' - type: object properties: code: $ref: '#/components/schemas/Error401Code_3' required: - code description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)''' Error401Code_3: type: string description: 'One of the following error codes: - missingCredentials: No credentials provided - invalidCredentials: Provided credentials are invalid or expired.' enum: - missingCredentials - invalidCredentials Error400_3: allOf: - $ref: '#/components/schemas/Error_3' - type: object properties: code: $ref: '#/components/schemas/Error400Code_3' required: - code description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)''' Error501_3: allOf: - $ref: '#/components/schemas/Error_3' - type: object properties: code: type: string description: 'The following error code: - notImplemented: Method not supported by the server.' enum: - notImplemented required: - code description: Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231#section-6.6.2) Error500_3: allOf: - $ref: '#/components/schemas/Error_3' - type: object properties: code: type: string description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' enum: - internalError required: - code description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) Error403Code_3: type: string description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users.' enum: - accessDenied - forbiddenRequester - tooManyUsers Error_3: type: object description: Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. properties: message: type: string description: Text that provides more details and corrective actions related to the error. This can be shown to a client user. reason: type: string description: Text that explains the reason for the error. This can be shown to a client user. maxLength: 255 referenceError: type: string description: URL pointing to documentation describing the error. format: uri required: - reason EventSubscriptionInput_4: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from SFT Notification API (serviceFunctionTestNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for ''callback'': "https://buyer.mplify.com/listenerEndpoint", the SFT event notification will be sent to: `https://buyer.mplify.com/listenerEndpoint/mefApi/allegro/serviceFunctionTestingNotification/v3/`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: ''query'':''eventType = testJobCreateEvent''. To subscribe for more than one event type, put the values separated by comma: `eventType=testJobCreateEvent,testProfileAttributeValueChangeEvent`. The possible values are enumerated by ''TestProfileEventType'' and TestJobEventType in serviceFunctionTestNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback - id Error422: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property that was expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the target system\n - unexpectedProperty: Additional, not expected property has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_4: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code: description: 'One of the following error codes: - missingProperty: The property that was expected is not present in the payload - invalidValue: The property has an incorrect value - invalidFormat: The property value does not comply with the expected value format - referenceNotFound: The object referenced by the property cannot be identified in the target system - unexpectedProperty: Additional, not expected property has been provided - tooManyRecords: the number of records to be provided in the response exceeds the threshold. - otherIssue: Other problem was identified (detailed information provided in a reason) ' type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_4: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_5: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from BUS Service Inventory Notification API (serviceInventoryNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "https://client.mef.com/listenerEndpoint", the service state change event notification will be sent to: `https://client.mef.com/listenerEndpoint/mefApi/allegro/serviceInventoryNotification/v2/listener/serviceStateChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = serviceStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=serviceCreateEvent,serviceStateChangeEvent`. The possible values are enumerated by ''ServiceEventType'' in serviceInventoryNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_4: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by the BUS in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the SOF when a resource is created. type: string query: description: The value provided by the BUS in `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_4: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_4' required: - code Error401Code_4: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_4: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_4' required: - code Error500_4: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error400Code_5: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_5: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_6: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Service Order Notification API (serviceOrderNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "https://client.mef.com/listenerEndpoint", the service order state change event notification will be sent to: `https://client.mef.com/listenerEndpoint/mefApi/allegro/serviceOrderingManagement/v1/listener/serviceOrderStateChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = serviceOrderStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=serviceOrderStateChangeEvent,serviceOrderItemStateChangeEvent`. The possible values are enumerated by ''serviceOrderEventType'' in serviceOrderNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_5: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned when a resource is created. type: string query: description: The value provided by the `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_5: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_5' required: - code Error401Code_5: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_5: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_5' required: - code Error500_5: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_2: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_2' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_6: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_2: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_6: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_7: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Notification API (appointmentNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.mef.com/listenerEndpoint", the status change event notification will be sent to: `http://buyer.mef.com/listenerEndpoint/mefApi/cantata/appointmentNotification/v3/listener/appointmentStatusChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = AppointmentStatusChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=AppointmentStatusChangeEvent,AppointmentResolvedEvent`. The possible values are enumerated by the ''AppointmentEventType'' in AppointmentNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_6: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of the event subscription assigned by the Seller when a resource is created. type: string query: description: This attribute is used to define notification registration constraints. type: string required: - callback - id Error401_6: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_6' required: - code Error401Code_6: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_6: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_6' required: - code Error500_6: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error400Code_7: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_7: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_8: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Notification API (billingNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.com/listenerEndpoint", the state change event notification will be sent to: `http://buyer.com/listenerEndpoint/mefApi/cantata/customerBillManagement/v3/listener/troubleTicketStatusChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = customerBillCreateEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=customerBillCreateEvent,customerBillStateChangeEvent`. The possible values are enumerated by the ''CustomerBillEventType'' in billingNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_7: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: id: description: Id of the listener type: string callback: description: The callback being registered. type: string query: description: additional data to be passed type: string required: - callback - id Error401_7: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_7' required: - code Error401Code_7: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_7: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_7' required: - code Error500_7: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_3: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_3' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_8: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_3: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_8: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_9: description: "This class is used to register for Notifications. \n\n| API name | MEF 113 name | Description |\n| ---------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------- |\n| `cimIncidentCreateEvent` | INCIDENT_CREATE | A new CIM Incident was created by the Seller. |\n| `cimIdentAttributeValueChangeEvent` | INCIDENT_UPDATE | An open CIM Incident was updated by the Seller. |\n| `cimIdentStatusChangeEvent` | INCIDENT_STATE_CHANGE | An CIM Incident `status` was changed by the Seller. |\n" type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Notification API (circuitImpairmentAndMaintenance.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.mef.com/listenerEndpoint", the status change event notification will be sent to: `http://buyer.mef.com/listenerEndpoint/mefApi/cantata/cimIncidentNotification/v1/listener/cimIncidentAttributeValueChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = cimIncidentAttributeValueChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=cimIncidentAttributeValueChangeEvent,cimIncidentCreateEvent`. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_8: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of the event subscription assigned by the Seller when a resource is created. type: string query: description: This attribute is used to define notification registration constraints. type: string required: - callback - id Error401_8: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_8' required: - code Error401Code_8: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_8: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_8' required: - code Error500_8: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_4: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error_4' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_4' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_9: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_4: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_9: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error_4' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code Error403_4: allOf: - $ref: '#/components/schemas/Error_4' - properties: code: description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users' $ref: '#/components/schemas/Error403Code' required: - code type: object description: Forbidden. (https://tools.ietf.org/html/rfc7231#section-6.5.3) EventSubscriptionInput_10: description: This class is used to register for Notifications. type: object properties: callback: description: 'The callback address that the Buyer will be listening for the event notifications at. This property is appended with the notification resource path to construct an URL to which notification is sent. E.g. for "callback": "https://buyer.mef.com/listenerEndpoint", the Geographic Address Validation State Change Event state change notification will be sent to: `https://buyer.mef.com/listenerEndpoint/mefApi/cantata/geographicAddressNotification/v2/listener/geographicAddressValidationStateChangeEvent`' type: string query: description: This attribute is used to define to which type of events to register to. There is only one event type possible, so the value must either be empty or equal to "geographicAddressValidationStateChangeEvent". type: string required: - callback EventSubscription_9: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the Seller when a resource is created. type: string query: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_9: allOf: - $ref: '#/components/schemas/Error_4' - properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_9' required: - code type: object description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) Error401Code_9: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_9: allOf: - $ref: '#/components/schemas/Error_4' - properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_9' required: - code type: object description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) Error500_9: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error_4' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error_4: description: 'Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. ' type: object properties: reason: description: Text that explains the reason for error. This can be shown to a client user. type: string maxLength: 255 message: description: Text that provides mode details and corrective actions related to the error. This can be shown to a client user. type: string referenceError: description: URL pointing to documentation describing the error type: string format: uri required: - reason Error422_5: allOf: - $ref: '#/components/schemas/Error' - properties: code: $ref: '#/components/schemas/Error422Code_5' description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code type: object description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) Error400Code_10: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_5: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue type: string Error404_10: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_11: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from the Buyer Product Catalog Notification API (productCatalogNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for "callback": "https://buyer.mef.com/listenerEndpoint", the Product Specification state change event notification will be sent to: `https://buyer.mef.com/listenerEndpoint/mefApi/cantata/productCatalogNotifications/v4/listener/productCatalogStateChange`' type: string query: description: 'This attribute is used to define which type of events to register to. See the `ProductCategoryEventType`, `ProductSpecificationEventType`, `ProductOfferingEventType` in (productCatalogNotification.api.yaml to check what kind of events are supported. To subscribe for more than one event type, put the values separated by a comma: `eventType=productOfferingCreateEvent,productOfferingAttributeValueChangeEvent` or repeat the same attribute: `eventType=productOfferingCreateEvent&eventType=productOfferingAttributeValueChangeEvent` An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_10: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the Seller when a resource is created. type: string query: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_10: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_10' required: - code Error401Code_10: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_10: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_10' required: - code Error500_10: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_6: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_6' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_11: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_6: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_11: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_12: description: This class is used to register for Notifications. type: object properties: query: description: 'This attribute is used to define which type of events to register to. Example: "query":"eventType = poqStateChangeEvent". To subscribe for more than one event type, put the values separated by a comma: `eventType=poqStateChangeEvent,poqItemStateChangeEvent`. The possible values are enumerated by the ''POQEventType'' in productOfferingQualificationNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string callback: description: 'This callback value must be set to *host* property from the Buyer ProductOfferingQualification Notification API (productOfferingQualificationNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for the "callback": "https://buyer.mef.com/listenerEndpoint", the create event notification will be sent to: `https://buyer.mef.com/listenerEndpoint/mefApi/cantata/productOfferingQualificationNotification/v8/listener/poqStateChangeEvent`' type: string required: - callback EventSubscription_11: description: 'This resource is used to manage notification subscriptions. ' type: object properties: query: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the Seller when a resource is created. type: string required: - callback - id Error401_11: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_11' required: - code Error401Code_11: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_11: allOf: - $ref: '#/components/schemas/Error' - properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_11' required: - code type: object description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) Error500_11: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_7: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_7' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_12: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_7: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_12: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_13: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Product Order Notification API (productOrderNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": `https://buyer.mef.com/listenerEndpoint``, the product order state change event notification will be sent to: `https://buyer.mef.com/listenerEndpoint/mefApi/cantata/productOrderingNotification/v6/listener/productOrderStateChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = productOrderStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=productOrderStateChangeEvent,productOrderItemStateChangeEvent`. The possible values are enumerated by ''ProductOrderEventType'', `CancelProductOrderEventType` in productOrderNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_12: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the Seller when a resource is created. type: string query: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_12: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_12' required: - code Error401Code_12: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_12: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_12' required: - code Error500_12: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_8: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_8' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_13: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_8: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_13: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_14: description: This class is used to register for Notifications. type: object properties: query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = quoteStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=quoteStateChangeEvent,quoteItemStateChangeEvent`. The possible values are enumerated by the ''QuoteEventType'' in quoteNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string callback: description: 'This callback value must be set to *host* property from Buyer Notification API (quoteNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.mef.com/listenerEndpoint", the state change event notification will be sent to: `http://buyer.mef.com/listenerEndpoint/mefApi/cantata/quoteNotification/v4/listener/quoteStateChangeEvent`' type: string required: - callback EventSubscription_13: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: id: description: Id of the listener type: string callback: description: The callback being registered. type: string query: description: additional data to be passed type: string required: - callback - id Error401_13: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_13' required: - code Error401Code_13: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_13: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_13' required: - code Error501_4: description: Not Implemented. (https://tools.ietf.org/html/rfc7231#section-6.6.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notImplemented: Method not supported by the server' type: string enum: - notImplemented required: - code Error500_13: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_9: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error_5' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_9' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_14: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_9: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_14: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error_5' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_15: description: "This class is used to register for Notifications. \n\n| API name | MEF 113 name | Description |\n| ---------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `troubleTicketAttributeValueChangeEvent` | TICKET_UPDATE | The Seller settable attributes for a Ticket were updated by the Seller. Note: Buyer initiated Ticket updates due to Patch operation will not trigger a `troubleTicketAttributeValueChangeEvent` |\n| `troubleTicketStatusChangeEvent` | TICKET_STATE_CHANGE | A Ticket `status` was changed by the Seller. |\n| `troubleTicketInformationRequiredEvent` | TICKET_INFO_REQUIRED | The Seller requires more information from the Buyer for a Ticket to continue processing a Ticket. The details on what information is needed from the Buyer will be provided via a Ticket `note`. The Ticket `status` is `pending`. Note: The Buyer uses the Patch operation to provide more information for a Ticket. |\n| `troubleTicketResolvedEvent` | TICKET_RESOLVED | The Seller is informing the Buyer the Ticket is resolved and the Buyer to verify that the Issue on which the Ticket was based is no longer observed. The Ticket `status` is `resolved`. Note: The Buyer confirms if the Issue has been resolved satisfactorily or not using close or reopen operations |\n| `incidentCreateEvent` | INCIDENT_CREATE | A new Incident was created by the Seller. |\n| `incidentAttributeValueChangeEvent` | INCIDENT_UPDATE | An open Incident was updated by the Seller. |\n| `incidentStatusChangeEvent` | INCIDENT_STATE_CHANGE | An Incident `status` was changed by the Seller. |\n" type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Notification API (troubleTicketNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.mef.com/listenerEndpoint", the state change event notification will be sent to: `http://buyer.mef.com/listenerEndpoint/mefApi/cantata/troubleTicketNotification/v2/listener/troubleTicketStatusChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = troubleTicketStatusChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=troubleTicketStatusChangeEvent,troubleTicketResolvedEvent`. The possible values are enumerated by the ''TroubleTicketEventType'' in troubleTicketNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_14: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of the event subscription assigned by the Seller when a resource is created. type: string query: description: This attribute is used to define notification registration constraints. type: string required: - callback - id Error401_14: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error_5' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_14' required: - code Error401Code_14: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_14: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error_5' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_14' required: - code Error500_14: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error_5' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error_5: description: 'Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. ' type: object properties: message: description: Text that provides mode details and corrective actions related to the error. This can be shown to a client user. type: string reason: description: Text that explains the reason the for error. This can be shown to a client user. type: string maxLength: 255 referenceError: description: URL pointing to documentation describing the error type: string format: uri required: - reason Error422_10: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_10' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_15: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_10: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_15: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_16: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Notification API (WorkOrderNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.mef.com/listenerEndpoint", the state change event notification will be sent to: `http://buyer.mef.com/listenerEndpoint/mefApi/cantata/workOrderNotification/v3/listener/workOrderStateChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = WorkOrderStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=WorkOrderStateChangeEvent,WorkOrderResolvedEvent`. The possible values are enumerated by the ''WorkOrderEventType'' in WorkOrderNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_15: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of the event subscription assigned by the Seller when a resource is created. type: string query: description: This attribute is used to define notification registration constraints. type: string required: - callback - id Error401_15: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_15' required: - code Error401Code_15: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_15: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_15' required: - code Error500_15: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code EventSubscriptionInput_17: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Alarm Notification API (alarmNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for ''callback'': "https://buyer.mplify.com/listenerEndpoint", the alarm event notification will be sent to: `https://buyer.mplify.com/listenerEndpoint/mefApi/interlude/alarmNotification/v3/listener/`' type: string query: description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = createAlarm''. To subscribe for more than one event type, put the values separated by a comma: `eventType=alarmCreateEvent, alarmAttributeValueChangeEvent`. The possible values are enumerated by Event type enums in alarmNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback Error400Code_16: type: string description: "One of the following error codes:\n- missingQueryParameter: The URI is missing a required query-string \n parameter.\n- missingQueryValue: The URI is missing a required query-string \n parameter value.\n- invalidQuery: The query section of the URI is invalid.\n- invalidBody: The request has an invalid body." enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_16: allOf: - $ref: '#/components/schemas/Error_6' - type: object properties: code: type: string description: "The following error code:\n- notFound: A current representation of the target resource \n not found." enum: - notFound required: - code description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) Error403_5: allOf: - $ref: '#/components/schemas/Error_6' - type: object properties: code: $ref: '#/components/schemas/Error403Code_4' description: Error code required: - code description: Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3) EventSubscriptionInput_18: type: object description: This class is used to register for Notifications. properties: callback: type: string description: 'This callback value must be set to the *host* property from Fault Management Notification API (faultNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for ''callback'': "https://bus.mplify.com/listenerEndpoint", the Fault Management Job state change event notification will be sent to `https://bus.mplify.com/listenerEndpoint/mefApi/interlude/faultManagement/v3/listener/faultManagementJobStateChangeEvent`' query: type: string description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = faultManagementReportStateChangeEvent''. To subscribe for more than one event type, put the values separated by a comma: `eventType=faultManagementReportStateChangeEvent,faultManagementJobCreateEvent`. The possible values are enumerated by Event type enums in faultNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' required: - callback EventSubscription_16: type: object description: This resource is used to respond to notification subscriptions. properties: callback: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. id: type: string description: An identifier of this Event Subscription assigned when a resource is created. query: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. required: - callback - id Error401_16: allOf: - $ref: '#/components/schemas/Error_6' - type: object properties: code: $ref: '#/components/schemas/Error401Code_16' description: Error code required: - code description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)''' Error401Code_16: type: string description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired.' enum: - missingCredentials - invalidCredentials Error400_16: allOf: - $ref: '#/components/schemas/Error_6' - type: object properties: code: $ref: '#/components/schemas/Error400Code_16' description: Error code required: - code description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)''' Error501_5: allOf: - $ref: '#/components/schemas/Error_6' - type: object properties: code: type: string description: 'The following error code: - notImplemented: Method not supported by the server.' enum: - notImplemented required: - code description: Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231#section-6.6.2) Error500_16: allOf: - $ref: '#/components/schemas/Error_6' - type: object properties: code: type: string description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' enum: - internalError required: - code description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) Error403Code_4: type: string description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users.' enum: - accessDenied - forbiddenRequester - tooManyUsers Error_6: type: object description: Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. properties: message: type: string description: Text that provides more details and corrective actions related to the error. This can be shown to a client user. reason: type: string description: Text that explains the reason for the error. This can be shown to a client user. maxLength: 255 referenceError: type: string description: URL pointing to documentation describing the error. format: uri required: - reason Error400Code_17: type: string description: "One of the following error codes:\n- missingQueryParameter: The URI is missing a required query-string \n parameter\n- missingQueryValue: The URI is missing a required query-string \n parameter value\n- invalidQuery: The query section of the URI is invalid\n- invalidBody: The request has an invalid body." enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_17: allOf: - $ref: '#/components/schemas/Error_7' - type: object properties: code: type: string description: "The following error code:\n- notFound: A current representation of the target resource \n not found." enum: - notFound required: - code description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) Error403_6: allOf: - $ref: '#/components/schemas/Error_7' - type: object properties: code: $ref: '#/components/schemas/Error403Code_5' required: - code description: Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3) EventSubscriptionInput_19: type: object description: This class is used to register for Notifications. properties: callback: type: string description: 'This callback value must be set to the *host* property from Performance Notification API (performanceNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for ''callback'': "https://bus.mplify.com/listenerEndpoint", the performance job state change event notification will be sent to `https://bus.mplify.com/listenerEndpoint/mefApi/interlude/performanceMonitoring/v5/listener/performanceJobStateChangeEvent`.' query: type: string description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = performanceReportStateChangeEvent''. To subscribe for more than one event type, put the values separated by a comma: `eventType=performanceReportStateChangeEvent,performanceJobCreateEvent`. The possible values are enumerated by Event type enums in performanceNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' required: - callback EventSubscription_17: type: object description: This resource is used to respond to notification subscriptions. properties: callback: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. id: type: string description: An identifier of this Event Subscription assigned when a resource is created. query: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. required: - callback - id Error401_17: allOf: - $ref: '#/components/schemas/Error_7' - type: object properties: code: $ref: '#/components/schemas/Error401Code_17' required: - code description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)''' Error401Code_17: type: string description: 'One of the following error codes: - missingCredentials: No credentials provided - invalidCredentials: Provided credentials are invalid or expired.' enum: - missingCredentials - invalidCredentials Error400_17: allOf: - $ref: '#/components/schemas/Error_7' - type: object properties: code: $ref: '#/components/schemas/Error400Code_17' required: - code description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)''' Error501_6: allOf: - $ref: '#/components/schemas/Error_7' - type: object properties: code: type: string description: 'The following error code: - notImplemented: Method not supported by the server.' enum: - notImplemented required: - code description: Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231#section-6.6.2) Error500_17: allOf: - $ref: '#/components/schemas/Error_7' - type: object properties: code: type: string description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' enum: - internalError required: - code description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) Error403Code_5: type: string description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users.' enum: - accessDenied - forbiddenRequester - tooManyUsers Error_7: type: object description: Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. properties: message: type: string description: Text that provides more details and corrective actions related to the error. This can be shown to a client user. reason: type: string description: Text that explains the reason for the error. This can be shown to a client user. maxLength: 255 referenceError: type: string description: URL pointing to documentation describing the error. format: uri required: - reason EventSubscriptionInput_20: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from SFT Notification API (serviceFunctionTestNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for ''callback'': "https://buyer.mplify.com/listenerEndpoint", the SFT event notification will be sent to: `https://buyer.mplify.com/listenerEndpoint/mefApi/interlude/serviceFunctionTestingNotification/v3/`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: ''query'':''eventType = testJobCreateEvent''. To subscribe for more than one event type, put the values separated by comma: `eventType=testJobCreateEvent,testProfileAttributeValueChangeEvent`. The possible values are enumerated by ''TestProfileEventType'' and TestJobEventType in serviceFunctionTestNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback - id Error400Code_18: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_18: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_21: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from BUS Service Inventory Notification API (serviceInventoryNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "https://client.mef.com/listenerEndpoint", the service state change event notification will be sent to: `https://client.mef.com/listenerEndpoint/mefApi/interlude/serviceInventoryNotification/v2/listener/serviceStateChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = serviceStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=serviceCreateEvent,serviceStateChangeEvent`. The possible values are enumerated by ''ServiceEventType'' in serviceInventoryNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_18: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by the BUS in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the SOF when a resource is created. type: string query: description: The value provided by the BUS in `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_18: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_18' required: - code Error401Code_18: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_18: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_18' required: - code Error500_18: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error400Code_19: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_19: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_22: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Service Order Notification API (serviceOrderNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "https://client.mef.com/listenerEndpoint", the service order state change event notification will be sent to: `https://client.mef.com/listenerEndpoint/mefApi/interlude/serviceOrderingManagement/v1/listener/serviceOrderStateChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = serviceOrderStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=serviceOrderStateChangeEvent,serviceOrderItemStateChangeEvent`. The possible values are enumerated by ''serviceOrderEventType'' in serviceOrderNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_19: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned when a resource is created. type: string query: description: The value provided by the `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_19: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_19' required: - code Error401Code_19: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_19: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_19' required: - code Error500_19: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code EventSubscriptionInput_23: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Alarm Notification API (alarmNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for ''callback'': "https://buyer.mplify.com/listenerEndpoint", the alarm event notification will be sent to: `https://buyer.mplify.com/listenerEndpoint/mefApi/legato/alarmNotification/v2/listener/`' type: string query: description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = createAlarm''. To subscribe for more than one event type, put the values separated by a comma: `eventType=alarmCreateEvent, alarmAttributeValueChangeEvent`. The possible values are enumerated by Event type enums in alarmNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback Error400Code_20: type: string description: "One of the following error codes:\n- missingQueryParameter: The URI is missing a required query-string \n parameter.\n- missingQueryValue: The URI is missing a required query-string \n parameter value.\n- invalidQuery: The query section of the URI is invalid.\n- invalidBody: The request has an invalid body." enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_20: allOf: - $ref: '#/components/schemas/Error_8' - type: object properties: code: type: string description: "The following error code:\n- notFound: A current representation of the target resource \n not found." enum: - notFound required: - code description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) Error403_7: allOf: - $ref: '#/components/schemas/Error_8' - type: object properties: code: $ref: '#/components/schemas/Error403Code_6' description: Error code required: - code description: Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3) EventSubscriptionInput_24: type: object description: This class is used to register for Notifications. properties: callback: type: string description: 'This callback value must be set to the *host* property from Fault Management Notification API (faultNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for ''callback'': "https://bus.mplify.com/listenerEndpoint", the Fault Management Job state change event notification will be sent to `https://bus.mplify.com/listenerEndpoint/mefApi/legato/faultManagement/v3/listener/faultManagementJobStateChangeEvent`' query: type: string description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = faultManagementReportStateChangeEvent''. To subscribe for more than one event type, put the values separated by a comma: `eventType=faultManagementReportStateChangeEvent,faultManagementJobCreateEvent`. The possible values are enumerated by Event type enums in faultNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' required: - callback EventSubscription_20: type: object description: This resource is used to respond to notification subscriptions. properties: callback: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. id: type: string description: An identifier of this Event Subscription assigned when a resource is created. query: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. required: - callback - id Error401_20: allOf: - $ref: '#/components/schemas/Error_8' - type: object properties: code: $ref: '#/components/schemas/Error401Code_20' description: Error code required: - code description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)''' Error401Code_20: type: string description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired.' enum: - missingCredentials - invalidCredentials Error400_20: allOf: - $ref: '#/components/schemas/Error_8' - type: object properties: code: $ref: '#/components/schemas/Error400Code_20' description: Error code required: - code description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)''' Error501_7: allOf: - $ref: '#/components/schemas/Error_8' - type: object properties: code: type: string description: 'The following error code: - notImplemented: Method not supported by the server.' enum: - notImplemented required: - code description: Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231#section-6.6.2) Error500_20: allOf: - $ref: '#/components/schemas/Error_8' - type: object properties: code: type: string description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' enum: - internalError required: - code description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) Error403Code_6: type: string description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users.' enum: - accessDenied - forbiddenRequester - tooManyUsers Error_8: type: object description: Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. properties: message: type: string description: Text that provides more details and corrective actions related to the error. This can be shown to a client user. reason: type: string description: Text that explains the reason for the error. This can be shown to a client user. maxLength: 255 referenceError: type: string description: URL pointing to documentation describing the error. format: uri required: - reason Error400Code_21: type: string description: "One of the following error codes:\n- missingQueryParameter: The URI is missing a required query-string \n parameter\n- missingQueryValue: The URI is missing a required query-string \n parameter value\n- invalidQuery: The query section of the URI is invalid\n- invalidBody: The request has an invalid body." enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_21: allOf: - $ref: '#/components/schemas/Error_9' - type: object properties: code: type: string description: "The following error code:\n- notFound: A current representation of the target resource \n not found." enum: - notFound required: - code description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) Error403_8: allOf: - $ref: '#/components/schemas/Error_9' - type: object properties: code: $ref: '#/components/schemas/Error403Code_7' required: - code description: Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3) EventSubscriptionInput_25: type: object description: This class is used to register for Notifications. properties: callback: type: string description: 'This callback value must be set to the *host* property from Performance Notification API (performanceNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for ''callback'': "https://bus.mplify.com/listenerEndpoint", the performance job state change event notification will be sent to `https://bus.mplify.com/listenerEndpoint/mefApi/legato/performanceMonitoring/v5/listener/performanceJobStateChangeEvent`.' query: type: string description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = performanceReportStateChangeEvent''. To subscribe for more than one event type, put the values separated by a comma: `eventType=performanceReportStateChangeEvent,performanceJobCreateEvent`. The possible values are enumerated by Event type enums in performanceNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' required: - callback EventSubscription_21: type: object description: This resource is used to respond to notification subscriptions. properties: callback: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. id: type: string description: An identifier of this Event Subscription assigned when a resource is created. query: type: string description: The value provided by the `EventSubscriptionInput` during notification registration. required: - callback - id Error401_21: allOf: - $ref: '#/components/schemas/Error_9' - type: object properties: code: $ref: '#/components/schemas/Error401Code_21' required: - code description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)''' Error401Code_21: type: string description: 'One of the following error codes: - missingCredentials: No credentials provided - invalidCredentials: Provided credentials are invalid or expired.' enum: - missingCredentials - invalidCredentials Error400_21: allOf: - $ref: '#/components/schemas/Error_9' - type: object properties: code: $ref: '#/components/schemas/Error400Code_21' required: - code description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)''' Error501_8: allOf: - $ref: '#/components/schemas/Error_9' - type: object properties: code: type: string description: 'The following error code: - notImplemented: Method not supported by the server.' enum: - notImplemented required: - code description: Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231#section-6.6.2) Error500_21: allOf: - $ref: '#/components/schemas/Error_9' - type: object properties: code: type: string description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' enum: - internalError required: - code description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) Error403Code_7: type: string description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users.' enum: - accessDenied - forbiddenRequester - tooManyUsers Error_9: type: object description: Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. properties: message: type: string description: Text that provides more details and corrective actions related to the error. This can be shown to a client user. reason: type: string description: Text that explains the reason for the error. This can be shown to a client user. maxLength: 255 referenceError: type: string description: URL pointing to documentation describing the error. format: uri required: - reason EventSubscriptionInput_26: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from SFT Notification API (serviceFunctionTestNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for ''callback'': "https://buyer.mplify.com/listenerEndpoint", the SFT event notification will be sent to: `https://buyer.mplify.com/listenerEndpoint/mefApi/legato/serviceFunctionTestingNotification/v3/`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: ''query'':''eventType = testJobCreateEvent''. To subscribe for more than one event type, put the values separated by comma: `eventType=testJobCreateEvent,testProfileAttributeValueChangeEvent`. The possible values are enumerated by ''TestProfileEventType'' and TestJobEventType in serviceFunctionTestNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback - id Error400Code_22: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_22: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_27: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from BUS Service Inventory Notification API (serviceInventoryNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "https://client.mef.com/listenerEndpoint", the service state change event notification will be sent to: `https://client.mef.com/listenerEndpoint/mefApi/legato/serviceInventoryNotification/v7/listener/serviceStateChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = serviceStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=serviceCreateEvent,serviceStateChangeEvent`. The possible values are enumerated by ''ServiceEventType'' in serviceInventoryNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_22: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by the BUS in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the SOF when a resource is created. type: string query: description: The value provided by the BUS in `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_22: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_22' required: - code Error401Code_22: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_22: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_22' required: - code Error500_22: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error400Code_23: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_23: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_28: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Service Order Notification API (serviceOrderNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "https://client.mef.com/listenerEndpoint", the service order state change event notification will be sent to: `https://client.mef.com/listenerEndpoint/mefApi/legato/serviceOrderingManagement/v6/listener/serviceOrderStateChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = serviceOrderStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=serviceOrderStateChangeEvent,serviceOrderItemStateChangeEvent`. The possible values are enumerated by ''serviceOrderEventType'' in serviceOrderNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_23: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned when a resource is created. type: string query: description: The value provided by the `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_23: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_23' required: - code Error401Code_23: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_23: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_23' required: - code Error500_23: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_11: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_11' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_24: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_11: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_24: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_29: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Notification API (appointmentNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.mef.com/listenerEndpoint", the status change event notification will be sent to: `http://buyer.mef.com/listenerEndpoint/mefApi/sonata/appointmentNotification/v3/listener/appointmentStatusChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = AppointmentStatusChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=AppointmentStatusChangeEvent,AppointmentResolvedEvent`. The possible values are enumerated by the ''AppointmentEventType'' in AppointmentNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_24: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of the event subscription assigned by the Seller when a resource is created. type: string query: description: This attribute is used to define notification registration constraints. type: string required: - callback - id Error401_24: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_24' required: - code Error401Code_24: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_24: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_24' required: - code Error500_24: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error400Code_25: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error404_25: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_30: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Notification API (billingNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.com/listenerEndpoint", the state change event notification will be sent to: `http://buyer.com/listenerEndpoint/mefApi/sonata/customerBillManagement/v3/listener/troubleTicketStatusChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = customerBillCreateEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=customerBillCreateEvent,customerBillStateChangeEvent`. The possible values are enumerated by the ''CustomerBillEventType'' in billingNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_25: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: id: description: Id of the listener type: string callback: description: The callback being registered. type: string query: description: additional data to be passed type: string required: - callback - id Error401_25: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_25' required: - code Error401Code_25: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_25: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_25' required: - code Error500_25: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_12: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_12' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_26: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_12: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_26: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_31: description: "This class is used to register for Notifications. \n\n| API name | MEF 113 name | Description |\n| ---------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------- |\n| `cimIncidentCreateEvent` | INCIDENT_CREATE | A new CIM Incident was created by the Seller. |\n| `cimIdentAttributeValueChangeEvent` | INCIDENT_UPDATE | An open CIM Incident was updated by the Seller. |\n| `cimIdentStatusChangeEvent` | INCIDENT_STATE_CHANGE | An CIM Incident `status` was changed by the Seller. |\n" type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Notification API (circuitImpairmentAndMaintenance.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.mef.com/listenerEndpoint", the status change event notification will be sent to: `http://buyer.mef.com/listenerEndpoint/mefApi/sonata/cimIncidentNotification/v1/listener/cimIncidentAttributeValueChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = cimIncidentAttributeValueChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=cimIncidentAttributeValueChangeEvent,cimIncidentCreateEvent`. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_26: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of the event subscription assigned by the Seller when a resource is created. type: string query: description: This attribute is used to define notification registration constraints. type: string required: - callback - id Error401_26: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_26' required: - code Error401Code_26: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_26: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_26' required: - code Error500_26: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_13: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error_10' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_13' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_27: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_13: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_27: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error_10' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code Error403_9: allOf: - $ref: '#/components/schemas/Error_10' - properties: code: description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users' $ref: '#/components/schemas/Error403Code' required: - code type: object description: Forbidden. (https://tools.ietf.org/html/rfc7231#section-6.5.3) EventSubscriptionInput_32: description: This class is used to register for Notifications. type: object properties: callback: description: 'The callback address that the Buyer will be listening for the event notifications at. This property is appended with the notification resource path to construct an URL to which notification is sent. E.g. for "callback": "https://buyer.mef.com/listenerEndpoint", the Geographic Address Validation State Change Event state change notification will be sent to: `https://buyer.mef.com/listenerEndpoint/mefApi/sonata/geographicAddressNotification/v8/listener/geographicAddressValidationStateChangeEvent`' type: string query: description: This attribute is used to define to which type of events to register to. There is only one event type possible, so the value must either be empty or equal to "geographicAddressValidationStateChangeEvent". type: string required: - callback EventSubscription_27: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the Seller when a resource is created. type: string query: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_27: allOf: - $ref: '#/components/schemas/Error_10' - properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_27' required: - code type: object description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) Error401Code_27: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_27: allOf: - $ref: '#/components/schemas/Error_10' - properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_27' required: - code type: object description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) Error500_27: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error_10' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error_10: description: 'Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. ' type: object properties: reason: description: Text that explains the reason for error. This can be shown to a client user. type: string maxLength: 255 message: description: Text that provides mode details and corrective actions related to the error. This can be shown to a client user. type: string referenceError: description: URL pointing to documentation describing the error type: string format: uri required: - reason Error422_14: allOf: - $ref: '#/components/schemas/Error' - properties: code: $ref: '#/components/schemas/Error422Code_14' description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code type: object description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) Error400Code_28: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_14: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue type: string Error404_28: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_33: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from the Buyer Product Catalog Notification API (productCatalogNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for "callback": "https://buyer.mef.com/listenerEndpoint", the Product Specification state change event notification will be sent to: `https://buyer.mef.com/listenerEndpoint/mefApi/sonata/productCatalogNotifications/v4/listener/productCatalogStateChange`' type: string query: description: 'This attribute is used to define which type of events to register to. See the `ProductCategoryEventType`, `ProductSpecificationEventType`, `ProductOfferingEventType` in (productCatalogNotification.api.yaml to check what kind of events are supported. To subscribe for more than one event type, put the values separated by a comma: `eventType=productOfferingCreateEvent,productOfferingAttributeValueChangeEvent` or repeat the same attribute: `eventType=productOfferingCreateEvent&eventType=productOfferingAttributeValueChangeEvent` An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_28: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the Seller when a resource is created. type: string query: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_28: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_28' required: - code Error401Code_28: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_28: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_28' required: - code Error500_28: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_15: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_15' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_29: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_15: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_29: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_34: description: This class is used to register for Notifications. type: object properties: query: description: 'This attribute is used to define which type of events to register to. Example: "query":"eventType = poqStateChangeEvent". To subscribe for more than one event type, put the values separated by a comma: `eventType=poqStateChangeEvent,poqItemStateChangeEvent`. The possible values are enumerated by the ''POQEventType'' in productOfferingQualificationNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string callback: description: 'This callback value must be set to *host* property from the Buyer ProductOfferingQualification Notification API (productOfferingQualificationNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for the "callback": "https://buyer.mef.com/listenerEndpoint", the create event notification will be sent to: `https://buyer.mef.com/listenerEndpoint/mefApi/sonata/productOfferingQualificationNotification/v8/listener/poqStateChangeEvent`' type: string required: - callback EventSubscription_29: description: 'This resource is used to manage notification subscriptions. ' type: object properties: query: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the Seller when a resource is created. type: string required: - callback - id Error401_29: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_29' required: - code Error401Code_29: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_29: allOf: - $ref: '#/components/schemas/Error' - properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_29' required: - code type: object description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) Error500_29: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_16: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_16' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_30: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_16: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_30: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_35: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Product Order Notification API (productOrderNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": `https://buyer.mef.com/listenerEndpoint``, the product order state change event notification will be sent to: `https://buyer.mef.com/listenerEndpoint/mefApi/sonata/productOrderingNotification/v11/listener/productOrderStateChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = productOrderStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=productOrderStateChangeEvent,productOrderItemStateChangeEvent`. The possible values are enumerated by ''ProductOrderEventType'', `CancelProductOrderEventType` in productOrderNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_30: description: 'This resource is used to respond to notification subscriptions. ' type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of this Event Subscription assigned by the Seller when a resource is created. type: string query: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string required: - callback - id Error401_30: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_30' required: - code Error401Code_30: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_30: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_30' required: - code Error500_30: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_17: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_17' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_31: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_17: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_31: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_36: description: This class is used to register for Notifications. type: object properties: query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = quoteStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=quoteStateChangeEvent,quoteItemStateChangeEvent`. The possible values are enumerated by the ''QuoteEventType'' in quoteNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string callback: description: 'This callback value must be set to *host* property from Buyer Notification API (quoteNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.mef.com/listenerEndpoint", the state change event notification will be sent to: `http://buyer.mef.com/listenerEndpoint/mefApi/sonata/quoteNotification/v10/listener/quoteStateChangeEvent`' type: string required: - callback EventSubscription_31: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: id: description: Id of the listener type: string callback: description: The callback being registered. type: string query: description: additional data to be passed type: string required: - callback - id Error401_31: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_31' required: - code Error401Code_31: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_31: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_31' required: - code Error501_9: description: Not Implemented. (https://tools.ietf.org/html/rfc7231#section-6.6.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notImplemented: Method not supported by the server' type: string enum: - notImplemented required: - code Error500_31: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error422_18: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error_11' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_18' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_32: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_18: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_32: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error_11' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_37: description: "This class is used to register for Notifications. \n\n| API name | MEF 113 name | Description |\n| ---------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `troubleTicketAttributeValueChangeEvent` | TICKET_UPDATE | The Seller settable attributes for a Ticket were updated by the Seller. Note: Buyer initiated Ticket updates due to Patch operation will not trigger a `troubleTicketAttributeValueChangeEvent` |\n| `troubleTicketStatusChangeEvent` | TICKET_STATE_CHANGE | A Ticket `status` was changed by the Seller. |\n| `troubleTicketInformationRequiredEvent` | TICKET_INFO_REQUIRED | The Seller requires more information from the Buyer for a Ticket to continue processing a Ticket. The details on what information is needed from the Buyer will be provided via a Ticket `note`. The Ticket `status` is `pending`. Note: The Buyer uses the Patch operation to provide more information for a Ticket. |\n| `troubleTicketResolvedEvent` | TICKET_RESOLVED | The Seller is informing the Buyer the Ticket is resolved and the Buyer to verify that the Issue on which the Ticket was based is no longer observed. The Ticket `status` is `resolved`. Note: The Buyer confirms if the Issue has been resolved satisfactorily or not using close or reopen operations |\n| `incidentCreateEvent` | INCIDENT_CREATE | A new Incident was created by the Seller. |\n| `incidentAttributeValueChangeEvent` | INCIDENT_UPDATE | An open Incident was updated by the Seller. |\n| `incidentStatusChangeEvent` | INCIDENT_STATE_CHANGE | An Incident `status` was changed by the Seller. |\n" type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Notification API (troubleTicketNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.mef.com/listenerEndpoint", the state change event notification will be sent to: `http://buyer.mef.com/listenerEndpoint/mefApi/sonata/troubleTicketNotification/v2/listener/troubleTicketStatusChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = troubleTicketStatusChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=troubleTicketStatusChangeEvent,troubleTicketResolvedEvent`. The possible values are enumerated by the ''TroubleTicketEventType'' in troubleTicketNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_32: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of the event subscription assigned by the Seller when a resource is created. type: string query: description: This attribute is used to define notification registration constraints. type: string required: - callback - id Error401_32: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error_11' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_32' required: - code Error401Code_32: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_32: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error_11' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_32' required: - code Error500_32: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error_11' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code Error_11: description: 'Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. ' type: object properties: message: description: Text that provides mode details and corrective actions related to the error. This can be shown to a client user. type: string reason: description: Text that explains the reason the for error. This can be shown to a client user. type: string maxLength: 255 referenceError: description: URL pointing to documentation describing the error type: string format: uri required: - reason Error422_19: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code_19' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code_33: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code_19: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404_33: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code EventSubscriptionInput_38: description: This class is used to register for Notifications. type: object properties: callback: description: 'This callback value must be set to *host* property from Buyer Notification API (WorkOrderNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which notification is sent. E.g. for "callback": "http://buyer.mef.com/listenerEndpoint", the state change event notification will be sent to: `http://buyer.mef.com/listenerEndpoint/mefApi/sonata/workOrderNotification/v3/listener/workOrderStateChangeEvent`' type: string query: description: 'This attribute is used to define to which type of events to register to. Example: "query":"eventType = WorkOrderStateChangeEvent". To subscribe for more than one event type, put the values separated by comma: `eventType=WorkOrderStateChangeEvent,WorkOrderResolvedEvent`. The possible values are enumerated by the ''WorkOrderEventType'' in WorkOrderNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.' type: string required: - callback EventSubscription_33: description: Sets the communication endpoint address the service instance must use to deliver notification information type: object properties: callback: description: The value provided by the Buyer in `EventSubscriptionInput` during notification registration type: string id: description: An identifier of the event subscription assigned by the Seller when a resource is created. type: string query: description: This attribute is used to define notification registration constraints. type: string required: - callback - id Error401_33: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code_33' required: - code Error401Code_33: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials Error400_33: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code_33' required: - code Error500_33: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code x-refined-from: - mef-lso-allegro-alarm-management-openapi.yml - mef-lso-allegro-fault-management-openapi.yml - mef-lso-allegro-performance-monitoring-openapi.yml - mef-lso-allegro-service-function-test-openapi.yml - mef-lso-allegro-service-inventory-management-openapi.yml - mef-lso-allegro-service-ordering-management-openapi.yml - mef-lso-cantata-appointment-management-openapi.yml - mef-lso-cantata-billing-management-openapi.yml - mef-lso-cantata-circuit-impairment-and-maintenance-openapi.yml - mef-lso-cantata-geographic-address-management-openapi.yml - mef-lso-cantata-product-catalog-openapi.yml - mef-lso-cantata-product-offering-qualification-management-openapi.yml - mef-lso-cantata-product-order-management-openapi.yml - mef-lso-cantata-quote-management-openapi.yml - mef-lso-cantata-trouble-ticket-management-openapi.yml - mef-lso-cantata-workorder-management-openapi.yml - mef-lso-interlude-alarm-management-openapi.yml - mef-lso-interlude-fault-management-openapi.yml - mef-lso-interlude-performance-monitoring-openapi.yml - mef-lso-interlude-service-function-test-openapi.yml - mef-lso-interlude-service-inventory-management-openapi.yml - mef-lso-interlude-service-ordering-management-openapi.yml - mef-lso-legato-alarm-management-openapi.yml - mef-lso-legato-fault-management-openapi.yml - mef-lso-legato-performance-monitoring-openapi.yml - mef-lso-legato-service-function-test-openapi.yml - mef-lso-legato-service-inventory-management-openapi.yml - mef-lso-legato-service-ordering-management-openapi.yml - mef-lso-sonata-appointment-management-openapi.yml - mef-lso-sonata-billing-management-openapi.yml - mef-lso-sonata-circuit-impairment-and-maintenance-openapi.yml - mef-lso-sonata-geographic-address-management-openapi.yml - mef-lso-sonata-product-catalog-openapi.yml - mef-lso-sonata-product-offering-qualification-management-openapi.yml - mef-lso-sonata-product-order-management-openapi.yml - mef-lso-sonata-quote-management-openapi.yml - mef-lso-sonata-trouble-ticket-management-openapi.yml - mef-lso-sonata-workorder-management-openapi.yml