openapi: 3.0.1 info: title: Trouble Ticket and Incident Management description: | **This file forms part of Mplify 124.1** This API implements Business Requirements described in MEF 113 It allows the Buyer to create, retrieve, and update Trouble Tickets as well as receive notifications about Incidents' and Trouble Tickets' updates. This allows managing issues and situations that are not part of normal operations of the Product provided by the Seller. List of supported use cases: - Create Ticket - Retrieve Ticket List - Retrieve Ticket by Ticket Identifier - Patch Ticket by Ticket Identifier - Cancel Ticket by Ticket Identifier - Ticket Resolution Confirmation - Retrieve Incident List - Retrieve Incident by Incident Identifier - Register for Event Notifications Copyright 2025 Mplify Alliance and its contributors. This file includes content based on the TM Forum Trouble Ticket API (TMF621 v4.0.0) available at https://github.com/tmforum-apis/TMF621_TroubleTicket, which is licensed by the TM Forum under the Apache License version 2.0. Such content has been modified by the Mplify Alliance and its contributors. version: 5.0.0 servers: - url: 'https://{serverBase}/mefApi/sonata/troubleTicket/v5/' variables: serverBase: description: The base of Seller's URL. default: mplify.net tags: - name: troubleTicket - name: troubleTicket operations - name: incident - name: events subscription paths: /troubleTicket: get: tags: - troubleTicket summary: List or found Trouble Ticket objects description: > The Buyer requests a list of Trouble Tickets from the Seller based on a set of specified filter criteria. The Seller returns a summarized list of Trouble Tickets. operationId: listTroubleTicket parameters: - name: externalId in: query description: >- ID given by the consumer and only understandable by him (to facilitate his searches afterward) required: false schema: type: string - name: priority in: query description: >- The priority (ITIL) is based on the assessment of the impact and urgency of how quickly the Ticket should be resolved as evaluated by the Buyer. The Priority is used by the Seller to determine the order in which Tickets get resolved across Buyers. required: false schema: $ref: '#/components/schemas/TroubleTicketPriorityType' - name: sellerPriority in: query description: >- The priority (ITIL) is based on the assessment of the impact and urgency of how quickly the Ticket should be resolved after evaluation by the Seller of the impact of the Issue on the Buyer. required: false schema: $ref: '#/components/schemas/TroubleTicketPriorityType' - name: severity in: query description: >- The severity or impact (ITIL) of the Ticket as evaluated by the Buyer. required: false schema: $ref: '#/components/schemas/TroubleTicketSeverityType' - name: sellerSeverity in: query description: >- The severity or impact (ITIL) of the Ticket on the Buyer as evaluated by the Seller. required: false schema: $ref: '#/components/schemas/TroubleTicketSeverityType' - name: ticketType in: query description: The presumed cause of the Trouble Ticket as evaluated by the Buyer. required: false schema: $ref: '#/components/schemas/TroubleTicketType' - name: status in: query description: The current status of the Trouble Ticket required: false schema: $ref: '#/components/schemas/TroubleTicketStatusType' - name: observedImpact in: query description: The type of impact observed by the Buyer. required: false schema: $ref: '#/components/schemas/MEFObservedImpactType' - name: relatedEntityId in: query description: >- ID of a related entity that this ticket is related to and is present in the `relatedEntity` list required: false schema: type: string - name: relatedEntityType in: query description: >- Type of a related entity that this ticket is related to and is present in the `relatedEntity` list required: false schema: type: string default: Product - name: creationDate.gt in: query description: The date on which the Trouble Ticket was created - greater than required: false schema: type: string format: date-time - name: creationDate.lt in: query description: The date on which the Trouble Ticket was created - lower than required: false schema: type: string format: date-time - name: expectedResolutionDate.gt in: query description: >- The date provided by the Seller to indicate when the Ticket is expected to be resolved - greater than required: false schema: type: string format: date-time - name: expectedResolutionDate.lt in: query description: >- The date provided by the Seller to indicate when the Ticket is expected to be resolved - lower than required: false schema: type: string format: date-time - name: resolutionDate.gt in: query description: >- The date the Ticket status was set to resolved by the Seller - greater than required: false schema: type: string format: date-time - name: resolutionDate.lt in: query description: >- The date the Ticket status was set to resolved by the Seller - lower than required: false schema: type: string format: date-time - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string - name: offset in: query description: Requested index for start of resources to be provided in response required: false schema: type: integer - name: limit in: query description: Requested number of resources to be provided in response required: false schema: type: integer format: int32 responses: '200': description: 'OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)' headers: X-Pagination-Throttled: description: > Used to indicate that result page was throttled to maximum possible size and there are additional results that can be fetched schema: type: boolean X-Total-Count: description: > The total number of matching records. E.g. if there are 50 matching records in total, but the request has offset=10 and limit=10, then the X-Total-Count is 50. schema: type: integer X-Result-Count: description: The number of records included in the response schema: type: integer content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/TroubleTicket_Find' '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' '422': description: Unprocessable entity due to business validation problems content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/Error422' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' post: tags: - troubleTicket summary: Creates a TroubleTicket description: >- A request initiated by the Buyer to create a Ticket in the Seller's system to report an Issue experienced by the Buyer operationId: createTroubleTicket parameters: - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string requestBody: description: The TroubleTicket to be created content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/TroubleTicket_Create' required: true responses: '201': description: 'Created (https://tools.ietf.org/html/rfc7231#section-6.3.2)' content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/TroubleTicket' '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' '422': description: Unprocessable entity due to the business validation problems content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/Error422' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '/troubleTicket/{id}': get: tags: - troubleTicket summary: Retrieves a TroubleTicket by ID description: >- The Buyer requests detailed information about a single Ticket based on a Ticket Identifier. operationId: retrieveTroubleTicket parameters: - name: id in: path description: Identifier of the TroubleTicket required: true schema: type: string - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string responses: '200': description: 'OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)' content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/TroubleTicket' '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' patch: tags: - troubleTicket summary: Updates partially a TroubleTicket description: >- A request by the Buyer to patch a Ticket created by the Buyer in the Seller's system. operationId: patchTroubleTicket parameters: - name: id in: path description: Identifier of the TroubleTicket required: true schema: type: string - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string requestBody: description: The TroubleTicket to be updated content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/TroubleTicket_Update' required: true responses: '200': description: Updated content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/TroubleTicket' '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' '409': description: Conflict content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error409' '422': description: Unprocessable entity due to the business validation problems content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/Error422' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '/troubleTicket/{id}/cancel': post: tags: - troubleTicket operations summary: Cancels a Trouble Ticket description: This operation sends a cancellation request. operationId: cancelTroubleTicket parameters: - name: id in: path description: Identifier of the TroubleTicket required: true schema: type: string - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string responses: '204': description: Cancelled '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' '422': description: Unprocessable entity due to the business validation problems content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/Error422' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '/troubleTicket/{id}/close': post: tags: - troubleTicket operations summary: Closes a Trouble Ticket description: >- This operation allows the Buyer to send Ticket Resolution Confirmation by closing it operationId: closeTroubleTicket parameters: - name: id in: path description: Identifier of the TroubleTicket required: true schema: type: string - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string responses: '204': description: Closed '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' '422': description: Unprocessable entity due to the business validation problems content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/Error422' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '/troubleTicket/{id}/reopen': post: tags: - troubleTicket operations summary: Reopens a Trouble Ticket description: >- The operation allows the Buyer to send Ticket Resolution Confirmation by reopening it operationId: reopenTroubleTicket parameters: - name: id in: path description: Identifier of the TroubleTicket required: true schema: type: string - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string requestBody: description: >- Unstructured comment describing the reason the Buyer doesn't agree on the resolution and needs the Trouble Ticket to be reopened. If the Buyer wants this Closure Rejection Reason to be included in the Trouble Ticket Notes for historical reasons, the Buyer needs to patch the Trouble Ticket. content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Reason' required: true responses: '204': description: Reopened '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' '422': description: Unprocessable entity due to the business validation problems content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/Error422' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' /incident: get: tags: - incident summary: List or found Incident objects description: > The Buyer requests a list of Incidents from the Seller based on a set of specified filter criteria. The Seller returns a summarized list of Incidents. operationId: listIncident parameters: - name: priority in: query description: >- The priority (ITIL) is based on the assessment of the impact and urgency of how quickly the Incident should be resolved after evaluation by the Seller of the impact of the Incident. required: false schema: $ref: '#/components/schemas/TroubleTicketPriorityType' - name: severity in: query description: >- The severity or impact (ITIL) of the Incident as evaluated by the Seller. required: false schema: $ref: '#/components/schemas/TroubleTicketSeverityType' - name: impact in: query description: The type of impact observed by the Buyer. required: false schema: $ref: '#/components/schemas/MEFObservedImpactType' - name: incidentType in: query description: The presumed cause of the Incident as evaluated by the Seller. required: false schema: $ref: '#/components/schemas/IncidentType' - name: status in: query description: The current status of the Incident required: false schema: $ref: '#/components/schemas/IncidentStatusType' - name: relatedEntityId in: query description: >- ID of a related entity that this Incident is related to and is present in the `relatedEntity` list required: false schema: type: string - name: relatedEntityType in: query description: >- Type of a related entity that this Incident is related to and is present in the `relatedEntity` list required: false schema: type: string default: Product - name: creationDate.gt in: query description: The date on which the Incident was created - greater than required: false schema: type: string format: date-time - name: creationDate.lt in: query description: The date on which the Trouble Ticket was created - lower than required: false schema: type: string format: date-time - name: situationStartDate.gt in: query description: >- The date when the Incident was first identified, for example via error logs - greater than required: false schema: type: string format: date-time - name: situationStartDate.lt in: query description: >- The date when the Incident was first identified, for example via error logs - lower than required: false schema: type: string format: date-time - name: expectedClosedDate.gt in: query description: >- The date provided by the Seller to indicate when the Incident is expected to be closed - greater than required: false schema: type: string format: date-time - name: expectedClosedDate.lt in: query description: >- The date provided by the Seller to indicate when the Incident is expected to be closed - lower than required: false schema: type: string format: date-time - name: closedDate.gt in: query description: >- The date the Incident status was set to closed by the Seller - greater than required: false schema: type: string format: date-time - name: closedDate.lt in: query description: >- The date the Incident status was set to closed by the Seller - lower than required: false schema: type: string format: date-time - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string - name: offset in: query description: Requested index for start of resources to be provided in response required: false schema: type: integer - name: limit in: query description: Requested number of resources to be provided in response required: false schema: type: integer format: int32 responses: '200': description: 'OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)' headers: X-Pagination-Throttled: description: > Used to indicate that result page was throttled to maximum possible size and there are additional results that can be fetched schema: type: boolean X-Total-Count: description: > The total number of matching records. E.g. if there are 50 matching records in total, but the request has offset=10 and limit=10, then the X-Total-Count is 50. schema: type: integer X-Result-Count: description: The number of records included in the response schema: type: integer content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/Incident_Find' '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' '422': description: Unprocessable entity due to business validation problems content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/Error422' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '501': description: >- Method not implemented. Used in case Seller is not supporting Notification mechanism content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error501' '/incident/{id}': get: tags: - incident summary: Retrieves ac Incident by ID description: >- The Buyer requests detailed information about a single Incident based on a Incident Identifier. operationId: retrieveIncident parameters: - name: id in: path description: Identifier of the Incident required: true schema: type: string - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string responses: '200': description: 'OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)' content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Incident' '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. Used in case Seller is not supporting Notification mechanism content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error501' /hub: post: tags: - events subscription summary: >- Allows the Buyer to register to Trouble Ticket state change notifications description: The Buyer requests to subscribe to Ticket and Incident Notifications. operationId: registerListener parameters: - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string 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 (https://tools.ietf.org/html/rfc7231#section-6.3.2)' 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' '422': content: application/json;charset=utf-8: schema: items: $ref: '#/components/schemas/Error422' type: array description: Unprocessable entity due to the business validation problems '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '/hub/{id}': get: tags: - events subscription summary: Retrieves listener information description: This operation retrieves a hub entity. operationId: retrieveHub parameters: - name: id in: path description: Identifier of the Hub required: true schema: type: string - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false 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 requests to unsubscribe from Ticket and Incident Notifications operationId: unregisterListener parameters: - name: id in: path description: The id of the EventSubscription required: true schema: type: string - name: buyerId in: query description: >- The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. required: false schema: type: string - name: sellerId in: query description: >- The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. required: false schema: type: string responses: '204': description: 'Deleted (https://tools.ietf.org/html/rfc7231#section-6.3.5)' '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' components: schemas: AttachmentValue: description: >- Complements the description of an element (for instance a product) through video, pictures... type: object properties: author: description: The name of the person or organization who added the Attachment. type: string creationDate: description: The date the Attachment was added. type: string format: date-time description: description: A narrative text describing the content of the attachment type: string mimeType: description: >- Attachment mime type such as extension file for video, picture and document type: string name: description: The name of the attachment type: string size: description: The size of the attachment. $ref: '#/components/schemas/MEFByteSize' source: description: Indicates if the attachment was added by the Buyer or the Seller. $ref: '#/components/schemas/MEFBuyerSellerType' url: description: URL where the attachment is located. type: string required: - author - creationDate - name - source - url DataSizeUnit: description: The unit of measure in the data size. type: string enum: - BYTES - KBYTES - MBYTES - GBYTES - TBYTES - PBYTES - EBYTES - ZBYTES - YBYTES 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 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 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 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 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 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 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 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 Error409: description: 'Conflict (https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.8)' allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: >- The following error code: - conflict: The client has provided a value whose semantics are not appropriate for the property. type: string enum: - conflict required: - code 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: - missingProperty: The property the Seller has 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 Seller system - unexpectedProperty: Additional property, not expected by the Seller has been provided - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold. - otherIssue: Other problem was identified (detailed information provided in a reason) $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 Error422Code: description: | One of the following error codes: - missingProperty: The property the Seller has 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 Seller system - unexpectedProperty: Additional property, not expected by the Seller has been provided - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold. - otherIssue: Other problem was identified (detailed information provided in a reason) type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue 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 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 EventSubscription: 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 EventSubscriptionInput: description: | This class is used to register for Notifications. | API name | MEF 113 name | Description | | ---------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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` | | `troubleTicketStatusChangeEvent` | TICKET_STATE_CHANGE | A Ticket `status` was changed by the Seller. | | `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. | | `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 | | `incidentCreateEvent` | INCIDENT_CREATE | A new Incident was created by the Seller. | | `incidentAttributeValueChangeEvent` | INCIDENT_UPDATE | An open Incident was updated by the Seller. | | `incidentStatusChangeEvent` | INCIDENT_STATE_CHANGE | An Incident `status` was changed by the Seller. | 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 FieldedAddressRepresentation: description: >- A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example "street number" is one field, "street name" is another field, etc. type: object properties: streetNr: description: >- Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses. type: string streetNrSuffix: description: >- The first street number suffix (in a street number range) or the suffix for the street number if there is no range type: string streetNrLast: description: Last number in a range of street numbers allocated to an Address type: string streetNrLastSuffix: description: Last street number suffix for a ranged Address type: string streetPreDirection: description: The direction of the street that appears before the Street Name type: string streetName: description: Name of the street or other street type type: string streetType: description: >- The type of street (e.g., alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf) type: string streetPostDirection: description: >- A modifier denoting a relative direction that appears after the Street Name. type: string poBox: description: Number identifying a specific location in a post office. type: string locality: description: >- An area of defined or undefined boundaries within a local authority or other legislatively defined area. type: string city: description: City in which the Address is located. type: string postcode: description: >- A descriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code) type: string postcodeExtension: description: >- The extension used on a postal code. Note: there are different use codes for this attribute depending upon the country. type: string stateOrProvince: description: The State or Province in which the Address is located. type: string countryCode: description: >- Country in which the Address is located, defined using two characters as defined in ISO 3166 type: string minLength: 2 maxLength: 2 subUnit: description: >- The Sub Unit represented as a list. This is a list to allow complex sub-unit information such as SUITE 42 ROOM A type: array items: $ref: '#/components/schemas/SubUnit' buildingName: description: > The well-known name of a building that is located at this Address (e.g., where there is one Address for a campus). type: string privateStreetNumber: description: Street number on a private street within the Address. type: string privateStreetName: description: >- Private streets internal to a property (e.g., a university) may have internal names that are not recorded by the land title office. type: string language: description: >- The language in which the address is expressed. It MUST use the ISO 639:2023 two letter code 639:2023 type: string minLength: 2 maxLength: 2 Incident: description: > An Incident is a record of an issue that is not part of normal operation in the Seller's network that has a possible negative impact on the operability of the network on one or more Buyers. type: object properties: attachment: description: >- Attachments to the Incident, such as a file or screenshot. Attachments may be added but may not be modified or deleted (for historical reasons). type: array items: $ref: '#/components/schemas/AttachmentValue' closedDate: description: The date the Incident status was set to closed by the Seller type: string format: date-time creationDate: description: The date on which the Incident was created type: string format: date-time description: description: Description of the Incident type: string expectedClosedDate: description: >- The date provided by the Seller to indicate when the Incident is expected to be closed. type: string format: date-time href: description: 'Hyperlink, a reference to the Incident entity' type: string id: description: Unique (within the Seller domain) identifier for the Incident. type: string impact: description: The presumed impact on the Buyer for the referenced Product(s). $ref: '#/components/schemas/MEFObservedImpactType' incidentType: description: The presumed cause of the Incident as evaluated by the Seller. $ref: '#/components/schemas/IncidentType' note: description: >- A set of unstructured comments or information associated to the Incident. Notes may be added but may not be modified or deleted (for historical reasons). type: array items: $ref: '#/components/schemas/Note' priority: description: >- The priority (ITIL) is based on the assessment of the impact and urgency of how quickly the Incident should be resolved after evaluation by the Seller of the impact of the Incident. $ref: '#/components/schemas/TroubleTicketPriorityType' relatedContactInformation: description: >- Party playing a role in this Incident. The 'role' is to specify the type of contact as specified in MEF 113: Incident Contact ('role=incidentContact') - REQUIRED to be set by the Seller Incident Technical Contact ('role=incidentTechnicalContact') type: array minItems: 1 items: $ref: '#/components/schemas/RelatedContactInformation' relatedEntity: description: >- A set of identifiers of the Products on which the Incident could have an impact on the normal operation. type: array minItems: 1 items: $ref: '#/components/schemas/RelatedEntity' relatedIssue: description: >- A list of Related Issue relationships. Represents relationships to other Trouble Tickets and Incidents. type: array items: $ref: '#/components/schemas/IssueRelationship' severity: description: The severity (ITIL) of the Incident as evaluated by the Seller. $ref: '#/components/schemas/TroubleTicketSeverityType' situationStartDate: description: >- The date when the situation was first identified, for example via error logs. type: string format: date-time status: description: The current status of the Incident $ref: '#/components/schemas/IncidentStatusType' statusChange: description: >- The status change history that is associated to the Incident. Populated by the Seller. type: array minItems: 1 items: $ref: '#/components/schemas/IncidentStatusChange' required: - creationDate - description - id - impact - incidentType - priority - relatedContactInformation - relatedEntity - severity - situationStartDate - status - statusChange IncidentStatusChange: description: >- Holds the status notification reasons and associated date the status changed, populated by the server type: object properties: changeDate: description: The date and time the status changed. type: string format: date-time changeReason: description: The reason why the status changed. type: string status: description: Reached status $ref: '#/components/schemas/IncidentStatusType' IncidentStatusType: description: | Possible values for the status of the Incident | status | MEF 113 name | Description | | ------------ | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `closed` | CLOSED | The Situation described in the Incident was closed by has been resolved and normal operation has been restored on the Seller.Seller's network. This is a terminal state. | | `created` | CREATED | A new Incident has been created and allocated a unique `id`. | | `inProgress` | IN_PROGRESS | The Incident is in the process of being handled and investigated for resolution by the Seller. type: string enum: - closed - created - inProgress IncidentType: description: > Possible values for the type of the Incident: - maintenance: Any scheduled or non-scheduled maintenance related Incident. - repair: Any non-scheduled Situation requiring repair by the Seller. - installation: Any installation related Situation requiring action by the Seller. type: string enum: - maintenance - repair - installation Incident_Find: description: > This class represents a single list item for the response of `listIncident` operation. type: object properties: closedDate: description: The date the Incident status was set to closed by the Seller type: string format: date-time creationDate: description: The date on which the Incident was created type: string format: date-time description: description: Description of the Incident type: string expectedClosedDate: description: >- The date provided by the Seller to indicate when the Incident is expected to be closed. type: string format: date-time href: description: 'Hyperlink, a reference to the Incident entity' type: string id: description: Unique (within the Seller domain) identifier for the Incident. type: string impact: description: The type of impact observed by the Buyer. $ref: '#/components/schemas/MEFObservedImpactType' incidentType: description: The presumed cause of the Incident as evaluated by the Seller. $ref: '#/components/schemas/IncidentType' situationStartDate: description: >- The date when the Incident was first identified, for example via error logs. type: string format: date-time priority: description: >- The priority (ITIL) is based on the assessment of the impact and urgency of how quickly the Incident should be resolved after evaluation by the Seller of the impact of the Incident. $ref: '#/components/schemas/TroubleTicketPriorityType' relatedEntity: description: >- An entity that is related to the Incident such as a service, a product, etc. The entity which the Incident is associated with. type: array minItems: 1 items: $ref: '#/components/schemas/RelatedEntity' severity: description: >- The severity or impact (ITIL) of the Incident as evaluated by the Seller. $ref: '#/components/schemas/TroubleTicketSeverityType' status: description: The current status of the Incident $ref: '#/components/schemas/IncidentStatusType' required: - creationDate - description - id - impact - incidentType - priority - relatedEntity - severity - status IssueRelationship: description: Represents relationships to other Trouble Tickets and Incidents type: object properties: '@referredType': description: The type of the referred Issue (Incident or TroubleTicket) type: string creationDate: description: The date the relationship was created type: string format: date-time description: description: >- A description of the reason for the Relation Source to set the relationship type: string href: description: Reference of the Trouble Ticket or Incident type: string id: description: >- Unique identifier of the referenced Issue (Trouble Ticket od Incident) type: string relationshipType: description: >- Type of the Trouble Ticket relationship can be blocks, depends on, duplicates, causes, etc... type: string source: description: >- Indicates if this Related Issue was added by the Buyer or the Seller. $ref: '#/components/schemas/MEFBuyerSellerType' required: - '@referredType' - creationDate - description - id - relationshipType - source MEFBuyerSellerType: description: An enumeration with buyer and seller values. type: string enum: - buyer - seller MEFByteSize: description: A size represented by value and Byte units type: object properties: amount: description: Numeric value in a given unit type: number format: float units: description: Byte Unit $ref: '#/components/schemas/DataSizeUnit' required: - amount - units MEFObservedImpactType: description: >- An enumeration of the possible values of impact observed by the Buyer. - degraded: When the Product is impacted and not meeting the Product specifications. - intermittent: When the Product is not operational as intended on an intermittent basis. - down: When the Product is non-operational. type: string enum: - degraded - intermittent - down Note: description: >- Extra information about a given entity. Only useful in processes involving human interaction. Not applicable for an automated process. type: object properties: author: description: Author of the note type: string date: description: Date of the note type: string format: date-time id: description: >- Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation) type: string source: description: Indicates if this Note was added by the Buyer or Seller. $ref: '#/components/schemas/MEFBuyerSellerType' text: description: Text of the note type: string required: - author - date - id - source - text Reason: description: An object to convey a reason for the operation. type: object properties: reason: description: A text description of why given operation was requested. type: string required: - reason RelatedContactInformation: description: >- Contact data for a person or organization that is involved in the product offering qualification. In a given context it is always specified by the Seller (e.g. Seller Contact Information) or by the Buyer. type: object properties: role: description: A role of the particular contact in the request type: string number: description: Phone number type: string emailAddress: description: Email address type: string postalAddress: description: >- Identifies the postal address of the person or office to be contacted. $ref: '#/components/schemas/FieldedAddressRepresentation' organization: description: The organization or company that the contact belongs to type: string name: description: Name of the contact type: string numberExtension: description: Phone number extension type: string required: - emailAddress - name - number - role RelatedEntity: description: >- A reference to an entity, where the type of the entity is not known in advance. type: object properties: '@referredType': description: >- The actual type of the target instance when needed for disambiguation. type: string default: Product href: description: Reference of the related entity. type: string id: description: Unique identifier of a related entity. type: string role: description: The role of an entity. type: string required: - '@referredType' - id - role SubUnit: description: Allows for sub unit identification type: object properties: subUnitNumber: description: >- The discriminator used for the subunit, often just a simple number but may also be a range. type: string subUnitType: description: >- The type of subunit e.g. BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF. type: string required: - subUnitNumber - subUnitType TroubleTicket: allOf: - $ref: '#/components/schemas/TroubleTicket_Common' - description: >- A Trouble Ticket is a record of an issue that is created, tracked, and managed by a Trouble Ticket management system type: object properties: creationDate: description: The date on which the Trouble Ticket was created type: string format: date-time expectedResolutionDate: description: >- The date provided by the Seller to indicate when the Ticket is expected to be resolved type: string format: date-time href: description: 'Hyperlink, a reference to the Trouble Ticket entity' type: string id: description: >- Unique (within the Seller Ticket domain) identifier for the Ticket. type: string resolutionDate: description: The date the Ticket status was set to resolved by the Seller type: string format: date-time sellerPriority: description: >- The priority (ITIL) is based on the assessment of the impact and urgency of how quickly the Ticket should be resolved after evaluation by the Seller of the impact of the Issue on the Buyer. $ref: '#/components/schemas/TroubleTicketPriorityType' sellerSeverity: description: >- The severity or impact (ITIL) of the Issue on the Buyer as evaluated by the Seller. $ref: '#/components/schemas/TroubleTicketSeverityType' status: description: The current status of the Trouble Ticket $ref: '#/components/schemas/TroubleTicketStatusType' statusChange: description: >- The status change history that is associated to the ticket. Populated by the Seller. type: array minItems: 1 items: $ref: '#/components/schemas/TroubleTicketStatusChange' workOrder: description: >- A reference to a set of WorkOrders to be performed under the responsibility of Seller technician(s) to resolve the Ticket. type: array items: $ref: '#/components/schemas/WorkOrderRef' required: - creationDate - id - sellerPriority - sellerSeverity - status - statusChange TroubleTicketPriorityType: description: Possible values for the priority of the Trouble Ticket type: string enum: - low - medium - high - critical TroubleTicketSeverityType: description: Possible values for the severity of the Trouble Ticket type: string enum: - minor - moderate - significant - extensive TroubleTicketStatusChange: description: >- Holds the status notification reasons and associated date the status changed, populated by the server type: object properties: changeDate: description: The date and time the status changed. type: string format: date-time changeReason: description: The reason why the status changed. type: string status: description: Reached status $ref: '#/components/schemas/TroubleTicketStatusType' TroubleTicketStatusType: description: | Possible values for the status of the Trouble Ticket | status | MEF 113 name | Description | | ----------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `acknowledged` | ACKNOWLEDGED | A request to create a Ticket was received and accepted by the Seller. The Ticket create request has been validated and a Ticket has been created by the Seller and allocated a unique `id`. | | `assessingCancellation` | ASSESSING_CANCELLATION | A request has been made by the Buyer to cancel the Ticket and is being assessed by the Seller to determine whether to just close the Ticket, or continue to resolve the Issue to prevent similar Create Ticket requests from other Buyers. If the Seller chooses to resolve the Issue, the Seller might create an Incident or an internal Ticket for the Issue, but that is outside the scope of this document. After the Seller has completed the assessment, the Seller updates the Ticket State to `cancelled`. | | `cancelled` | CANCELLED | The Ticket has been successfully cancelled by the Buy-er. The Buyer will receive no further Event Notifications for the Ticket. This is a terminal state. | | `closed` | CLOSED | The Buyer has confirmed that the Issue they reported is no longer observed, or the pre-defined time frame (agreed upon between Buyer and Seller) for confirming that the Issue has been resolved has passed without a response by the Buyer. This is a terminal state. | | `inProgress` | IN_PROGRESS | The Ticket is in the process of being handled and investigated for resolution by the Seller. | | `pending` | PENDING | The Seller is waiting on the Buyer to provide additional information for the Ticket, or the Buyer to schedule an Appointment for the WorkOrder (linked to the Ticket) in order to continue processing the Ticket. This may result in the clock being stopped for the service level agreement until the Buyer has responded to the request. | | `reopened` | REOPENED | The Buyer has verified that the Issue described in the Ticket is still observed and has not been resolved satisfactorily. The Buyer rejects the Seller's request to close the Ticket. The Ticket has been reopened and is waiting for further actions from the Seller. | | `resolved` | RESOLVED | The Buyer's Issue described in the Ticket was resolved by the Seller. The Seller assumes that normal operation is re-established for the Buyer's product and i snow waiting for the Buyer to confirm that the Issue they reported is no longer observed. | type: string enum: - acknowledged - assessingCancellation - cancelled - closed - inProgress - pending - resolved - reopened TroubleTicketType: description: > Possible values for the type of the Trouble Ticket: - assistance: Requesting help for a situation (not a failure) requiring attention that is not categorized. - information: Buyer is requesting information on the Issue - installation: Related to installation issue. Provisioning is complete, but Product is not operational. - maintenance: Any scheduled or non-scheduled maintenance related Issue. type: string enum: - assistance - information - installation - maintenance TroubleTicket_Common: description: > A Trouble Ticket is a record of an issue that is created, tracked, and managed by a Trouble Ticket management system Skipped properties: id,href type: object properties: attachment: description: >- Attachments to the Ticket, such as a file, screenshot or embedded content. Attachments may be added but may not be modified or deleted (for historical reasons). type: array items: $ref: '#/components/schemas/AttachmentValue' description: description: Summarized description of the Issue the Buyer is experiencing. type: string externalId: description: >- Identifier provided by the Buyer to allow the Buyer to use as a search attribute in Retrieve Ticket List. type: string issueStartDate: description: >- The date indicating when the Buyer first observed the Issue, to provide the Seller with additional insight. type: string format: date-time note: description: >- A set of comments or information associated to the Ticket. This list can be empty. Notes may be added but may not be modified or deleted (for historical reasons). type: array items: $ref: '#/components/schemas/Note' observedImpact: description: The type of impact observed by the Buyer. $ref: '#/components/schemas/MEFObservedImpactType' priority: description: >- The priority (ITIL) is based on the assessment of the impact and urgency of how quickly the Ticket should be resolved as evaluated by the Buyer. The Priority is used by the Seller to determine the order in which Tickets get resolved across Buyers. $ref: '#/components/schemas/TroubleTicketPriorityType' relatedContactInformation: description: >- Party playing a role for this Trouble Ticket. The 'role' is to specify the type of contact as specified in MEF 113: Reporter Contact ('role=reporterContact') - REQUIRED in the request Buyer Technical Contacts ('role=buyerTechnicalContact') Seller Ticket Contact ('role=sellerTicketContact') Seller Technical Contact ('role=sellerTechnicalContact') type: array minItems: 1 items: $ref: '#/components/schemas/RelatedContactInformation' relatedEntity: description: >- An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated. type: array minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/RelatedEntity' relatedIssue: description: >- A list of Related Issue relationships. Represents relationships to other Trouble Tickets and Incidents. type: array items: $ref: '#/components/schemas/IssueRelationship' severity: description: >- The severity or impact (ITIL) of the Issue as evaluated by the Buyer. $ref: '#/components/schemas/TroubleTicketSeverityType' ticketType: description: The presumed cause of the Trouble Ticket as evaluated by the Buyer. $ref: '#/components/schemas/TroubleTicketType' required: - description - observedImpact - priority - relatedContactInformation - relatedEntity - severity - ticketType TroubleTicket_Create: description: >- A Trouble Ticket is a record of an issue that is created, tracked, and managed by a Trouble Ticket management system The modeling pattern introduces the `Common` supertype to aggregate attributes that are common to both `TroubleTicket` and `TroubleTicket_Create`. It this case the Create type has a subset of attributes of the response type and does not introduce any new, thus the `Create` type has an empty definition. allOf: - $ref: '#/components/schemas/TroubleTicket_Common' - type: object TroubleTicket_Find: description: > This class represents a single list item for the response of `listTroubleTicket` operation. type: object properties: creationDate: description: The date on which the Trouble Ticket was created type: string format: date-time description: description: Summarized description of the Issue the Buyer is experiencing. type: string expectedResolutionDate: description: >- The date provided by the Seller to indicate when the Ticket is expected to be resolved type: string format: date-time externalId: description: Additional identifier coming from an external system type: string id: description: Unique identifier of the Trouble Ticket type: string priority: description: >- The priority (ITIL) is based on the assessment of the impact and urgency of how quickly the Ticket should be resolved as evaluated by the Buyer. The Priority is used by the Seller to determine the order in which Tickets get resolved across Buyers. $ref: '#/components/schemas/TroubleTicketPriorityType' relatedEntity: description: >- An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated. type: array minItems: 1 items: $ref: '#/components/schemas/RelatedEntity' observedImpact: description: The type of impact observed by the Buyer. $ref: '#/components/schemas/MEFObservedImpactType' resolutionDate: description: The date the Ticket status was set to resolved by the Seller type: string format: date-time sellerPriority: description: >- The priority (ITIL) is based on the assessment of the impact and urgency of how quickly the Ticket should be resolved after evaluation by the Seller of the impact of the Issue on the Buyer. $ref: '#/components/schemas/TroubleTicketPriorityType' sellerSeverity: description: >- The severity or impact (ITIL) of the Ticket on the Buyer as evaluated by the Seller. $ref: '#/components/schemas/TroubleTicketSeverityType' severity: description: >- The severity or impact (ITIL) of the Ticket as evaluated by the Buyer. $ref: '#/components/schemas/TroubleTicketSeverityType' status: description: The current status of the Trouble Ticket $ref: '#/components/schemas/TroubleTicketStatusType' ticketType: description: The presumed cause of the Trouble Ticket as evaluated by the Buyer. $ref: '#/components/schemas/TroubleTicketType' required: - creationDate - description - expectedResolutionDate - externalId - id - observedImpact - priority - relatedEntity - resolutionDate - sellerPriority - sellerSeverity - severity - status - ticketType TroubleTicket_Update: description: >- A Trouble Ticket is a record of an issue that is created, tracked, and managed by a Trouble Ticket management system type: object properties: attachment: description: >- Attachments to the Ticket, such as a file, screen shot or embedded content. type: array items: $ref: '#/components/schemas/AttachmentValue' externalId: description: Additional identifier coming from an external system type: string issueStartDate: description: >- The date indicating when the Buyer first observed the Issue, to provide the Seller with additional insight. type: string format: date-time observedImpact: description: The type of impact observed by the Buyer. $ref: '#/components/schemas/MEFObservedImpactType' note: description: >- A set of comments or information associated to the Ticket. This list can be empty. Notes may be added but may not be modified or deleted (for historical reasons). type: array items: $ref: '#/components/schemas/Note' priority: description: >- The priority (ITIL) is based on the assessment of the impact and urgency of how quickly the Ticket should be resolved as evaluated by the Buyer. The Priority is used by the Seller to determine the order in which Tickets get resolved across Buyers. $ref: '#/components/schemas/TroubleTicketPriorityType' relatedContactInformation: description: >- Contact information for this Ticket. type: array items: $ref: '#/components/schemas/RelatedContactInformation' relatedIssue: description: >- A list of Related Issue relationships. Represents relationships to other Trouble Tickets and Incidents. type: array items: $ref: '#/components/schemas/IssueRelationship' severity: description: >- The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc... $ref: '#/components/schemas/TroubleTicketSeverityType' WorkOrderRef: description: | A reference to an WorkOrder resource. type: object properties: href: description: | Hyperlink to the referenced WorkOrder. type: string id: description: Identifier of the referenced WorkOrder. type: string required: - id