openapi: 3.0.1 info: title: Trouble Ticket description: "**TMF API Reference : TMF - 621 Trouble Ticket**\nThe Trouble Ticket API provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets as a result of an issue or problem identified by a customer or another system. \nExamples of Trouble Ticket API originators (clients) include CRM applications, network management or fault management systems, or other Trouble Ticket management systems (e.g. B2B).\nThe API supports the ability to send requests to create a new trouble ticket specifying the nature and severity of the trouble or issue as well as all necessary related information. The API also includes mechanisms to search for and update existing trouble tickets. Notifications are defined to provide information when a trouble ticket has been updated, including status changes. A basic set of states of a trouble ticket has been specified (as an example) to handle trouble ticket lifecycle management.\nTrouble Ticketing API manages trouble ticket resource:\n -\tA trouble ticket represents a record, or an issue raised by requestor that need to be solved, used for reporting and managing the resolution of problems, incidents or request \n -\tMain trouble ticket attributes are its description, severity, type, related dates (creation, expected resolution, resolution), state and related information (change reason and change date), related parties (originator, owner, reviser, etc.), related entities (product, product order, customer bill) and notes \n Trouble Ticket API performs the following operations on trouble ticket:\ \ \n -\tRetrieval of a trouble ticket or a collection of trouble ticket depending on filter criteria \n -\tPartial update of a trouble ticket \n -\tCreation of a trouble ticket \n \tNotification of events on trouble ticket: \n \t-\tTrouble ticket state change \n \t-\tTrouble ticket attribute value change \n \t-\tTrouble ticket resoled \n \t-\tTrouble ticket delete (typically restricted to admin role) \n \t-\tTrouble ticket created \n \t-\tTrouble ticket Information required \n Trouble Ticket API performs the following operations on trouble ticket specification \n-\tRetrieval of a trouble ticket specification or a collection of trouble ticket specification depending on filter criteria \n -\tPartial update of a trouble ticket specification \n-\tCreation of a trouble ticket specification\ \ \n-\tNotification of events on trouble ticket specification: \n \t-\tTrouble ticket specification state change \n \t-\tTrouble ticket specification attribute value change \n \t-\tTrouble ticket specification delete (typically restricted to admin role) \n \t-\tTrouble ticket specification created " version: 5.0.1 x-generation-tooling-version: v8.5.3-hotfix.0 x-generation-data-model-version: unknown servers: - url: '{apiRoot}/tmf-api/troubleTicket/v5/' variables: apiRoot: default: 'https://serverRoot' enum: - 'https://serverRoot' tags: - name: troubleTicket description: Operations for TroubleTicket Resource - name: troubleTicketSpecification description: Operations for TroubleTicketSpecification Resource - name: notification listener description: Notifications for Resource Lifecycle and event notifications - name: events subscription description: Endpoints to register and terminate an Event Listener paths: /hub: post: operationId: createHub summary: TM Forum Create a Subscription (hub) to Receive Events description: Sets the communication endpoint to receive Events. tags: - events subscription requestBody: $ref: '#/components/requestBodies/Hub_FVO' responses: '201': $ref: '#/components/responses/Hub' default: $ref: '#/components/responses/Error' '/hub/{id}': get: operationId: hubGet summary: TM Forum Retrieve a Subscription (hub) description: This operation retrieves the subscription to receive Events. tags: - events subscription parameters: - $ref: '#/components/parameters/Id' responses: '200': $ref: '#/components/responses/Hub' default: $ref: '#/components/responses/Error' delete: operationId: hubDelete summary: TM Forum Remove a Subscription (hub) to Receive Events description: This operation removes the subscription to receive Events. tags: - events subscription parameters: - $ref: '#/components/parameters/Id' responses: '204': description: Deleted default: $ref: '#/components/responses/Error' /listener/troubleTicketAttributeValueChangeEvent: post: tags: - notification listener summary: TM Forum Client Listener for Entity TroubleTicketAttributeValueChangeEvent description: >- Example of a client listener for receiving the notification TroubleTicketAttributeValueChangeEvent operationId: troubleTicketAttributeValueChangeEvent requestBody: $ref: '#/components/requestBodies/TroubleTicketAttributeValueChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/troubleTicketCreateEvent: post: tags: - notification listener summary: TM Forum Client Listener for Entity TroubleTicketCreateEvent description: Example of a client listener for receiving the notification TroubleTicketCreateEvent operationId: troubleTicketCreateEvent requestBody: $ref: '#/components/requestBodies/TroubleTicketCreateEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/troubleTicketDeleteEvent: post: tags: - notification listener summary: TM Forum Client Listener for Entity TroubleTicketDeleteEvent description: Example of a client listener for receiving the notification TroubleTicketDeleteEvent operationId: troubleTicketDeleteEvent requestBody: $ref: '#/components/requestBodies/TroubleTicketDeleteEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/troubleTicketInformationRequiredEvent: post: tags: - notification listener summary: TM Forum Client Listener for Entity TroubleTicketInformationRequiredEvent description: >- Example of a client listener for receiving the notification TroubleTicketInformationRequiredEvent operationId: troubleTicketInformationRequiredEvent requestBody: $ref: '#/components/requestBodies/TroubleTicketInformationRequiredEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/troubleTicketResolvedEvent: post: tags: - notification listener summary: TM Forum Client Listener for Entity TroubleTicketResolvedEvent description: Example of a client listener for receiving the notification TroubleTicketResolvedEvent operationId: troubleTicketResolvedEvent requestBody: $ref: '#/components/requestBodies/TroubleTicketResolvedEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/troubleTicketSpecificationAttributeValueChangeEvent: post: tags: - notification listener summary: TM Forum Client Listener for Entity TroubleTicketSpecificationAttributeValueChangeEvent description: >- Example of a client listener for receiving the notification TroubleTicketSpecificationAttributeValueChangeEvent operationId: troubleTicketSpecificationAttributeValueChangeEvent requestBody: $ref: '#/components/requestBodies/TroubleTicketSpecificationAttributeValueChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/troubleTicketSpecificationCreateEvent: post: tags: - notification listener summary: TM Forum Client Listener for Entity TroubleTicketSpecificationCreateEvent description: >- Example of a client listener for receiving the notification TroubleTicketSpecificationCreateEvent operationId: troubleTicketSpecificationCreateEvent requestBody: $ref: '#/components/requestBodies/TroubleTicketSpecificationCreateEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/troubleTicketSpecificationDeleteEvent: post: tags: - notification listener summary: TM Forum Client Listener for Entity TroubleTicketSpecificationDeleteEvent description: >- Example of a client listener for receiving the notification TroubleTicketSpecificationDeleteEvent operationId: troubleTicketSpecificationDeleteEvent requestBody: $ref: '#/components/requestBodies/TroubleTicketSpecificationDeleteEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/troubleTicketSpecificationStatusChangeEvent: post: tags: - notification listener summary: TM Forum Client Listener for Entity TroubleTicketSpecificationStatusChangeEvent description: >- Example of a client listener for receiving the notification TroubleTicketSpecificationStatusChangeEvent operationId: troubleTicketSpecificationStatusChangeEvent requestBody: $ref: '#/components/requestBodies/TroubleTicketSpecificationStatusChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/troubleTicketStatusChangeEvent: post: tags: - notification listener summary: TM Forum Client Listener for Entity TroubleTicketStatusChangeEvent description: Example of a client listener for receiving the notification TroubleTicketStatusChangeEvent operationId: troubleTicketStatusChangeEvent requestBody: $ref: '#/components/requestBodies/TroubleTicketStatusChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /troubleTicket: get: tags: - troubleTicket summary: TM Forum List or Find TroubleTicket Objects description: List or find TroubleTicket objects operationId: listTroubleTicket parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Before' - $ref: '#/components/parameters/After' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Filter' responses: '200': $ref: '#/components/responses/200TroubleTicketArray' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' post: tags: - troubleTicket summary: TM Forum Creates a TroubleTicket description: This operation creates a TroubleTicket entity. operationId: createTroubleTicket parameters: - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/TroubleTicket_FVO' responses: '201': $ref: '#/components/responses/201TroubleTicket' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' '/troubleTicket/{id}': get: tags: - troubleTicket summary: TM Forum Retrieves a TroubleTicket by ID description: >- This operation retrieves a TroubleTicket entity. Attribute selection enabled for all first level attributes. operationId: retrieveTroubleTicket parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' responses: '200': $ref: '#/components/responses/200TroubleTicket_Get' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' patch: tags: - troubleTicket summary: TM Forum Updates Partially a TroubleTicket description: This operation updates partially a TroubleTicket entity. operationId: patchTroubleTicket parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/TroubleTicket_MVO' responses: '200': $ref: '#/components/responses/200TroubleTicket_Patch' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' delete: tags: - troubleTicket summary: TM Forum Deletes a TroubleTicket description: This operation deletes a TroubleTicket entity. operationId: deleteTroubleTicket parameters: - $ref: '#/components/parameters/Id' responses: '202': $ref: '#/components/responses/202' '204': $ref: '#/components/responses/204' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' /troubleTicketSpecification: get: tags: - troubleTicketSpecification summary: TM Forum List or Find TroubleTicketSpecification Objects description: List or find TroubleTicketSpecification objects operationId: listTroubleTicketSpecification parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Before' - $ref: '#/components/parameters/After' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Filter' responses: '200': $ref: '#/components/responses/200TroubleTicketSpecificationArray' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' post: tags: - troubleTicketSpecification summary: TM Forum Creates a TroubleTicketSpecification description: This operation creates a TroubleTicketSpecification entity. operationId: createTroubleTicketSpecification parameters: - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/TroubleTicketSpecification_FVO' responses: '201': $ref: '#/components/responses/201TroubleTicketSpecification' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' '/troubleTicketSpecification/{id}': get: tags: - troubleTicketSpecification summary: TM Forum Retrieves a TroubleTicketSpecification by ID description: >- This operation retrieves a TroubleTicketSpecification entity. Attribute selection enabled for all first level attributes. operationId: retrieveTroubleTicketSpecification parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' responses: '200': $ref: '#/components/responses/200TroubleTicketSpecification_Get' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' patch: tags: - troubleTicketSpecification summary: TM Forum Updates Partially a TroubleTicketSpecification description: This operation updates partially a TroubleTicketSpecification entity. operationId: patchTroubleTicketSpecification parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/TroubleTicketSpecification_MVO' responses: '200': $ref: '#/components/responses/200TroubleTicketSpecification_Patch' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' delete: tags: - troubleTicketSpecification summary: TM Forum Deletes a TroubleTicketSpecification description: This operation deletes a TroubleTicketSpecification entity. operationId: deleteTroubleTicketSpecification parameters: - $ref: '#/components/parameters/Id' responses: '202': $ref: '#/components/responses/202' '204': $ref: '#/components/responses/204' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' components: schemas: Addressable: type: object description: Base schema for addressable entities properties: href: type: string description: Hyperlink reference id: type: string description: unique identifier Attachment: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Complements the description of an element (for instance a product) through video, pictures... properties: name: type: string description: The name of the attachment description: type: string description: A narrative text describing the content of the attachment example: Photograph of the Product url: type: string description: 'Uniform Resource Locator, is a web page address (a subset of URI)' example: 'https://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f' content: type: string format: base64 description: 'The actual contents of the attachment object, if embedded, encoded as base64' size: $ref: '#/components/schemas/Quantity' validFor: $ref: '#/components/schemas/TimePeriod' attachmentType: type: string description: >- a business characterization of the purpose of the attachment, for example logo, instructionManual, contractCopy mimeType: type: string description: a technical characterization of the attachment content format using IETF Mime Types discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment' AttachmentRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: >- Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures properties: description: type: string description: A narrative text describing the content of the attachment url: description: Link to the attachment media/content type: string discriminator: propertyName: '@type' mapping: AttachmentRef: '#/components/schemas/AttachmentRef' AttachmentRefOrValue: type: object description: >- The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself oneOf: - $ref: '#/components/schemas/Attachment' - $ref: '#/components/schemas/AttachmentRef' discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment' AttachmentRef: '#/components/schemas/AttachmentRef' AttachmentRefOrValue_FVO: type: object description: >- The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself oneOf: - $ref: '#/components/schemas/Attachment_FVO' - $ref: '#/components/schemas/AttachmentRef_FVO' discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment_FVO' AttachmentRef: '#/components/schemas/AttachmentRef_FVO' AttachmentRefOrValue_MVO: type: object description: >- The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself oneOf: - $ref: '#/components/schemas/Attachment_MVO' - $ref: '#/components/schemas/AttachmentRef_MVO' discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment_MVO' AttachmentRef: '#/components/schemas/AttachmentRef_MVO' AttachmentRef_FVO: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: >- Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures properties: description: type: string description: A narrative text describing the content of the attachment url: description: Link to the attachment media/content type: string discriminator: propertyName: '@type' mapping: AttachmentRef: '#/components/schemas/AttachmentRef_FVO' AttachmentRef_MVO: allOf: - $ref: '#/components/schemas/EntityRef_MVO' - type: object description: >- Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures properties: description: type: string description: A narrative text describing the content of the attachment url: description: Link to the attachment media/content type: string discriminator: propertyName: '@type' mapping: AttachmentRef: '#/components/schemas/AttachmentRef_MVO' Attachment_FVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Complements the description of an element (for instance a product) through video, pictures... properties: name: type: string description: The name of the attachment description: type: string description: A narrative text describing the content of the attachment example: Photograph of the Product url: type: string description: 'Uniform Resource Locator, is a web page address (a subset of URI)' example: 'https://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f' content: type: string format: base64 description: 'The actual contents of the attachment object, if embedded, encoded as base64' size: $ref: '#/components/schemas/Quantity' validFor: $ref: '#/components/schemas/TimePeriod' attachmentType: type: string description: >- a business characterization of the purpose of the attachment, for example logo, instructionManual, contractCopy mimeType: type: string description: a technical characterization of the attachment content format using IETF Mime Types required: - attachmentType - mimeType discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment_FVO' Attachment_MVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Complements the description of an element (for instance a product) through video, pictures... properties: name: type: string description: The name of the attachment description: type: string description: A narrative text describing the content of the attachment example: Photograph of the Product url: type: string description: 'Uniform Resource Locator, is a web page address (a subset of URI)' example: 'https://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f' content: type: string format: base64 description: 'The actual contents of the attachment object, if embedded, encoded as base64' size: $ref: '#/components/schemas/Quantity' validFor: $ref: '#/components/schemas/TimePeriod' attachmentType: type: string description: >- a business characterization of the purpose of the attachment, for example logo, instructionManual, contractCopy mimeType: type: string description: a technical characterization of the attachment content format using IETF Mime Types discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment_MVO' BaseEvent: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Base event with common attributes. properties: event: type: object description: The event linked to the involved resource object eventId: type: string description: The identifier of the notification. eventTime: type: string format: date-time description: Time of the event occurrence. eventType: type: string description: The type of the notification. correlationId: type: string description: The correlation id for this event. domain: type: string description: The domain of the event. title: type: string description: The title of the event. description: type: string description: An explanatory of the event. priority: type: string description: A priority. timeOcurred: type: string format: date-time description: The time the event occurred. discriminator: propertyName: '@type' mapping: BaseEvent: '#/components/schemas/BaseEvent' BooleanArrayCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is an array of Boolean(s). properties: value: type: array description: A characteristic which value is an array of Boolean(s). items: type: boolean description: Characteristic item boolean value BooleanArrayCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: A specification for a characteristic for which the value is an array booleans properties: value: type: array items: type: boolean description: Characteristic specification item boolean value BooleanArrayCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: A specification for a characteristic for which the value is an array booleans properties: value: type: array items: type: boolean description: Characteristic specification item boolean value BooleanArrayCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: A specification for a characteristic for which the value is an array booleans properties: value: type: array items: type: boolean description: Characteristic specification item boolean value BooleanArrayCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is an array of Boolean(s). properties: value: type: array description: A characteristic which value is an array of Boolean(s). items: type: boolean description: Characteristic item boolean value required: - value BooleanArrayCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is an array of Boolean(s). properties: value: type: array description: A characteristic which value is an array of Boolean(s). items: type: boolean description: Characteristic item boolean value BooleanCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is a Boolean. properties: value: type: boolean description: Value of the characteristic BooleanCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: A specification for a characteristic for which the value is a boolean properties: value: type: boolean description: Value of the characteristic BooleanCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: A specification for a characteristic for which the value is a boolean properties: value: type: boolean description: Value of the characteristic BooleanCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: A specification for a characteristic for which the value is a boolean properties: value: type: boolean description: Value of the characteristic BooleanCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is a Boolean. properties: value: type: boolean description: Value of the characteristic required: - value BooleanCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is a Boolean. properties: value: type: boolean description: Value of the characteristic ChannelRef: type: object description: >- The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc.. allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: ChannelRef: '#/components/schemas/ChannelRef' ChannelRef_FVO: type: object description: >- The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc.. allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: ChannelRef: '#/components/schemas/ChannelRef_FVO' ChannelRef_MVO: type: object description: >- The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc.. allOf: - $ref: '#/components/schemas/EntityRef_MVO' discriminator: propertyName: '@type' mapping: ChannelRef: '#/components/schemas/ChannelRef_MVO' Characteristic: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Describes a given characteristic of an object or entity through a name/value pair. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : StringCharacteristic, ObjectCharacteristic, FloatCharacteristic, BooleanCharacteristic, NumberCharacteristic, IntegerCharacteristic, StringArrayCharacteristic, ObjectArrayCharacteristic, BooleanArrayCharacteristic, NumberArrayCharacteristic, IntegerArrayCharacteristic... properties: id: type: string description: Unique identifier of the characteristic name: type: string description: Name of the characteristic valueType: type: string description: Data type of the value of the characteristic characteristicRelationship: type: array description: Collection of characteristic relationships items: $ref: '#/components/schemas/CharacteristicRelationship' discriminator: propertyName: '@type' mapping: BooleanArrayCharacteristic: '#/components/schemas/BooleanArrayCharacteristic' BooleanCharacteristic: '#/components/schemas/BooleanCharacteristic' Characteristic: '#/components/schemas/Characteristic' FloatCharacteristic: '#/components/schemas/FloatCharacteristic' IntegerArrayCharacteristic: '#/components/schemas/IntegerArrayCharacteristic' IntegerCharacteristic: '#/components/schemas/IntegerCharacteristic' NumberArrayCharacteristic: '#/components/schemas/NumberArrayCharacteristic' NumberCharacteristic: '#/components/schemas/NumberCharacteristic' ObjectArrayCharacteristic: '#/components/schemas/ObjectArrayCharacteristic' ObjectCharacteristic: '#/components/schemas/ObjectCharacteristic' StringArrayCharacteristic: '#/components/schemas/StringArrayCharacteristic' StringCharacteristic: '#/components/schemas/StringCharacteristic' CharacteristicRelationship: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Another Characteristic that is related to the current Characteristic; properties: id: type: string description: Unique identifier of the characteristic relationshipType: type: string description: The type of relationship discriminator: propertyName: '@type' mapping: CharacteristicRelationship: '#/components/schemas/CharacteristicRelationship' CharacteristicRelationship_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Another Characteristic that is related to the current Characteristic; properties: id: type: string description: Unique identifier of the characteristic relationshipType: type: string description: The type of relationship required: - id - relationshipType discriminator: propertyName: '@type' mapping: CharacteristicRelationship: '#/components/schemas/CharacteristicRelationship_FVO' CharacteristicRelationship_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Another Characteristic that is related to the current Characteristic; properties: id: type: string description: Unique identifier of the characteristic relationshipType: type: string description: The type of relationship discriminator: propertyName: '@type' mapping: CharacteristicRelationship: '#/components/schemas/CharacteristicRelationship_MVO' CharacteristicSpecification: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: This class defines a characteristic specification. properties: id: type: string description: Unique ID for the characteristic name: type: string description: >- A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications. valueType: type: string description: >- A kind of value that the characteristic can take on, such as numeric, text and so forth description: type: string description: A narrative that explains the CharacteristicSpecification. configurable: type: boolean description: 'If true, the Boolean indicates that the target Characteristic is configurable' validFor: $ref: '#/components/schemas/TimePeriod' minCardinality: type: integer description: >- The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality. maxCardinality: type: integer description: >- The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality. isUnique: type: boolean description: >- Specifies if the value of this characteristic is unique across all entities instantiated from the specification that uses this characteristic. For example, consider a ProductSpecification for a set-top box, with a CharacteristicSpecification cardID. Each set-top box must have a different value for cardID, so this isUnique attribute would be set to true for the characteristic. regex: type: string description: >- A rule or principle represented in regular expression used to derive the value of a characteristic value. extensible: type: boolean description: >- An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource. '@valueSchemaLocation': type: string description: This (optional) field provides a link to the schema describing the value type. charSpecRelationship: type: array items: $ref: '#/components/schemas/CharacteristicSpecificationRelationship' description: >- An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics. characteristicValueSpecification: type: array items: $ref: '#/components/schemas/CharacteristicValueSpecification' description: >- A CharacteristicValueSpecification object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a CharacteristicSpecification object. The values of the attributes in the CharacteristicValueSpecification object describe the values of the attributes that a corresponding Characteristic object can take on. discriminator: propertyName: '@type' mapping: CharacteristicSpecification: '#/components/schemas/CharacteristicSpecification' CharacteristicSpecificationRelationship: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic is embedded within the specification whose ID and href are in this entity, and identified by its ID. properties: relationshipType: type: string description: >- Type of relationship such as aggregation, migration, substitution, dependency, exclusivity name: type: string description: Name of the target characteristic within the specification characteristicSpecificationId: type: string description: Unique identifier of the characteristic within the specification parentSpecificationHref: type: string format: uri description: Hyperlink reference to the parent specification containing the target characteristic validFor: $ref: '#/components/schemas/TimePeriod' parentSpecificationId: type: string description: Unique identifier of the parent specification containing the target characteristic discriminator: propertyName: '@type' mapping: CharacteristicSpecificationRelationship: '#/components/schemas/CharacteristicSpecificationRelationship' CharacteristicSpecificationRelationship_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic is embedded within the specification whose ID and href are in this entity, and identified by its ID. properties: relationshipType: type: string description: >- Type of relationship such as aggregation, migration, substitution, dependency, exclusivity name: type: string description: Name of the target characteristic within the specification characteristicSpecificationId: type: string description: Unique identifier of the characteristic within the specification parentSpecificationHref: type: string format: uri description: Hyperlink reference to the parent specification containing the target characteristic validFor: $ref: '#/components/schemas/TimePeriod' parentSpecificationId: type: string description: Unique identifier of the parent specification containing the target characteristic required: - parentSpecificationId - name - relationshipType discriminator: propertyName: '@type' mapping: CharacteristicSpecificationRelationship: '#/components/schemas/CharacteristicSpecificationRelationship_FVO' CharacteristicSpecificationRelationship_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic is embedded within the specification whose ID and href are in this entity, and identified by its ID. properties: relationshipType: type: string description: >- Type of relationship such as aggregation, migration, substitution, dependency, exclusivity name: type: string description: Name of the target characteristic within the specification characteristicSpecificationId: type: string description: Unique identifier of the characteristic within the specification parentSpecificationHref: type: string format: uri description: Hyperlink reference to the parent specification containing the target characteristic validFor: $ref: '#/components/schemas/TimePeriod' parentSpecificationId: type: string description: Unique identifier of the parent specification containing the target characteristic discriminator: propertyName: '@type' mapping: CharacteristicSpecificationRelationship: '#/components/schemas/CharacteristicSpecificationRelationship_MVO' CharacteristicSpecification_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: This class defines a characteristic specification. properties: id: type: string description: Unique ID for the characteristic name: type: string description: >- A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications. valueType: type: string description: >- A kind of value that the characteristic can take on, such as numeric, text and so forth description: type: string description: A narrative that explains the CharacteristicSpecification. configurable: type: boolean description: 'If true, the Boolean indicates that the target Characteristic is configurable' validFor: $ref: '#/components/schemas/TimePeriod' minCardinality: type: integer description: >- The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality. maxCardinality: type: integer description: >- The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality. isUnique: type: boolean description: >- Specifies if the value of this characteristic is unique across all entities instantiated from the specification that uses this characteristic. For example, consider a ProductSpecification for a set-top box, with a CharacteristicSpecification cardID. Each set-top box must have a different value for cardID, so this isUnique attribute would be set to true for the characteristic. regex: type: string description: >- A rule or principle represented in regular expression used to derive the value of a characteristic value. extensible: type: boolean description: >- An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource. '@valueSchemaLocation': type: string description: This (optional) field provides a link to the schema describing the value type. charSpecRelationship: type: array items: $ref: '#/components/schemas/CharacteristicSpecificationRelationship_FVO' description: >- An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics. characteristicValueSpecification: type: array items: $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' description: >- A CharacteristicValueSpecification object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a CharacteristicSpecification object. The values of the attributes in the CharacteristicValueSpecification object describe the values of the attributes that a corresponding Characteristic object can take on. required: - name - valueType discriminator: propertyName: '@type' mapping: CharacteristicSpecification: '#/components/schemas/CharacteristicSpecification_FVO' CharacteristicSpecification_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: This class defines a characteristic specification. properties: id: type: string description: Unique ID for the characteristic name: type: string description: >- A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications. valueType: type: string description: >- A kind of value that the characteristic can take on, such as numeric, text and so forth description: type: string description: A narrative that explains the CharacteristicSpecification. configurable: type: boolean description: 'If true, the Boolean indicates that the target Characteristic is configurable' validFor: $ref: '#/components/schemas/TimePeriod' minCardinality: type: integer description: >- The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality. maxCardinality: type: integer description: >- The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality. isUnique: type: boolean description: >- Specifies if the value of this characteristic is unique across all entities instantiated from the specification that uses this characteristic. For example, consider a ProductSpecification for a set-top box, with a CharacteristicSpecification cardID. Each set-top box must have a different value for cardID, so this isUnique attribute would be set to true for the characteristic. regex: type: string description: >- A rule or principle represented in regular expression used to derive the value of a characteristic value. extensible: type: boolean description: >- An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource. '@valueSchemaLocation': type: string description: This (optional) field provides a link to the schema describing the value type. charSpecRelationship: type: array items: $ref: '#/components/schemas/CharacteristicSpecificationRelationship_MVO' description: >- An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics. characteristicValueSpecification: type: array items: $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' description: >- A CharacteristicValueSpecification object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a CharacteristicSpecification object. The values of the attributes in the CharacteristicValueSpecification object describe the values of the attributes that a corresponding Characteristic object can take on. discriminator: propertyName: '@type' mapping: CharacteristicSpecification: '#/components/schemas/CharacteristicSpecification_MVO' CharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- specification of a value (number or text or an object) that can be assigned to a Characteristic. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : BooleanArrayCharacteristicValueSpecification, BooleanCharacteristicValueSpecification, FloatArrayCharacteristicValueSpecification, FloatCharacteristicValueSpecification, IntegerArrayCharacteristicValueSpecification, IntegerCharacteristicValueSpecification, MapArrayCharacteristicValueSpecification, MapCharacteristicValueSpecification, NumberArrayCharacteristicValueSpecification, NumberCharacteristicValueSpecification, ObjectArrayCharacteristicValueSpecification, ObjectCharacteristicValueSpecification, StringArrayCharacteristicValueSpecification, StringCharacteristicValueSpecification... properties: valueType: type: string description: >- A kind of value that the characteristic value can take on, such as numeric, text and so forth isDefault: type: boolean description: >- If true, the Boolean Indicates if the value is the default value for a characteristic unitOfMeasure: type: string description: >- A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot. validFor: $ref: '#/components/schemas/TimePeriod' valueFrom: type: integer description: The low range value that a characteristic can take on valueTo: type: integer description: The upper range value that a characteristic can take on rangeInterval: type: string description: >- An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop". regex: type: string description: A regular expression constraint for given value discriminator: propertyName: '@type' mapping: BooleanArrayCharacteristicValueSpecification: '#/components/schemas/BooleanArrayCharacteristicValueSpecification' BooleanCharacteristicValueSpecification: '#/components/schemas/BooleanCharacteristicValueSpecification' CharacteristicValueSpecification: '#/components/schemas/CharacteristicValueSpecification' FloatArrayCharacteristicValueSpecification: '#/components/schemas/FloatArrayCharacteristicValueSpecification' FloatCharacteristicValueSpecification: '#/components/schemas/FloatCharacteristicValueSpecification' IntegerArrayCharacteristicValueSpecification: '#/components/schemas/IntegerArrayCharacteristicValueSpecification' IntegerCharacteristicValueSpecification: '#/components/schemas/IntegerCharacteristicValueSpecification' MapArrayCharacteristicValueSpecification: '#/components/schemas/MapArrayCharacteristicValueSpecification' MapCharacteristicValueSpecification: '#/components/schemas/MapCharacteristicValueSpecification' NumberArrayCharacteristicValueSpecification: '#/components/schemas/NumberArrayCharacteristicValueSpecification' NumberCharacteristicValueSpecification: '#/components/schemas/NumberCharacteristicValueSpecification' ObjectArrayCharacteristicValueSpecification: '#/components/schemas/ObjectArrayCharacteristicValueSpecification' ObjectCharacteristicValueSpecification: '#/components/schemas/ObjectCharacteristicValueSpecification' StringArrayCharacteristicValueSpecification: '#/components/schemas/StringArrayCharacteristicValueSpecification' StringCharacteristicValueSpecification: '#/components/schemas/StringCharacteristicValueSpecification' CharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- specification of a value (number or text or an object) that can be assigned to a Characteristic. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : BooleanArrayCharacteristicValueSpecification, BooleanCharacteristicValueSpecification, FloatArrayCharacteristicValueSpecification, FloatCharacteristicValueSpecification, IntegerArrayCharacteristicValueSpecification, IntegerCharacteristicValueSpecification, MapArrayCharacteristicValueSpecification, MapCharacteristicValueSpecification, NumberArrayCharacteristicValueSpecification, NumberCharacteristicValueSpecification, ObjectArrayCharacteristicValueSpecification, ObjectCharacteristicValueSpecification, StringArrayCharacteristicValueSpecification, StringCharacteristicValueSpecification... properties: valueType: type: string description: >- A kind of value that the characteristic value can take on, such as numeric, text and so forth isDefault: type: boolean description: >- If true, the Boolean Indicates if the value is the default value for a characteristic unitOfMeasure: type: string description: >- A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot. validFor: $ref: '#/components/schemas/TimePeriod' valueFrom: type: integer description: The low range value that a characteristic can take on valueTo: type: integer description: The upper range value that a characteristic can take on rangeInterval: type: string description: >- An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop". regex: type: string description: A regular expression constraint for given value discriminator: propertyName: '@type' mapping: BooleanArrayCharacteristicValueSpecification: '#/components/schemas/BooleanArrayCharacteristicValueSpecification_FVO' BooleanCharacteristicValueSpecification: '#/components/schemas/BooleanCharacteristicValueSpecification_FVO' CharacteristicValueSpecification: '#/components/schemas/CharacteristicValueSpecification_FVO' FloatArrayCharacteristicValueSpecification: '#/components/schemas/FloatArrayCharacteristicValueSpecification_FVO' FloatCharacteristicValueSpecification: '#/components/schemas/FloatCharacteristicValueSpecification_FVO' IntegerArrayCharacteristicValueSpecification: '#/components/schemas/IntegerArrayCharacteristicValueSpecification_FVO' IntegerCharacteristicValueSpecification: '#/components/schemas/IntegerCharacteristicValueSpecification_FVO' MapArrayCharacteristicValueSpecification: '#/components/schemas/MapArrayCharacteristicValueSpecification_FVO' MapCharacteristicValueSpecification: '#/components/schemas/MapCharacteristicValueSpecification_FVO' NumberArrayCharacteristicValueSpecification: '#/components/schemas/NumberArrayCharacteristicValueSpecification_FVO' NumberCharacteristicValueSpecification: '#/components/schemas/NumberCharacteristicValueSpecification_FVO' ObjectArrayCharacteristicValueSpecification: '#/components/schemas/ObjectArrayCharacteristicValueSpecification_FVO' ObjectCharacteristicValueSpecification: '#/components/schemas/ObjectCharacteristicValueSpecification_FVO' StringArrayCharacteristicValueSpecification: '#/components/schemas/StringArrayCharacteristicValueSpecification_FVO' StringCharacteristicValueSpecification: '#/components/schemas/StringCharacteristicValueSpecification_FVO' CharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- specification of a value (number or text or an object) that can be assigned to a Characteristic. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : BooleanArrayCharacteristicValueSpecification, BooleanCharacteristicValueSpecification, FloatArrayCharacteristicValueSpecification, FloatCharacteristicValueSpecification, IntegerArrayCharacteristicValueSpecification, IntegerCharacteristicValueSpecification, MapArrayCharacteristicValueSpecification, MapCharacteristicValueSpecification, NumberArrayCharacteristicValueSpecification, NumberCharacteristicValueSpecification, ObjectArrayCharacteristicValueSpecification, ObjectCharacteristicValueSpecification, StringArrayCharacteristicValueSpecification, StringCharacteristicValueSpecification... properties: valueType: type: string description: >- A kind of value that the characteristic value can take on, such as numeric, text and so forth isDefault: type: boolean description: >- If true, the Boolean Indicates if the value is the default value for a characteristic unitOfMeasure: type: string description: >- A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot. validFor: $ref: '#/components/schemas/TimePeriod' valueFrom: type: integer description: The low range value that a characteristic can take on valueTo: type: integer description: The upper range value that a characteristic can take on rangeInterval: type: string description: >- An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop". regex: type: string description: A regular expression constraint for given value discriminator: propertyName: '@type' mapping: BooleanArrayCharacteristicValueSpecification: '#/components/schemas/BooleanArrayCharacteristicValueSpecification_MVO' BooleanCharacteristicValueSpecification: '#/components/schemas/BooleanCharacteristicValueSpecification_MVO' CharacteristicValueSpecification: '#/components/schemas/CharacteristicValueSpecification_MVO' FloatArrayCharacteristicValueSpecification: '#/components/schemas/FloatArrayCharacteristicValueSpecification_MVO' FloatCharacteristicValueSpecification: '#/components/schemas/FloatCharacteristicValueSpecification_MVO' IntegerArrayCharacteristicValueSpecification: '#/components/schemas/IntegerArrayCharacteristicValueSpecification_MVO' IntegerCharacteristicValueSpecification: '#/components/schemas/IntegerCharacteristicValueSpecification_MVO' MapArrayCharacteristicValueSpecification: '#/components/schemas/MapArrayCharacteristicValueSpecification_MVO' MapCharacteristicValueSpecification: '#/components/schemas/MapCharacteristicValueSpecification_MVO' NumberArrayCharacteristicValueSpecification: '#/components/schemas/NumberArrayCharacteristicValueSpecification_MVO' NumberCharacteristicValueSpecification: '#/components/schemas/NumberCharacteristicValueSpecification_MVO' ObjectArrayCharacteristicValueSpecification: '#/components/schemas/ObjectArrayCharacteristicValueSpecification_MVO' ObjectCharacteristicValueSpecification: '#/components/schemas/ObjectCharacteristicValueSpecification_MVO' StringArrayCharacteristicValueSpecification: '#/components/schemas/StringArrayCharacteristicValueSpecification_MVO' StringCharacteristicValueSpecification: '#/components/schemas/StringCharacteristicValueSpecification_MVO' Characteristic_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Describes a given characteristic of an object or entity through a name/value pair. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : StringCharacteristic, ObjectCharacteristic, FloatCharacteristic, BooleanCharacteristic, NumberCharacteristic, IntegerCharacteristic, StringArrayCharacteristic, ObjectArrayCharacteristic, BooleanArrayCharacteristic, NumberArrayCharacteristic, IntegerArrayCharacteristic... properties: id: type: string description: Unique identifier of the characteristic name: type: string description: Name of the characteristic valueType: type: string description: Data type of the value of the characteristic characteristicRelationship: type: array description: Collection of characteristic relationships items: $ref: '#/components/schemas/CharacteristicRelationship_FVO' required: - name discriminator: propertyName: '@type' mapping: BooleanArrayCharacteristic: '#/components/schemas/BooleanArrayCharacteristic_FVO' BooleanCharacteristic: '#/components/schemas/BooleanCharacteristic_FVO' Characteristic: '#/components/schemas/Characteristic_FVO' FloatCharacteristic: '#/components/schemas/FloatCharacteristic_FVO' IntegerArrayCharacteristic: '#/components/schemas/IntegerArrayCharacteristic_FVO' IntegerCharacteristic: '#/components/schemas/IntegerCharacteristic_FVO' NumberArrayCharacteristic: '#/components/schemas/NumberArrayCharacteristic_FVO' NumberCharacteristic: '#/components/schemas/NumberCharacteristic_FVO' ObjectArrayCharacteristic: '#/components/schemas/ObjectArrayCharacteristic_FVO' ObjectCharacteristic: '#/components/schemas/ObjectCharacteristic_FVO' StringArrayCharacteristic: '#/components/schemas/StringArrayCharacteristic_FVO' StringCharacteristic: '#/components/schemas/StringCharacteristic_FVO' Characteristic_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Describes a given characteristic of an object or entity through a name/value pair. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : StringCharacteristic, ObjectCharacteristic, FloatCharacteristic, BooleanCharacteristic, NumberCharacteristic, IntegerCharacteristic, StringArrayCharacteristic, ObjectArrayCharacteristic, BooleanArrayCharacteristic, NumberArrayCharacteristic, IntegerArrayCharacteristic... properties: id: type: string description: Unique identifier of the characteristic name: type: string description: Name of the characteristic valueType: type: string description: Data type of the value of the characteristic characteristicRelationship: type: array description: Collection of characteristic relationships items: $ref: '#/components/schemas/CharacteristicRelationship_MVO' discriminator: propertyName: '@type' mapping: BooleanArrayCharacteristic: '#/components/schemas/BooleanArrayCharacteristic_MVO' BooleanCharacteristic: '#/components/schemas/BooleanCharacteristic_MVO' Characteristic: '#/components/schemas/Characteristic_MVO' FloatCharacteristic: '#/components/schemas/FloatCharacteristic_MVO' IntegerArrayCharacteristic: '#/components/schemas/IntegerArrayCharacteristic_MVO' IntegerCharacteristic: '#/components/schemas/IntegerCharacteristic_MVO' NumberArrayCharacteristic: '#/components/schemas/NumberArrayCharacteristic_MVO' NumberCharacteristic: '#/components/schemas/NumberCharacteristic_MVO' ObjectArrayCharacteristic: '#/components/schemas/ObjectArrayCharacteristic_MVO' ObjectCharacteristic: '#/components/schemas/ObjectCharacteristic_MVO' StringArrayCharacteristic: '#/components/schemas/StringArrayCharacteristic_MVO' StringCharacteristic: '#/components/schemas/StringCharacteristic_MVO' ContactMedium: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Indicates the contact medium that could be used to contact the party. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : EmailContactMedium, FaxContactMedium, PhoneContactMedium, GeographicAddressContactMedium, SocialMediaContactMedium... properties: id: type: string description: Identifier for this contact medium. preferred: type: boolean description: 'If true, indicates that is the preferred contact medium' contactType: type: string description: >- Type of the contact medium to qualify it like pro email / personal email. This is not used to define the contact medium used. validFor: $ref: '#/components/schemas/TimePeriod' discriminator: propertyName: '@type' mapping: ContactMedium: '#/components/schemas/ContactMedium' EmailContactMedium: '#/components/schemas/EmailContactMedium' FaxContactMedium: '#/components/schemas/FaxContactMedium' GeographicAddressContactMedium: '#/components/schemas/GeographicAddressContactMedium' PhoneContactMedium: '#/components/schemas/PhoneContactMedium' EmailContactMedium: allOf: - $ref: '#/components/schemas/ContactMedium' - type: object description: >- Describes an email that could be used to contact a party (an individual or an organization) properties: emailAddress: type: string description: Full email address in standard format Entity: type: object description: Base entity schema for use in TMForum Open-APIs. Property. allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' EntityRef: allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' - type: object description: Entity reference schema to be use for all entityRef class. properties: id: type: string description: The identifier of the referred entity. href: type: string description: The URI of the referred entity. name: type: string description: Name of the referred entity. '@referredType': type: string description: The actual type of the target instance when needed for disambiguation. required: - id EntityRef_MVO: allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' - type: object description: Entity reference schema to be use for all entityRef class. properties: id: type: string description: The identifier of the referred entity. href: type: string description: The URI of the referred entity. name: type: string description: Name of the referred entity. '@referredType': type: string description: The actual type of the target instance when needed for disambiguation. Event: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: event with common attributes. properties: href: type: string description: Hyperlink reference id: type: string description: unique identifier correlationId: type: string description: The correlation id for this event. domain: type: string description: The domain of the event. title: type: string description: The title of the event. description: type: string description: An explanation of the event. priority: type: string description: A priority. timeOccurred: type: string format: date-time description: The time the event occurred. source: $ref: '#/components/schemas/EntityRef' reportingSystem: $ref: '#/components/schemas/EntityRef' relatedParty: type: array description: Collection of related parties items: $ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef' analyticCharacteristic: type: array description: Collection of analytic characteristics items: $ref: '#/components/schemas/Characteristic' eventId: type: string description: The identifier of the notification. eventTime: type: string format: date-time description: Time of the event occurrence. eventType: type: string description: The type of the notification. event: description: The event linked to the involved resource object type: object Extensible: type: object description: >- Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type properties: '@type': type: string description: 'When sub-classing, this defines the sub-class Extensible name' '@baseType': type: string description: 'When sub-classing, this defines the super-class' '@schemaLocation': type: string description: A URI to a JSON-Schema file that defines additional attributes and relationships required: - '@type' ExternalIdentifier: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list. properties: owner: type: string description: Name of the external system that owns the entity. example: MagentoCommerce externalIdentifierType: type: string description: >- Type of the identification, typically would be the type of the entity within the external system example: ProductOrder id: type: string description: identification of the entity within the external system. discriminator: propertyName: '@type' mapping: ExternalIdentifier: '#/components/schemas/ExternalIdentifier' ExternalIdentifier_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list. properties: owner: type: string description: Name of the external system that owns the entity. example: MagentoCommerce externalIdentifierType: type: string description: >- Type of the identification, typically would be the type of the entity within the external system example: ProductOrder id: type: string description: identification of the entity within the external system. required: - id discriminator: propertyName: '@type' mapping: ExternalIdentifier: '#/components/schemas/ExternalIdentifier_FVO' ExternalIdentifier_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list. properties: owner: type: string description: Name of the external system that owns the entity. example: MagentoCommerce externalIdentifierType: type: string description: >- Type of the identification, typically would be the type of the entity within the external system example: ProductOrder id: type: string description: identification of the entity within the external system. discriminator: propertyName: '@type' mapping: ExternalIdentifier: '#/components/schemas/ExternalIdentifier_MVO' FaxContactMedium: allOf: - $ref: '#/components/schemas/ContactMedium' - type: object description: Describes a fax that could be used to contact a party (an individual or an organization) properties: faxNumber: type: string description: The fax number of the contact FloatArrayCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: >- A specification for a characteristic for which the value is a number array of format floating point properties: value: type: array items: type: number format: float description: Characteristic value FloatArrayCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: >- A specification for a characteristic for which the value is a number array of format floating point properties: value: type: array items: type: number format: float description: Characteristic value FloatArrayCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: >- A specification for a characteristic for which the value is a number array of format floating point properties: value: type: array items: type: number format: float description: Characteristic value FloatCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is a Float. properties: value: type: number format: float description: Value of the characteristic FloatCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: A specification for a characteristic for which the value is a floating point number properties: value: type: number format: float description: Value of the characteristic FloatCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: A specification for a characteristic for which the value is a floating point number properties: value: type: number format: float description: Value of the characteristic FloatCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: A specification for a characteristic for which the value is a floating point number properties: value: type: number format: float description: Value of the characteristic FloatCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is a Float. properties: value: type: number format: float description: Value of the characteristic required: - value FloatCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is a Float. properties: value: type: number format: float description: Value of the characteristic GeographicAddressContactMedium: allOf: - $ref: '#/components/schemas/ContactMedium' - type: object description: >- Describes a geographical address that could be used to contact a party (an individual or an organization) properties: city: type: string description: The city country: type: string description: The country postCode: type: string description: Postcode stateOrProvince: type: string description: State or province street1: type: string description: Describes the street street2: type: string description: Complementary street description geographicAddress: $ref: '#/components/schemas/GeographicAddressRef' GeographicAddressRef: type: object description: Reference to a Geographic Address. allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: GeographicAddressRef: '#/components/schemas/GeographicAddressRef' IntegerArrayCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is an array of Integer(s). properties: value: type: array description: A characteristic which value is an array of Integer(s). items: type: integer description: Characteristic value IntegerArrayCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: >- A specification for a characteristic for which the value is a number array of format integer properties: value: type: array items: type: integer description: Characteristic value IntegerArrayCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: >- A specification for a characteristic for which the value is a number array of format integer properties: value: type: array items: type: integer description: Characteristic value IntegerArrayCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: >- A specification for a characteristic for which the value is a number array of format integer properties: value: type: array items: type: integer description: Characteristic value IntegerArrayCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is an array of Integer(s). properties: value: type: array description: A characteristic which value is an array of Integer(s). items: type: integer description: Characteristic value required: - value IntegerArrayCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is an array of Integer(s). properties: value: type: array description: A characteristic which value is an array of Integer(s). items: type: integer description: Characteristic value IntegerCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is a Integer. properties: value: type: integer description: Value of the characteristic IntegerCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: A specification for a characteristic for which the value is an integer number properties: value: type: integer description: Value of the characteristic IntegerCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: A specification for a characteristic for which the value is an integer number properties: value: type: integer description: Value of the characteristic IntegerCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: A specification for a characteristic for which the value is an integer number properties: value: type: integer description: Value of the characteristic IntegerCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is a Integer. properties: value: type: integer description: Value of the characteristic required: - value IntegerCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is a Integer. properties: value: type: integer description: Value of the characteristic JsonPatch: type: object description: A JSONPatch document as defined by RFC 6902 required: - op - path properties: op: type: string description: The operation to be performed enum: - add - remove - replace - move - copy - test path: type: string description: A JSON-Pointer value: description: The value to be used within the operations. from: type: string description: A string containing a JSON Pointer value. MapArrayCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: A specification for a characteristic for which the value is an array of mapped objects properties: value: type: array items: type: object properties: value: type: object additionalProperties: type: object MapArrayCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: A specification for a characteristic for which the value is an array of mapped objects properties: value: type: array items: type: object properties: value: type: object additionalProperties: type: object MapArrayCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: A specification for a characteristic for which the value is an array of mapped objects properties: value: type: array items: type: object properties: value: type: object additionalProperties: type: object MapCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: A specification for a characteristic for which the value is a mapped object properties: value: type: object additionalProperties: type: object description: Value of the characteristic MapCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: A specification for a characteristic for which the value is a mapped object properties: value: type: object additionalProperties: type: object description: Value of the characteristic MapCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: A specification for a characteristic for which the value is a mapped object properties: value: type: object additionalProperties: type: object description: Value of the characteristic Note: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Extra information about a given entity properties: id: type: string description: Identifier of the note within its containing entity example: afa9-3d90aaa8da0f author: type: string description: Author of the note example: Mr. N. Bene date: type: string format: date-time description: Date of the note example: '2020-11-20T08:00:00Z' text: type: string description: Text of the note example: This is important discriminator: propertyName: '@type' mapping: Note: '#/components/schemas/Note' Note_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Extra information about a given entity properties: id: type: string description: Identifier of the note within its containing entity example: afa9-3d90aaa8da0f author: type: string description: Author of the note example: Mr. N. Bene date: type: string format: date-time description: Date of the note example: '2020-11-20T08:00:00Z' text: type: string description: Text of the note example: This is important discriminator: propertyName: '@type' mapping: Note: '#/components/schemas/Note_FVO' Note_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Extra information about a given entity properties: id: type: string description: Identifier of the note within its containing entity example: afa9-3d90aaa8da0f author: type: string description: Author of the note example: Mr. N. Bene date: type: string format: date-time description: Date of the note example: '2020-11-20T08:00:00Z' text: type: string description: Text of the note example: This is important discriminator: propertyName: '@type' mapping: Note: '#/components/schemas/Note_MVO' NumberArrayCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is an array of Number(s). properties: value: type: array description: A characteristic which value is an array of Number(s). items: type: number description: Characteristic value NumberArrayCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: >- A specification for a characteristic for which the value is a number array with no specific format properties: value: type: array items: type: number description: Characteristic value NumberArrayCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: >- A specification for a characteristic for which the value is a number array with no specific format properties: value: type: array items: type: number description: Characteristic value NumberArrayCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: >- A specification for a characteristic for which the value is a number array with no specific format properties: value: type: array items: type: number description: Characteristic value NumberArrayCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is an array of Number(s). properties: value: type: array description: A characteristic which value is an array of Number(s). items: type: number description: Characteristic value required: - value NumberArrayCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is an array of Number(s). properties: value: type: array description: A characteristic which value is an array of Number(s). items: type: number description: Characteristic value NumberCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is a Number. properties: value: type: number description: Value of the characteristic NumberCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: >- A specification for a characteristic for which the value is a number of no specific format properties: value: type: number description: Value of the characteristic NumberCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: >- A specification for a characteristic for which the value is a number of no specific format properties: value: type: number description: Value of the characteristic NumberCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: >- A specification for a characteristic for which the value is a number of no specific format properties: value: type: number description: Value of the characteristic NumberCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is a Number. properties: value: type: number description: Value of the characteristic required: - value NumberCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is a Number. properties: value: type: number description: Value of the characteristic ObjectArrayCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is an array of Object(s). properties: value: type: array description: Collection of characteristic values items: type: object description: Characteristic value ObjectArrayCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: A specification for a characteristic for which the value is an array of objects properties: value: type: array description: Collection of characteristic values items: type: object description: Characteristic value ObjectArrayCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: A specification for a characteristic for which the value is an array of objects properties: value: type: array description: Collection of characteristic values items: type: object description: Characteristic value ObjectArrayCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: A specification for a characteristic for which the value is an array of objects properties: value: type: array description: Collection of characteristic values items: type: object description: Characteristic value ObjectArrayCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is an array of Object(s). properties: value: type: array description: Collection of characteristic values items: type: object description: Characteristic value required: - value ObjectArrayCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is an array of Object(s). properties: value: type: array description: Collection of characteristic values items: type: object description: Characteristic value ObjectCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is a Object. properties: value: type: object description: Value of the characteristic ObjectCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: A specification for a characteristic for which the value is any object properties: value: type: object description: Value of the characteristic ObjectCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: A specification for a characteristic for which the value is any object properties: value: type: object description: Value of the characteristic ObjectCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: A specification for a characteristic for which the value is any object properties: value: type: object description: Value of the characteristic ObjectCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is a Object. properties: value: type: object description: Value of the characteristic required: - value ObjectCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is a Object. properties: value: type: object description: Value of the characteristic PartyRef: type: object description: A Party reference allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef' PartyRefOrPartyRoleRef: type: object description: '' oneOf: - $ref: '#/components/schemas/PartyRef' - $ref: '#/components/schemas/PartyRoleRef' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef' PartyRoleRef: '#/components/schemas/PartyRoleRef' PartyRefOrPartyRoleRef_FVO: type: object description: '' oneOf: - $ref: '#/components/schemas/PartyRef_FVO' - $ref: '#/components/schemas/PartyRoleRef_FVO' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef_FVO' PartyRoleRef: '#/components/schemas/PartyRoleRef_FVO' PartyRefOrPartyRoleRef_MVO: type: object description: '' oneOf: - $ref: '#/components/schemas/PartyRef_MVO' - $ref: '#/components/schemas/PartyRoleRef_MVO' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef_MVO' PartyRoleRef: '#/components/schemas/PartyRoleRef_MVO' PartyRef_FVO: type: object description: A Party reference allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef_FVO' PartyRef_MVO: type: object description: A Party reference allOf: - $ref: '#/components/schemas/EntityRef_MVO' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef_MVO' PartyRoleRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: >- Party role reference. A party role represents the part played by a party in a given context. properties: partyId: type: string description: The identifier of the engaged party that is linked to the PartyRole object. partyName: type: string description: The name of the engaged party that is linked to the PartyRole object. discriminator: propertyName: '@type' mapping: PartyRoleRef: '#/components/schemas/PartyRoleRef' PartyRoleRef_FVO: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: >- Party role reference. A party role represents the part played by a party in a given context. properties: partyId: type: string description: The identifier of the engaged party that is linked to the PartyRole object. partyName: type: string description: The name of the engaged party that is linked to the PartyRole object. discriminator: propertyName: '@type' mapping: PartyRoleRef: '#/components/schemas/PartyRoleRef_FVO' PartyRoleRef_MVO: allOf: - $ref: '#/components/schemas/EntityRef_MVO' - type: object description: >- Party role reference. A party role represents the part played by a party in a given context. properties: partyId: type: string description: The identifier of the engaged party that is linked to the PartyRole object. partyName: type: string description: The name of the engaged party that is linked to the PartyRole object. discriminator: propertyName: '@type' mapping: PartyRoleRef: '#/components/schemas/PartyRoleRef_MVO' PhoneContactMedium: allOf: - $ref: '#/components/schemas/ContactMedium' - type: object description: >- Describes a phone number that could be used to contact a party (an individual or an organization) properties: phoneNumber: type: string description: The phone number of the contact Quantity: type: object description: An amount in a given unit properties: amount: type: number format: float default: 1 description: Numeric value in a given unit units: type: string description: Unit RelatedEntity: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: 'A reference to an entity, where the type of the entity is not known in advance.' properties: role: type: string entity: $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: RelatedEntity: '#/components/schemas/RelatedEntity' RelatedEntity_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: 'A reference to an entity, where the type of the entity is not known in advance.' properties: role: type: string entity: $ref: '#/components/schemas/EntityRef' required: - role - entity discriminator: propertyName: '@type' mapping: RelatedEntity: '#/components/schemas/RelatedEntity_FVO' RelatedEntity_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: 'A reference to an entity, where the type of the entity is not known in advance.' properties: role: type: string entity: $ref: '#/components/schemas/EntityRef_MVO' discriminator: propertyName: '@type' mapping: RelatedEntity: '#/components/schemas/RelatedEntity_MVO' RelatedPartyRefOrPartyRoleRef: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity properties: role: description: >- Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user' type: string partyOrPartyRole: $ref: '#/components/schemas/PartyRefOrPartyRoleRef' discriminator: propertyName: '@type' mapping: RelatedPartyRefOrPartyRoleRef: '#/components/schemas/RelatedPartyRefOrPartyRoleRef' RelatedPartyRefOrPartyRoleRef_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity properties: role: description: >- Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user' type: string partyOrPartyRole: $ref: '#/components/schemas/PartyRefOrPartyRoleRef_FVO' required: - role discriminator: propertyName: '@type' mapping: RelatedPartyRefOrPartyRoleRef: '#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO' RelatedPartyRefOrPartyRoleRef_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity properties: role: description: >- Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user' type: string partyOrPartyRole: $ref: '#/components/schemas/PartyRefOrPartyRoleRef_MVO' discriminator: propertyName: '@type' mapping: RelatedPartyRefOrPartyRoleRef: '#/components/schemas/RelatedPartyRefOrPartyRoleRef_MVO' StatusChange: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Holds the status, reasons and associated date the status changed, populated by the server properties: statusChangeDate: type: string format: date-time description: The date and time the status changed. statusChangeReason: type: string description: The reason why the status changed. status: $ref: '#/components/schemas/TroubleTicketStatusType' discriminator: propertyName: '@type' mapping: StatusChange: '#/components/schemas/StatusChange' StatusChange_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Holds the status, reasons and associated date the status changed, populated by the server properties: statusChangeDate: type: string format: date-time description: The date and time the status changed. statusChangeReason: type: string description: The reason why the status changed. status: $ref: '#/components/schemas/TroubleTicketStatusType' discriminator: propertyName: '@type' mapping: StatusChange: '#/components/schemas/StatusChange_FVO' StatusChange_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Holds the status, reasons and associated date the status changed, populated by the server properties: statusChangeDate: type: string format: date-time description: The date and time the status changed. statusChangeReason: type: string description: The reason why the status changed. status: $ref: '#/components/schemas/TroubleTicketStatusType' discriminator: propertyName: '@type' mapping: StatusChange: '#/components/schemas/StatusChange_MVO' StringArrayCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is an array of String(s). properties: value: type: array description: Collection of string characteristics items: type: string description: Characteristic value StringArrayCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: A specification for a characteristic for which the value is an array of strings properties: value: type: array items: type: string description: Characteristic value StringArrayCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: A specification for a characteristic for which the value is an array of strings properties: value: type: array items: type: string description: Characteristic value StringArrayCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: A specification for a characteristic for which the value is an array of strings properties: value: type: array items: type: string description: Characteristic value StringArrayCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is an array of String(s). properties: value: type: array description: Collection of string characteristics items: type: string description: Characteristic value required: - value StringArrayCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is an array of String(s). properties: value: type: array description: Collection of string characteristics items: type: string description: Characteristic value StringCharacteristic: allOf: - $ref: '#/components/schemas/Characteristic' - type: object description: A characteristic which value is a String. properties: value: type: string description: Value of the characteristic StringCharacteristicValueSpecification: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification' - type: object description: A specification for a characteristic for which the value is a string properties: value: type: string description: Value of the characteristic StringCharacteristicValueSpecification_FVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_FVO' - type: object description: A specification for a characteristic for which the value is a string properties: value: type: string description: Value of the characteristic StringCharacteristicValueSpecification_MVO: allOf: - $ref: '#/components/schemas/CharacteristicValueSpecification_MVO' - type: object description: A specification for a characteristic for which the value is a string properties: value: type: string description: Value of the characteristic StringCharacteristic_FVO: allOf: - $ref: '#/components/schemas/Characteristic_FVO' - type: object description: A characteristic which value is a String. properties: value: type: string description: Value of the characteristic required: - value StringCharacteristic_MVO: allOf: - $ref: '#/components/schemas/Characteristic_MVO' - type: object description: A characteristic which value is a String. properties: value: type: string description: Value of the characteristic TimePeriod: type: object description: 'A period of time, either as a deadline (endDateTime only) a startDateTime only, or both' properties: startDateTime: description: 'Start of the time period, using IETC-RFC-3339 format' type: string format: date-time example: '1985-04-12T23:20:50.52Z' endDateTime: description: 'End of the time period, using IETC-RFC-3339 format' type: string format: date-time example: '1985-04-12T23:20:50.52Z' TroubleTicket: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system properties: name: type: string description: >- Name of the trouble ticket, typically a short description provided by the user that create the ticket description: type: string description: Description of the trouble or issue severity: type: string description: >- The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. Severity values can be for example : Critical, Major, Minor ticketType: type: string description: 'Represent a business type of the trouble ticket e.g. incident, complain, request' attachment: type: array items: $ref: '#/components/schemas/AttachmentRefOrValue' description: >- File(s) attached to the trouble ticket. e.g. picture of broken device, scanning of a bill or charge channel: $ref: '#/components/schemas/ChannelRef' creationDate: type: string format: date-time description: The date on which the trouble ticket was created requestedResolutionDate: type: string format: date-time description: The resolution date requested by the user expectedResolutionDate: type: string format: date-time description: The expected resolution date determined by the trouble ticket system resolutionDate: type: string format: date-time description: The date and time the trouble ticket was resolved externalIdentifier: type: array items: $ref: '#/components/schemas/ExternalIdentifier' lastUpdate: type: string format: date-time description: The date and time that the trouble ticket was last updated note: type: array items: $ref: '#/components/schemas/Note' description: The note(s) that are associated to the ticket. priority: type: string description: >- The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc... relatedEntity: type: array items: $ref: '#/components/schemas/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. relatedParty: type: array items: $ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef' description: The related party(ies) that are associated to the ticket. status: $ref: '#/components/schemas/TroubleTicketStatusType' statusChangeDate: type: string format: date-time description: The date and time the status changed. statusChangeReason: type: string description: The reason for changing the status statusChangeHistory: type: array items: $ref: '#/components/schemas/StatusChange' description: The status change history that are associated to the ticket. Populated by the server troubleTicketRelationship: type: array items: $ref: '#/components/schemas/TroubleTicketRelationship' description: >- A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets troubleTicketSpecification: $ref: '#/components/schemas/TroubleTicketSpecificationRef' troubleTicketCharacteristic: type: array items: $ref: '#/components/schemas/Characteristic' description: List of characteristics of the trouble ticket discriminator: propertyName: '@type' mapping: TroubleTicket: '#/components/schemas/TroubleTicket' TroubleTicketAttributeValueChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: TroubleTicketAttributeValueChange structure properties: event: $ref: '#/components/schemas/TroubleTicketAttributeValueChangeEventPayload' discriminator: propertyName: '@type' mapping: TroubleTicketAttributeValueChangeEvent: '#/components/schemas/TroubleTicketAttributeValueChangeEvent' TroubleTicketAttributeValueChangeEventPayload: type: object description: TroubleTicketAttributeValueChangeEventPayload generic structure properties: troubleTicket: $ref: '#/components/schemas/TroubleTicket' TroubleTicketCreateEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: TroubleTicketCreateEvent generic structure properties: event: $ref: '#/components/schemas/TroubleTicketCreateEventPayload' discriminator: propertyName: '@type' mapping: TroubleTicketCreateEvent: '#/components/schemas/TroubleTicketCreateEvent' TroubleTicketCreateEventPayload: type: object description: TroubleTicketCreateEventPayload generic structure properties: troubleTicket: $ref: '#/components/schemas/TroubleTicket' TroubleTicketDeleteEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: TroubleTicketDeleteEvent generic structure properties: event: $ref: '#/components/schemas/TroubleTicketDeleteEventPayload' discriminator: propertyName: '@type' mapping: TroubleTicketDeleteEvent: '#/components/schemas/TroubleTicketDeleteEvent' TroubleTicketDeleteEventPayload: type: object description: TroubleTicketDeleteEventPayload generic structure properties: troubleTicket: $ref: '#/components/schemas/TroubleTicketRef' TroubleTicketInformationRequiredEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: TroubleTicketInformationRequiredEvent generic structure properties: event: $ref: '#/components/schemas/TroubleTicketInformationRequiredEventPayload' discriminator: propertyName: '@type' mapping: TroubleTicketInformationRequiredEvent: '#/components/schemas/TroubleTicketInformationRequiredEvent' TroubleTicketInformationRequiredEventPayload: type: object description: TroubleTicketInformationRequiredEventPayload generic structure properties: troubleTicket: $ref: '#/components/schemas/TroubleTicket' informationRequired: $ref: '#/components/schemas/JsonPatch' TroubleTicketRef: type: object description: reference to an TroubleTicket object allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: TroubleTicketRef: '#/components/schemas/TroubleTicketRef' TroubleTicketRelationship: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: Represents a relationship between trouble tickets properties: id: type: string description: Unique identifier of the related trouble ticket name: type: string description: Name of the trouble ticket relationshipType: type: string description: Type of relationship discriminator: propertyName: '@type' mapping: TroubleTicketRelationship: '#/components/schemas/TroubleTicketRelationship' TroubleTicketRelationship_FVO: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: Represents a relationship between trouble tickets properties: id: type: string description: Unique identifier of the related trouble ticket name: type: string description: Name of the trouble ticket relationshipType: type: string description: Type of relationship required: - id - relationshipType discriminator: propertyName: '@type' mapping: TroubleTicketRelationship: '#/components/schemas/TroubleTicketRelationship_FVO' TroubleTicketRelationship_MVO: allOf: - $ref: '#/components/schemas/EntityRef_MVO' - type: object description: Represents a relationship between trouble tickets properties: id: type: string description: Unique identifier of the related trouble ticket name: type: string description: Name of the trouble ticket relationshipType: type: string description: Type of relationship discriminator: propertyName: '@type' mapping: TroubleTicketRelationship: '#/components/schemas/TroubleTicketRelationship_MVO' TroubleTicketResolvedEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: TroubleTicketResolvedEvent generic structure properties: event: $ref: '#/components/schemas/TroubleTicketResolvedEventPayload' discriminator: propertyName: '@type' mapping: TroubleTicketResolvedEvent: '#/components/schemas/TroubleTicketResolvedEvent' TroubleTicketResolvedEventPayload: type: object description: TroubleTicketResolvedEventPayload generic structure properties: troubleTicket: $ref: '#/components/schemas/TroubleTicket' TroubleTicketSpecification: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- TroubleTicketSpecification defines the common attributes and relationships of a set of related trouble tickets, while trouble ticket defines a specific instance that is based on a particular trouble ticket specification. properties: name: type: string description: Name given to the specification description: type: string description: Description of the specification lifecycleStatus: type: string description: >- Used to indicate the current lifecycle status of this specification such as inDesign,active,rejected,retired specCharacteristic: type: array description: List of characteristics that the entity can take items: $ref: '#/components/schemas/CharacteristicSpecification' relatedParty: type: array description: Parties who manage or otherwise have an interest in this specification items: $ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef' validFor: $ref: '#/components/schemas/TimePeriod' version: type: string description: >- The version of the trouble ticket specification, in case it is desired to maintain multiple versions of trouble ticket specifications creationDate: type: string format: date-time description: The date on which the trouble ticket specification was created lastUpdate: type: string format: date-time description: Date and time of the last update of the specification discriminator: propertyName: '@type' mapping: TroubleTicketSpecification: '#/components/schemas/TroubleTicketSpecification' TroubleTicketSpecificationAttributeValueChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: TroubleTicketSpecificationAttributeValueChange structure properties: event: $ref: '#/components/schemas/TroubleTicketSpecificationAttributeValueChangeEventPayload' discriminator: propertyName: '@type' mapping: TroubleTicketSpecificationAttributeValueChangeEvent: '#/components/schemas/TroubleTicketSpecificationAttributeValueChangeEvent' TroubleTicketSpecificationAttributeValueChangeEventPayload: type: object description: TroubleTicketSpecificationAttributeValueChangeEventPayload generic structure properties: troubleTicketSpecification: $ref: '#/components/schemas/TroubleTicketSpecification' TroubleTicketSpecificationCreateEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: TroubleTicketSpecificationCreateEvent generic structure properties: event: $ref: '#/components/schemas/TroubleTicketSpecificationCreateEventPayload' discriminator: propertyName: '@type' mapping: TroubleTicketSpecificationCreateEvent: '#/components/schemas/TroubleTicketSpecificationCreateEvent' TroubleTicketSpecificationCreateEventPayload: type: object description: TroubleTicketSpecificationCreateEventPayload generic structure properties: troubleTicketSpecification: $ref: '#/components/schemas/TroubleTicketSpecification' TroubleTicketSpecificationDeleteEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: TroubleTicketSpecificationDeleteEvent generic structure properties: event: $ref: '#/components/schemas/TroubleTicketSpecificationDeleteEventPayload' discriminator: propertyName: '@type' mapping: TroubleTicketSpecificationDeleteEvent: '#/components/schemas/TroubleTicketSpecificationDeleteEvent' TroubleTicketSpecificationDeleteEventPayload: type: object description: TroubleTicketSpecificationDeleteEventPayload generic structure properties: troubleTicketSpecification: $ref: '#/components/schemas/TroubleTicketSpecificationRef' TroubleTicketSpecificationRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: reference to an TroubleTicketSpecification object properties: version: type: string description: >- The version of the trouble ticket specification, in case it is desired to maintain multiple versions of trouble ticket specifications discriminator: propertyName: '@type' mapping: TroubleTicketSpecificationRef: '#/components/schemas/TroubleTicketSpecificationRef' TroubleTicketSpecificationRef_FVO: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: reference to an TroubleTicketSpecification object properties: version: type: string description: >- The version of the trouble ticket specification, in case it is desired to maintain multiple versions of trouble ticket specifications discriminator: propertyName: '@type' mapping: TroubleTicketSpecificationRef: '#/components/schemas/TroubleTicketSpecificationRef_FVO' TroubleTicketSpecificationRef_MVO: allOf: - $ref: '#/components/schemas/EntityRef_MVO' - type: object description: reference to an TroubleTicketSpecification object properties: version: type: string description: >- The version of the trouble ticket specification, in case it is desired to maintain multiple versions of trouble ticket specifications discriminator: propertyName: '@type' mapping: TroubleTicketSpecificationRef: '#/components/schemas/TroubleTicketSpecificationRef_MVO' TroubleTicketSpecificationStatusChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: TroubleTicketSpecificationStatusChangeEvent generic structure properties: event: $ref: '#/components/schemas/TroubleTicketSpecificationStatusChangeEventPayload' discriminator: propertyName: '@type' mapping: TroubleTicketSpecificationStatusChangeEvent: '#/components/schemas/TroubleTicketSpecificationStatusChangeEvent' TroubleTicketSpecificationStatusChangeEventPayload: type: object description: TroubleTicketSpecificationStatusChangeEventPayload generic structure properties: troubleTicketSpecification: $ref: '#/components/schemas/TroubleTicketSpecification' TroubleTicketSpecification_FVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- TroubleTicketSpecification defines the common attributes and relationships of a set of related trouble tickets, while trouble ticket defines a specific instance that is based on a particular trouble ticket specification. properties: name: type: string description: Name given to the specification description: type: string description: Description of the specification lifecycleStatus: type: string description: >- Used to indicate the current lifecycle status of this specification such as inDesign,active,rejected,retired specCharacteristic: type: array description: List of characteristics that the entity can take items: $ref: '#/components/schemas/CharacteristicSpecification_FVO' relatedParty: type: array description: Parties who manage or otherwise have an interest in this specification items: $ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO' validFor: $ref: '#/components/schemas/TimePeriod' version: type: string description: >- The version of the trouble ticket specification, in case it is desired to maintain multiple versions of trouble ticket specifications required: - name discriminator: propertyName: '@type' mapping: TroubleTicketSpecification: '#/components/schemas/TroubleTicketSpecification_FVO' TroubleTicketSpecification_MVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- TroubleTicketSpecification defines the common attributes and relationships of a set of related trouble tickets, while trouble ticket defines a specific instance that is based on a particular trouble ticket specification. properties: name: type: string description: Name given to the specification description: type: string description: Description of the specification lifecycleStatus: type: string description: >- Used to indicate the current lifecycle status of this specification such as inDesign,active,rejected,retired specCharacteristic: type: array description: List of characteristics that the entity can take items: $ref: '#/components/schemas/CharacteristicSpecification_MVO' relatedParty: type: array description: Parties who manage or otherwise have an interest in this specification items: $ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef_MVO' validFor: $ref: '#/components/schemas/TimePeriod' version: type: string description: >- The version of the trouble ticket specification, in case it is desired to maintain multiple versions of trouble ticket specifications discriminator: propertyName: '@type' mapping: TroubleTicketSpecification: '#/components/schemas/TroubleTicketSpecification_MVO' TroubleTicketSpecification_RES: type: object description: Response object for TroubleTicketSpecification allOf: - $ref: '#/components/schemas/TroubleTicketSpecification' required: - id - href discriminator: propertyName: '@type' mapping: TroubleTicketSpecification: '#/components/schemas/TroubleTicketSpecification' TroubleTicketStatusChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: TroubleTicketStatusChangeEvent generic structure properties: event: $ref: '#/components/schemas/TroubleTicketStatusChangeEventPayload' discriminator: propertyName: '@type' mapping: TroubleTicketStatusChangeEvent: '#/components/schemas/TroubleTicketStatusChangeEvent' TroubleTicketStatusChangeEventPayload: type: object description: TroubleTicketStatusChangeEventPayload generic structure properties: troubleTicket: $ref: '#/components/schemas/TroubleTicket' TroubleTicketStatusType: enum: - acknowledged - rejected - pending - held - inProgress - cancelled - closed - resolved type: string description: Possible values for the status of the trouble ticket TroubleTicket_FVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system properties: name: type: string description: >- Name of the trouble ticket, typically a short description provided by the user that create the ticket description: type: string description: Description of the trouble or issue severity: type: string description: >- The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. Severity values can be for example : Critical, Major, Minor ticketType: type: string description: 'Represent a business type of the trouble ticket e.g. incident, complain, request' attachment: type: array items: $ref: '#/components/schemas/AttachmentRefOrValue_FVO' description: >- File(s) attached to the trouble ticket. e.g. picture of broken device, scanning of a bill or charge channel: $ref: '#/components/schemas/ChannelRef_FVO' requestedResolutionDate: type: string format: date-time description: The resolution date requested by the user expectedResolutionDate: type: string format: date-time description: The expected resolution date determined by the trouble ticket system resolutionDate: type: string format: date-time description: The date and time the trouble ticket was resolved externalIdentifier: type: array items: $ref: '#/components/schemas/ExternalIdentifier_FVO' note: type: array items: $ref: '#/components/schemas/Note_FVO' description: The note(s) that are associated to the ticket. priority: type: string description: >- The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc... relatedEntity: type: array items: $ref: '#/components/schemas/RelatedEntity_FVO' description: >- An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated. relatedParty: type: array items: $ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO' description: The related party(ies) that are associated to the ticket. status: $ref: '#/components/schemas/TroubleTicketStatusType' statusChangeDate: type: string format: date-time description: The date and time the status changed. statusChangeReason: type: string description: The reason for changing the status troubleTicketRelationship: type: array items: $ref: '#/components/schemas/TroubleTicketRelationship_FVO' description: >- A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets troubleTicketSpecification: $ref: '#/components/schemas/TroubleTicketSpecificationRef_FVO' troubleTicketCharacteristic: type: array items: $ref: '#/components/schemas/Characteristic_FVO' description: List of characteristics of the trouble ticket required: - description - severity - ticketType discriminator: propertyName: '@type' mapping: TroubleTicket: '#/components/schemas/TroubleTicket_FVO' TroubleTicket_MVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system properties: name: type: string description: >- Name of the trouble ticket, typically a short description provided by the user that create the ticket description: type: string description: Description of the trouble or issue severity: type: string description: >- The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. Severity values can be for example : Critical, Major, Minor ticketType: type: string description: 'Represent a business type of the trouble ticket e.g. incident, complain, request' attachment: type: array items: $ref: '#/components/schemas/AttachmentRefOrValue_MVO' description: >- File(s) attached to the trouble ticket. e.g. picture of broken device, scanning of a bill or charge channel: $ref: '#/components/schemas/ChannelRef_MVO' requestedResolutionDate: type: string format: date-time description: The resolution date requested by the user expectedResolutionDate: type: string format: date-time description: The expected resolution date determined by the trouble ticket system resolutionDate: type: string format: date-time description: The date and time the trouble ticket was resolved externalIdentifier: type: array items: $ref: '#/components/schemas/ExternalIdentifier_MVO' note: type: array items: $ref: '#/components/schemas/Note_MVO' description: The note(s) that are associated to the ticket. priority: type: string description: >- The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc... relatedEntity: type: array items: $ref: '#/components/schemas/RelatedEntity_MVO' description: >- An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated. relatedParty: type: array items: $ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef_MVO' description: The related party(ies) that are associated to the ticket. status: $ref: '#/components/schemas/TroubleTicketStatusType' statusChangeReason: type: string description: The reason for changing the status statusChangeHistory: type: array items: $ref: '#/components/schemas/StatusChange_MVO' description: The status change history that are associated to the ticket. Populated by the server troubleTicketRelationship: type: array items: $ref: '#/components/schemas/TroubleTicketRelationship_MVO' description: >- A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets troubleTicketSpecification: $ref: '#/components/schemas/TroubleTicketSpecificationRef_MVO' troubleTicketCharacteristic: type: array items: $ref: '#/components/schemas/Characteristic_MVO' description: List of characteristics of the trouble ticket discriminator: propertyName: '@type' mapping: TroubleTicket: '#/components/schemas/TroubleTicket_MVO' TroubleTicket_RES: type: object description: Response object for TroubleTicket allOf: - $ref: '#/components/schemas/TroubleTicket' required: - id - href discriminator: propertyName: '@type' mapping: TroubleTicket: '#/components/schemas/TroubleTicket' Error: discriminator: propertyName: '@type' mapping: Error: '#/components/schemas/Error' allOf: - $ref: '#/components/schemas/Extensible' - type: object required: - code - reason properties: code: type: string description: 'Application relevant detail, defined in the API or a common list.' reason: type: string description: Explanation of the reason for the error which can be shown to a client user. message: type: string description: >- More details and corrective actions related to the error which can be shown to a client user. status: type: string description: HTTP Error code extension referenceError: type: string description: URI of documentation describing the error. description: 'Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)' Hub_FVO: type: object description: >- Sets the communication endpoint address the service instance must use to deliver notification information required: - callback allOf: - $ref: '#/components/schemas/Extensible' - properties: callback: type: string description: The callback being registered. query: type: string description: additional data to be passed Hub: type: object description: >- Sets the communication endpoint address the service instance must use to deliver notification information allOf: - $ref: '#/components/schemas/Entity' - properties: id: type: string description: Id of the listener callback: type: string description: The callback being registered. query: type: string description: additional data to be passed required: - callback JsonPatchOperations: description: JSONPatch Operations document as defined by RFC 6902 type: array items: $ref: '#/components/schemas/JsonPatch' parameters: Id: name: id required: true schema: type: string in: path description: Identifier of the Resource Fields: name: fields in: query description: Comma-separated properties to be provided in response schema: type: string Offset: name: offset in: query description: Requested index for start of resources to be provided in response schema: type: integer Limit: name: limit in: query description: Requested number of resources to be provided in response schema: type: integer Before: name: before in: query description: An opaque string value representing the page results before the cursor value schema: type: string After: name: after in: query description: An opaque string value representing the page results after the cursor value schema: type: string Sort: name: sort in: query description: >- The default direction is Ascending order, the use of the modifier in front of the sort field name, “-“, changes the sort order direction. schema: type: string Filter: name: filter in: query description: Filter a collection using JSONPath schema: type: string example: 'attachment[?(@size==300)]' requestBodies: TroubleTicket_FVO: description: The TroubleTicket to be created content: application/json: schema: $ref: '#/components/schemas/TroubleTicket_FVO' examples: TroubleTicket_create_example: $ref: '#/components/examples/TroubleTicket_create_example_request' required: true TroubleTicket_MVO: description: The TroubleTicket to be patched content: application/json: schema: $ref: '#/components/schemas/TroubleTicket_MVO' examples: TroubleTicket_partialupdate_example_application_json: $ref: '#/components/examples/TroubleTicket_partialupdate_example_application_json_request' application/merge-patch+json: schema: $ref: '#/components/schemas/TroubleTicket_MVO' examples: TroubleTicket_partialupdate_example_application_merge_json: $ref: >- #/components/examples/TroubleTicket_partialupdate_example_application_merge_json_request application/json-patch+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: TroubleTicket_partialupdate_example_application_json_patch: $ref: >- #/components/examples/TroubleTicket_partialupdate_example_application_json_patch_request application/json-patch-query+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: TroubleTicket_partialupdate_example_application_json_patch_query: $ref: >- #/components/examples/TroubleTicket_partialupdate_example_application_json_patch_query_request required: true TroubleTicketCreateEvent: description: TroubleTicket create Event payload content: application/json: schema: $ref: '#/components/schemas/TroubleTicketCreateEvent' examples: TroubleTicketCreateEvent: $ref: '#/components/examples/TroubleTicketCreateEvent_request' TroubleTicket_listener_troubleTicketCreateEvent_POST_204_1: $ref: >- #/components/examples/TroubleTicket_listener_troubleTicketCreateEvent_POST_204_1_request required: true TroubleTicketAttributeValueChangeEvent: description: TroubleTicket attributeValueChange Event payload content: application/json: schema: $ref: '#/components/schemas/TroubleTicketAttributeValueChangeEvent' examples: TroubleTicketAttributeValueChangeEvent: $ref: '#/components/examples/TroubleTicketAttributeValueChangeEvent_request' required: true TroubleTicketStatusChangeEvent: description: TroubleTicket statusChange Event payload content: application/json: schema: $ref: '#/components/schemas/TroubleTicketStatusChangeEvent' examples: TroubleTicketStatusChangeEvent: $ref: '#/components/examples/TroubleTicketStatusChangeEvent_request' required: true TroubleTicketDeleteEvent: description: TroubleTicket delete Event payload content: application/json: schema: $ref: '#/components/schemas/TroubleTicketDeleteEvent' examples: TroubleTicketDeleteEvent: $ref: '#/components/examples/TroubleTicketDeleteEvent_request' required: true TroubleTicketResolvedEvent: description: TroubleTicket resolved Event payload content: application/json: schema: $ref: '#/components/schemas/TroubleTicketResolvedEvent' examples: TroubleTicketResolvedEvent: $ref: '#/components/examples/TroubleTicketResolvedEvent_request' required: true TroubleTicketInformationRequiredEvent: description: TroubleTicket informationRequired Event payload content: application/json: schema: $ref: '#/components/schemas/TroubleTicketInformationRequiredEvent' examples: TroubleTicketInformationRequiredEvent: $ref: '#/components/examples/TroubleTicketInformationRequiredEvent_request' required: true TroubleTicketSpecification_FVO: description: The TroubleTicketSpecification to be created content: application/json: schema: $ref: '#/components/schemas/TroubleTicketSpecification_FVO' examples: TroubleTicketSpecification_create_example: $ref: '#/components/examples/TroubleTicketSpecification_create_example_request' required: true TroubleTicketSpecification_MVO: description: The TroubleTicketSpecification to be patched content: application/json: schema: $ref: '#/components/schemas/TroubleTicketSpecification_MVO' examples: TroubleTicketSpecification_partialupdate_application_json: $ref: >- #/components/examples/TroubleTicketSpecification_partialupdate_application_json_request application/merge-patch+json: schema: $ref: '#/components/schemas/TroubleTicketSpecification_MVO' examples: TroubleTicketSpecification_partialupdate_application_merge_json: $ref: >- #/components/examples/TroubleTicketSpecification_partialupdate_application_merge_json_request application/json-patch+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: TroubleTicketSpecification_partialupdate_application_json_patch: $ref: >- #/components/examples/TroubleTicketSpecification_partialupdate_application_json_patch_request application/json-patch-query+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: TroubleTicketSpecification_partialupdate_application_json_patch_query: $ref: >- #/components/examples/TroubleTicketSpecification_partialupdate_application_json_patch_query_request required: true TroubleTicketSpecificationCreateEvent: description: TroubleTicketSpecification create Event payload content: application/json: schema: $ref: '#/components/schemas/TroubleTicketSpecificationCreateEvent' examples: TroubleTicketSpecificationCreateEvent: $ref: '#/components/examples/TroubleTicketSpecificationCreateEvent_request' required: true TroubleTicketSpecificationAttributeValueChangeEvent: description: TroubleTicketSpecification attributeValueChange Event payload content: application/json: schema: $ref: '#/components/schemas/TroubleTicketSpecificationAttributeValueChangeEvent' examples: TroubleTicketSpecificationAttributeValueChangeEvent: $ref: '#/components/examples/TroubleTicketSpecificationAttributeValueChangeEvent_request' required: true TroubleTicketSpecificationStatusChangeEvent: description: TroubleTicketSpecification statusChange Event payload content: application/json: schema: $ref: '#/components/schemas/TroubleTicketSpecificationStatusChangeEvent' examples: TroubleTicketSpecificationStatusChangeEvent: $ref: '#/components/examples/TroubleTicketSpecificationStatusChangeEvent_request' required: true TroubleTicketSpecificationDeleteEvent: description: TroubleTicketSpecification delete Event payload content: application/json: schema: $ref: '#/components/schemas/TroubleTicketSpecificationDeleteEvent' examples: TroubleTicketSpecificationDeleteEvent: $ref: '#/components/examples/TroubleTicketSpecificationDeleteEvent_request' required: true Hub_FVO: description: Data containing the callback endpoint to deliver the information content: application/json: schema: $ref: '#/components/schemas/Hub_FVO' examples: Basic Hub Example Request: value: '@type': Hub callback: 'https://host/tmf-api/specificAPIName/v5/listener/specificEventListener' query: data required: true responses: '200': description: OK '202': description: Accepted '204': description: Deleted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Bad Request Error value: '@type': Error code: ERR400 reason: Bad Request message: >- The server could not understand the request due to invalid syntax. Please correct the syntax and try again. referenceError: 'https://host/errors' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Unauthorized Error value: '@type': Error code: ERR401 reason: Unauthorized message: >- You are not authorized to access the requested resource. Please provide the correct credentials. referenceError: 'https://host/errors' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Forbidden Error value: '@type': Error code: ERR403 reason: Forbidden message: >- You don't have the permission to access the requested resource. It is either read-protected or not readable by the server. referenceError: 'https://host/errors' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Not Found Error value: '@type': Error code: ERR404 reason: Not Found message: The requested URL was not found on the server. referenceError: 'https://host/errors' '405': description: Method Not allowed content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Method Not allowed Error value: '@type': Error code: ERR405 reason: Method Not allowed message: The method is not allowed for the requested URL. referenceError: 'https://host/errors' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Conflict Error value: '@type': Error code: ERR409 reason: Conflict message: >- The request could not be completed due to a conflict with the current state of the target resource. referenceError: 'https://host/errors' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Internal Server Error example value: '@type': Error code: ERR500 reason: Internal Server Error message: The server encountered an internal error. Please contact the system administrator. referenceError: 'https://host/errors' '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Not Implemented Error value: '@type': Error code: ERR501 reason: The requested operation is not implemented message: >- The requested operation is not implemented. Please contact the system administrator. referenceError: 'https://host/errors' '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Service Unavailable Error value: '@type': Error code: ERR503 reason: Service Unavailable message: The service is currently unavailable. Please try again later. referenceError: 'https://host/errors' 200TroubleTicketArray: description: Success headers: X-Total-Count: $ref: '#/components/headers/X-Total-Count' X-Result-Count: $ref: '#/components/headers/X-Result-Count' content: application/json: schema: type: array items: $ref: '#/components/schemas/TroubleTicket_RES' examples: TroubleTicket_list_with_filter_and_fields_example: $ref: '#/components/examples/TroubleTicket_list_with_filter_and_fields_example_response' TroubleTicket_list_example: $ref: '#/components/examples/TroubleTicket_list_example_response' 200TroubleTicket_Get: description: Success content: application/json: schema: $ref: '#/components/schemas/TroubleTicket_RES' examples: TroubleTicket_retrieve_example: $ref: '#/components/examples/TroubleTicket_retrieve_example_response' 200TroubleTicket_Patch: description: Success content: application/json: schema: $ref: '#/components/schemas/TroubleTicket_RES' examples: TroubleTicket_partialupdate_example_application_json: $ref: '#/components/examples/TroubleTicket_partialupdate_example_application_json_response' 201TroubleTicket: description: OK/Created content: application/json: schema: $ref: '#/components/schemas/TroubleTicket_RES' examples: TroubleTicket_create_example: $ref: '#/components/examples/TroubleTicket_create_example_response' 200TroubleTicketSpecificationArray: description: Success headers: X-Total-Count: $ref: '#/components/headers/X-Total-Count' X-Result-Count: $ref: '#/components/headers/X-Result-Count' content: application/json: schema: type: array items: $ref: '#/components/schemas/TroubleTicketSpecification_RES' examples: TroubleTicketSpecification_with_filter_and_fields_list_example: $ref: >- #/components/examples/TroubleTicketSpecification_with_filter_and_fields_list_example_response TroubleTicketSpecification_list_example: $ref: '#/components/examples/TroubleTicketSpecification_list_example_response' 200TroubleTicketSpecification_Get: description: Success content: application/json: schema: $ref: '#/components/schemas/TroubleTicketSpecification_RES' examples: TroubleTicketSpecification_retrieve_example: $ref: '#/components/examples/TroubleTicketSpecification_retrieve_example_response' 200TroubleTicketSpecification_Patch: description: Success content: application/json: schema: $ref: '#/components/schemas/TroubleTicketSpecification_RES' examples: TroubleTicketSpecification_partialupdate_application_json: $ref: >- #/components/examples/TroubleTicketSpecification_partialupdate_application_json_response 201TroubleTicketSpecification: description: OK/Created content: application/json: schema: $ref: '#/components/schemas/TroubleTicketSpecification_RES' examples: TroubleTicketSpecification_create_example: $ref: '#/components/examples/TroubleTicketSpecification_create_example_response' Error: description: Error content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Error example value: '@type': Error code: ERR001 reason: Missing information message: Please provide the additional example information referenceError: 'https://host/errors' Hub: description: Notified content: application/json: schema: $ref: '#/components/schemas/Hub' examples: basic: summary: Hub example value: '@type': Hub callback: 'https://host/tmf-api/specificAPIName/v5/listener/specificEventListener' headers: X-Total-Count: description: Total number of items matching criteria schema: type: integer X-Result-Count: description: Actual number of items returned in the response body schema: type: integer securitySchemes: {} examples: TroubleTicket_list_with_filter_and_fields_example_response: value: - id: '3180' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3180' name: complaint over last bill priority: High '@type': TroubleTicket - id: '3256' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3256' name: Commerce problem priority: High '@type': TroubleTicket - id: '4563' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/5/troubleTicket/4563' name: Network latency priority: High '@type': TroubleTicket description: >- Here's an example of a request for retrieving a list of trouble ticket(s). The given filter criteria is priority High and fields id,href,name,@type,priority TroubleTicket_list_example_response: value: - id: '3256' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3256' creationDate: '2023-05-31T07:34:45.968Z' description: 'I ordered a new mobile line 2 week ago, but the mobile device did not arrived' expectedResolutionDate: '2019-06-10T07:34:45.968Z' lastUpdate: '2023-05-31T07:34:45.968Z' name: Commerce problem priority: High requestedResolutionDate: '2022-05-31T07:34:45.968Z' resolutionDate: '2023-05-31T07:34:45.968Z' severity: Minor status: resolved statusChangeDate: '2023-05-31T07:34:45.968Z' statusChangeReason: Apply full credit ticketType: Commerce Issue troubleTicketCharacteristic: - id: '1' name: orderReferenceNumber valueType: string value: Order_888 '@type': StringCharacteristic - id: '2' name: orderCreationDate valueType: string value: '2023-05-31' '@type': StringCharacteristic attachment: - description: Scanned Order attachmentType: orderCopy mimeType: image/png name: New Mobile Order url: 'https://mycsp.com:7070/docloader?docnum=3534888' '@type': Attachment channel: id: '8774' name: self service '@type': ChannelRef note: - id: '77458' author: Jack Smith date: '2023-05-31T07:34:45.968Z' text: I did not recived the mobile device '@type': Note relatedEntity: - role: disputedOrder '@type': RelatedEntity entity: id: Order_888 href: 'https://mycsp.com:8080/tmf-api/productOrdering/v5/productOrder/Order_888' name: New Mobile Order '@type': EntityRef '@referredType': ProductOrder relatedParty: - role: member partyOrPartyRole: id: '9866' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9866' name: Sandy Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: reporter partyOrPartyRole: id: '9877' name: Jacob Jac Miller '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: customer partyOrPartyRole: id: '9176' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/customer/9176' name: Jack Smith '@type': PartyRoleRef '@referredType': Customer '@type': RelatedPartyRefOrPartyRoleRef statusChangeHistory: - statusChangeDate: '2023-05-28T07:34:45.968Z' statusChangeReason: 'trouble ticket created ' status: acknowledged '@type': StatusChange - statusChangeDate: '2023-05-28T08:34:45.968Z' statusChangeReason: start process status: inProgress '@type': StatusChange - statusChangeDate: '2023-05-31T07:34:45.968Z' statusChangeReason: Resend new device to the customer status: resolved '@type': StatusChange '@type': TroubleTicket - id: '3180' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3180' creationDate: '2022-05-31T07:34:45.968Z' description: >- I do not accept the last VOD charge, since the movie was constantly interrupted, I had to quick watching the movie in the middle expectedResolutionDate: '2019-06-10T07:34:45.968Z' lastUpdate: '2022-05-31T07:34:45.968Z' name: complaint over last bill priority: High requestedResolutionDate: '2022-05-31T07:34:45.968Z' resolutionDate: '2022-05-31T07:34:45.968Z' severity: Minor status: resolved statusChangeDate: '2022-05-31T07:34:45.968Z' statusChangeReason: Apply full credit ticketType: Bill Dispute troubleTicketCharacteristic: - id: '1' name: disputeAmount valueType: number value: 40 '@type': NumberCharacteristic - id: '2' name: creditAmount valueType: number value: 40 characteristicRelationship: - id: '4' relationshipType: dependency '@type': CharacteristicRelationship '@type': NumberCharacteristic - id: '3' name: currency valueType: string value: USD '@type': StringCharacteristic - id: '4' name: creditReason valueType: string value: Network connectivity issues '@type': StringCharacteristic attachment: - description: Scanned disputed bill attachmentType: billCopy mimeType: image/png name: March Bill url: 'https://mycsp.com:7070/docloader?docnum=3534555' '@type': Attachment channel: id: '8774' name: self service '@type': ChannelRef note: - id: '77456' author: Jack Smith date: '2019-05-31T07:34:45.968Z' text: 'This is quite important, please approach me as soon as possible' '@type': Note relatedEntity: - role: disputedBill '@type': RelatedEntity entity: id: '3472' href: 'https://mycsp.com:8080/tmf-api/customerBillManagement/v5/customerBill/8297' name: March 2019 Bill '@type': EntityRef '@referredType': CustomerBill relatedParty: - role: member partyOrPartyRole: id: '9866' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9866' name: Sandy Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: reporter partyOrPartyRole: id: '9877' name: Jacob Jac Miller '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: customer partyOrPartyRole: id: '9176' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/customer/9176' name: Jack Smith '@type': PartyRoleRef '@referredType': Customer '@type': RelatedPartyRefOrPartyRoleRef statusChangeHistory: - statusChangeDate: '2022-05-28T07:34:45.968Z' statusChangeReason: 'trouble ticket created ' status: acknowledged '@type': StatusChange - statusChangeDate: '2022-05-28T08:34:45.968Z' statusChangeReason: start process status: inProgress '@type': StatusChange - statusChangeDate: '2022-05-29T07:34:45.968Z' statusChangeReason: Need more information from the customer status: pending '@type': StatusChange - statusChangeDate: '2022-05-31T07:34:45.968Z' statusChangeReason: Apply full credit status: resolved '@type': StatusChange troubleTicketRelationship: - id: '567433' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/567433' name: Network Coverage relationshipType: dependecy '@type': TroubleTicketRelationship externalIdentifier: - id: '3331234' owner: BMC Remedy externalIdentifierType: Incident '@type': ExternalIdentifier '@type': TroubleTicket description: Here's an example of a request for retrieving a list of trouble ticket(s). TroubleTicket_retrieve_example_response: value: id: '3180' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3180' creationDate: '2022-05-31T07:34:45.968Z' description: >- I do not accept the last VOD charge, since the movie was constantly interrupted, I had to quick watching the movie in the middle expectedResolutionDate: '2019-06-10T07:34:45.968Z' lastUpdate: '2022-05-31T07:34:45.968Z' name: complaint over last bill priority: High requestedResolutionDate: '2022-05-31T07:34:45.968Z' resolutionDate: '2022-05-31T07:34:45.968Z' severity: Minor status: resolved statusChangeDate: '2022-05-31T07:34:45.968Z' statusChangeReason: Apply full credit ticketType: Bill Dispute troubleTicketCharacteristic: - id: '1' name: disputeAmount valueType: number value: 40 '@type': NumberCharacteristic - id: '2' name: creditAmount valueType: number value: 40 characteristicRelationship: - id: '4' relationshipType: dependency '@type': CharacteristicRelationship '@type': NumberCharacteristic - id: '3' name: currency valueType: string value: USD '@type': StringCharacteristic - id: '4' name: creditReason valueType: string value: Network connectivity issues '@type': StringCharacteristic attachment: - description: Scanned disputed bill attachmentType: billCopy mimeType: image/png name: March Bill url: 'https://mycsp.com:7070/docloader?docnum=3534555' '@type': Attachment channel: id: '8774' name: self service '@type': ChannelRef note: - id: '77456' author: Jack Smith date: '2019-05-31T07:34:45.968Z' text: 'This is quite important, please approach me as soon as possible' '@type': Note relatedEntity: - role: disputedBill '@type': RelatedEntity entity: id: '3472' href: 'https://mycsp.com:8080/tmf-api/customerBillManagement/v5/customerBill/8297' name: March 2019 Bill '@type': EntityRef '@referredType': CustomerBill relatedParty: - role: member partyOrPartyRole: id: '9866' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9866' name: Sandy Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: reporter partyOrPartyRole: id: '9877' name: Jacob Jac Miller '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: customer partyOrPartyRole: id: '9176' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/customer/9176' name: Jack Smith '@type': PartyRoleRef '@referredType': Customer '@type': RelatedPartyRefOrPartyRoleRef statusChangeHistory: - statusChangeDate: '2022-05-28T07:34:45.968Z' statusChangeReason: 'trouble ticket created ' status: acknowledged '@type': StatusChange - statusChangeDate: '2022-05-28T08:34:45.968Z' statusChangeReason: start process status: inProgress '@type': StatusChange - statusChangeDate: '2022-05-29T07:34:45.968Z' statusChangeReason: Need more information from the customer status: pending '@type': StatusChange - statusChangeDate: '2022-05-31T07:34:45.968Z' statusChangeReason: Apply full credit status: resolved '@type': StatusChange troubleTicketRelationship: - id: '567433' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/567433' name: Network Coverage relationshipType: dependecy '@type': TroubleTicketRelationship externalIdentifier: - id: '3331234' owner: BMC Remedy externalIdentifierType: Incident '@type': ExternalIdentifier '@schemaLocation': 'https://mycsp.com:8080/tmf-api/troubleTicket/5/schema/troubleTicket.yaml' '@type': TroubleTicket description: Here's an example of a request for retrieving a spesific trouble ticket with id 3180. TroubleTicketSpecification_with_filter_and_fields_list_example_response: value: - id: '453180' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/453180' name: Billing Dispute lifecycleStatus: active '@type': TroubleTicketSpecification - id: '453256' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/453256' name: Technical TroubleTicket Specification lifecycleStatus: active '@type': TroubleTicketSpecification - id: '454563' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/5/troubleTicketSpecification/454563' name: Network and latency TicketSpecification lifecycleStatus: active '@type': TroubleTicketSpecification description: >- Here's an example of a request for retrieving a list of trouble ticket specification(s). The given criteria is lifecycleStatus is active, and fields id,href,name,@type,lifecycleStatus TroubleTicketSpecification_list_example_response: value: - href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/453180' id: '453180' name: Bill Dispute lifecycleStatus: active '@type': TroubleTicketSpecification description: >- This trouble ticket specification describes the characteristic and rules to apply when creating a Trouble Ticket for Billing issues... creationDate: '2022-05-22T10:36:30.709Z' lastUpdate: '2022-06-22T10:36:30.709Z' relatedParty: - role: approver partyOrPartyRole: id: '6678' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/6678' name: Sara Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef specCharacteristic: - id: '1' configurable: true description: >- The amount that is on dispute, it can be the entire charge amount or partial amount of the charge maxCardinality: 0 minCardinality: 1 name: disputeAmount valueType: number '@type': CharacteristicSpecification - id: '2' configurable: true description: >- The positive amount to be credit, it can be equal or less than the dispute amount. In case credit is given a credit reason must be provided. In case no credit is given a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditAmount valueType: number charSpecRelationship: - '@type': CharacteristicSpecificationRelationship characteristicSpecificationId: '3' name: creditReason relationshipType: dependency parentSpecificationId: '25632415' '@type': CharacteristicSpecification - id: '3' configurable: true description: >- The reason for giving the credit, in case credit apply. In case no credit apply a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditReason valueType: string '@type': CharacteristicSpecification - id: '4' configurable: true description: 'The reason for rejecting the dispute, in case no credit apply.' maxCardinality: 0 minCardinality: 1 name: rejectReason valueType: string '@type': CharacteristicSpecification - id: '5' configurable: true description: Currency (ISO4217 norm uses 3 letters to define the currency) maxCardinality: 0 minCardinality: 1 name: currency valueType: string '@type': CharacteristicSpecification validFor: startDateTime: '2023-06-22T23:20:50.52Z' version: '1' - id: '453256' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/453256' name: Commerce Issue lifecycleStatus: active '@type': TroubleTicketSpecification description: >- This trouble ticket specification describes the characteristic and rules to apply when creating a Trouble Ticket for Commerce issues... creationDate: '2023-06-22T10:36:30.709Z' lastUpdate: '2023-06-23T10:36:30.709Z' relatedParty: - role: approver partyOrPartyRole: id: '6678' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/6678' name: Sara Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef specCharacteristic: - id: '1' configurable: true description: The Order reference nubmer that has an issue maxCardinality: 0 minCardinality: 1 name: orderReferenceNumber valueType: string '@type': CharacteristicSpecification - id: '2' configurable: true description: The creation date of the order that has an issue. maxCardinality: 0 minCardinality: 0 name: orderCreationDate valueType: string '@type': CharacteristicSpecification validFor: startDateTime: '2023-06-23T23:20:50.52Z' version: '1' description: >- Here's an example of a request for retrieving a list of trouble ticket specification(s). TroubleTicketSpecification_retrieve_example_response: value: href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/25632415' id: '25632415' name: Bill Dispute '@type': TroubleTicketSpecification description: >- This trouble ticket specification describes the characteristic and rules to apply when creating a Trouble Ticket... creationDate: '2022-05-22T10:36:30.709Z' lastUpdate: '2022-06-22T10:36:30.709Z' relatedParty: - role: approver partyOrPartyRole: id: '6678' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/6678' name: Sara Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef lifecycleStatus: active specCharacteristic: - id: '1' configurable: true description: >- The amount that is on dispute, it can be the entire charge amount or partial amount of the charge maxCardinality: 0 minCardinality: 1 name: disputeAmount valueType: number '@type': CharacteristicSpecification - id: '2' configurable: true description: >- The positive amount to be credit, it can be equal or less than the dispute amount. In case credit is given a credit reason must be provided. In case no credit is given a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditAmount valueType: number charSpecRelationship: - '@type': CharacteristicSpecificationRelationship characteristicSpecificationId: '3' name: creditReason relationshipType: dependency parentSpecificationId: '25632415' '@type': CharacteristicSpecification - id: '3' configurable: true description: >- The reason for giving the credit, in case credit apply. In case no credit apply a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditReason valueType: string '@type': CharacteristicSpecification - id: '4' configurable: true description: 'The reason for rejecting the dispute, in case no credit apply.' maxCardinality: 0 minCardinality: 1 name: rejectReason valueType: string '@type': CharacteristicSpecification - id: '5' configurable: true description: Currency (ISO4217 norm uses 3 letters to define the currency) maxCardinality: 0 minCardinality: 1 name: currency valueType: string '@type': CharacteristicSpecification validFor: startDateTime: '2022-06-22T23:20:50.52Z' version: '1' description: Here's an example of a request for retrieving a spesific trouble ticket specification. TroubleTicket_create_example_request: value: name: complaint over last bill description: >- I do not accept the last VOD charge, since the movie was constantly interrupted, I had to quick watching the movie in the middle severity: Major status: inProgress ticketType: Bill Dispute expectedResolutionDate: '2019-06-10T07:34:45.968Z' requestedResolutionDate: '2022-05-31T07:34:45.968Z' attachment: - id: '34345' description: Scanned disputed bill attachmentType: billCopy mimeType: image/png name: March Bill url: 'https://mycsp.com:7070/docloader?docnum=3534555' '@type': Attachment channel: id: '8774' name: self service '@type': ChannelRef note: - id: '77456' author: Jack Smith date: '2022-05-31T07:34:45.968Z' text: 'This is quite important, please aproch me as soon as posible' '@type': Note relatedEntity: - role: disputedBill '@type': RelatedEntity entity: id: '3472' href: 'https://mycsp.com:8080/tmf-api/customerBillManagement/v5/customerBill/8297' name: March 2019 Bill '@type': EntityRef '@referredType': CustomerBill relatedParty: - role: member '@type': RelatedPartyRefOrPartyRoleRef partyOrPartyRole: id: '9866' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9866' name: Sandy Smith '@type': PartyRef '@referredType': Individual - role: reporter '@type': RelatedPartyRefOrPartyRoleRef partyOrPartyRole: id: '9867' name: Jacob Jac Miller '@type': PartyRef '@referredType': Individual - role: customer '@type': RelatedPartyRefOrPartyRoleRef partyOrPartyRole: id: '9176' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/customer/9176' name: Jack Smith '@type': PartyRoleRef '@referredType': Customer '@type': TroubleTicket description: >- POST trouble ticket request example - only a subset of trouble ticket attributes are used in this example TroubleTicket_create_example_response: value: id: '3180' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3180' creationDate: '2022-05-31T07:34:45.968Z' description: >- I do not accept the last VOD charge, since the movie was constantly interrupted, I had to quick watching the movie in the middle expectedResolutionDate: '2019-06-10T07:34:45.968Z' lastUpdate: '2022-05-31T07:34:45.968Z' name: complaint over last bill priority: High requestedResolutionDate: '2019-05-31T07:34:45.968Z' severity: Major status: pending statusChangeDate: '2019-05-31T07:34:45.968Z' statusChangeReason: Need more information from the customer ticketType: Bill Dispute attachment: - description: Scanned disputed bill attachmentType: billCopy mimeType: image/png name: March Bill url: 'https://mycsp.com:7070/docloader?docnum=3534555' '@type': Attachment channel: id: '8774' name: self service '@type': ChannelRef note: - id: '77456' author: Jack Smith date: '2019-05-31T07:34:45.968Z' text: 'This is quite important, please approach me as soon as possible' '@type': Note relatedEntity: - role: disputedBill '@type': RelatedEntity entity: id: '3472' href: 'https://mycsp.com:8080/tmf-api/customerBillManagement/v5/customerBill/8297' name: March 2019 Bill '@type': EntityRef '@referredType': CustomerBill relatedParty: - role: member partyOrPartyRole: id: '9866' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9866' name: Sandy Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: reporter partyOrPartyRole: id: '9877' name: Jacob Jac Miller '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: customer partyOrPartyRole: id: '9176' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/customer/9176' name: Jack Smith '@type': PartyRoleRef '@referredType': Customer '@type': RelatedPartyRefOrPartyRoleRef statusChangeHistory: - statusChangeDate: '2019-05-31T07:34:45.968Z' statusChangeReason: Need more information from the customer status: pending '@type': StatusChange troubleTicketRelationship: - id: '567433' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/567433' name: Network Coverage relationshipType: dependecy '@type': TroubleTicketRelationship '@schemaLocation': 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/schema/troubleTicket.yaml' '@type': TroubleTicket description: POST Trouble Ticket response description. TroubleTicketSpecification_create_example_request: value: '@type': TroubleTicketSpecification description: >- This trouble ticket specification describes the characteristic and rules to apply when creating a Trouble Ticket... name: Bill Dispute relatedParty: - role: approver '@type': RelatedPartyRefOrPartyRoleRef partyOrPartyRole: id: '6678' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/6678' name: Sara Smith '@type': PartyRef '@referredType': Individual specCharacteristic: - id: '1' configurable: true description: >- The amount that is on dispute, it can be the entire charge amount or partial amount of the charge maxCardinality: 0 minCardinality: 1 name: disputeAmount valueType: number '@type': CharacteristicSpecification - id: '2' configurable: true description: >- The positive amount to be credit, it can be equal or less than the dispute amount. In case credit is given a credit reason must be provided. In case no credit is given a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditAmount valueType: number '@type': CharacteristicSpecification charSpecRelationship: - '@type': CharacteristicSpecificationRelationship '@baseType': CharacteristicSpecificationRelationship '@schemaLocation': /someUri characteristicSpecificationId: '3' name: creditReason relationshipType: dependency parentSpecificationId: '25632415' - id: '3' configurable: true description: >- The reason for giving the credit, in case credit apply. In case no credit apply a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditReason valueType: string '@type': CharacteristicSpecification - id: '4' configurable: true description: 'The reason for rejecting the dispute, in case no credit apply.' maxCardinality: 0 minCardinality: 1 name: rejectReason valueType: string '@type': CharacteristicSpecification - id: '5' configurable: true description: Currency (ISO4217 norm uses 3 letters to define the currency) maxCardinality: 0 minCardinality: 1 name: currency valueType: string '@type': CharacteristicSpecification validFor: startDateTime: '2022-06-22T23:20:50.52Z' version: '1' description: >- POST trouble ticket request example - only a subset of trouble ticket specification attributes are used in this example TroubleTicketSpecification_create_example_response: value: href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/25632415' id: '25632415' '@type': TroubleTicketSpecification description: >- This trouble ticket specification describes the characteristic and rules to apply when creating a Trouble Ticket... creationDate: '2022-05-22T10:36:30.709Z' lastUpdate: '2022-06-22T10:36:30.709Z' name: Bill Dispute relatedParty: - role: approver '@type': RelatedPartyRefOrPartyRoleRef partyOrPartyRole: id: '6678' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/6678' name: Sara Smith '@type': PartyRef '@referredType': Individual lifecycleStatus: inDesgin specCharacteristic: - id: '1' configurable: true description: >- The amount that is on dispute, it can be the entire charge amount or partial amount of the charge maxCardinality: 0 minCardinality: 1 name: disputeAmount valueType: number '@type': CharacteristicSpecification - id: '2' configurable: true description: >- The positive amount to be credit, it can be equal or less than the dispute amount. In case credit is given a credit reason must be provided. In case no credit is given a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditAmount valueType: number '@type': CharacteristicSpecification charSpecRelationship: - '@type': CharacteristicSpecificationRelationship '@schemaLocation': string characteristicSpecificationId: '3' name: creditReason relationshipType: dependency parentSpecificationId: '25632415' - id: '3' configurable: true description: >- The reason for giving the credit, in case credit apply. In case no credit apply a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditReason valueType: string '@type': CharacteristicSpecification - id: '4' configurable: true description: 'The reason for rejecting the dispute, in case no credit apply.' maxCardinality: 0 minCardinality: 1 name: rejectReason valueType: string '@type': CharacteristicSpecification - id: '5' configurable: true description: Currency (ISO4217 norm uses 3 letters to define the currency) maxCardinality: 0 minCardinality: 1 name: currency valueType: string '@type': CharacteristicSpecification validFor: startDateTime: '2022-06-22T23:20:50.52Z' version: '1' description: POST Trouble Ticket Specification response description. TroubleTicket_partialupdate_example_application_json_request: value: '@type': TroubleTicket status: resolved statusChangeReason: Give credit and resent bill to customer description: >- Here's an example of a request for updating a trouble ticket - set status to resolved. This example illustrating patch application/json TroubleTicket_partialupdate_example_application_json_response: value: id: '3180' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3180' creationDate: '2022-05-31T07:34:45.968Z' description: >- I do not accept the last VOD charge, since the movie was constantly interrupted, I had to quick watching the movie in the middle expectedResolutionDate: '2019-06-10T07:34:45.968Z' lastUpdate: '2022-06-01T07:34:45.968Z' name: complaint over last bill priority: High requestedResolutionDate: '2022-05-31T07:34:45.968Z' resolutionDate: '2022-06-01T07:34:45.968Z' severity: Major status: resolved statusChangeDate: '2022-06-01T07:34:45.968Z' statusChangeReason: Give credit and resent bill to customer ticketType: Bill Dispute attachment: - description: Scanned disputed bill attachmentType: billCopy mimeType: image/png name: March Bill url: 'https://mycsp.com:7070/docloader?docnum=3534555' '@type': Attachment channel: id: '8774' name: self service '@type': ChannelRef note: - id: '77456' author: Jack Smith date: '2022-05-31T07:34:45.968Z' text: 'This is quite important, please approach me as soon as possible' '@type': Note relatedEntity: - role: disputedBill '@type': RelatedEntity entity: id: '3472' href: 'https://mycsp.com:8080/tmf-api/customerBillManagement/v5/customerBill/8297' name: March 2019 Bill '@type': EntityRef '@referredType': CustomerBill relatedParty: - role: member partyOrPartyRole: id: '9866' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9866' name: Sandy Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: reporter partyOrPartyRole: id: '9877' name: Jacob Jac Miller '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: customer partyOrPartyRole: id: '9176' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/customer/9176' name: Jack Smith '@type': PartyRoleRef '@referredType': Customer '@type': RelatedPartyRefOrPartyRoleRef statusChangeHistory: - statusChangeDate: '2022-05-31T07:34:45.968Z' statusChangeReason: Need more information from the customer status: pending '@type': StatusChange - statusChangeDate: '2022-06-01T07:34:45.968Z' statusChangeReason: Give credit and resent bill to customer status: resolved '@type': StatusChange troubleTicketRelationship: - id: '567433' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/567433' name: Network Coverage relationshipType: dependecy '@type': TroubleTicketRelationship '@schemaLocation': 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/schema/troubleTicket.yml' '@type': TroubleTicket description: Response message TroubleTicket_partialupdate_example_application_merge_json_request: value: '@type': TroubleTicket status: resolved statusChangeReason: Give credit and resent bill to customer description: >- Here's an example of a request for updating a trouble ticket - set status to resolved. This example illustrating patch merge, When PATCH is implemeted merge syntax is mandatory TroubleTicket_partialupdate_example_application_merge_json_response: value: id: '3180' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3180' creationDate: '2022-05-31T07:34:45.968Z' description: >- I do not accept the last VOD charge, since the movie was constantly interrupted, I had to quick watching the movie in the middle expectedResolutionDate: '2019-06-10T07:34:45.968Z' lastUpdate: '2022-06-01T07:34:45.968Z' name: complaint over last bill priority: High requestedResolutionDate: '2022-05-31T07:34:45.968Z' resolutionDate: '2022-06-01T07:34:45.968Z' severity: Major status: resolved statusChangeDate: '2022-06-01T07:34:45.968Z' statusChangeReason: Give credit and resent bill to customer ticketType: Bill Dispute attachment: - description: Scanned disputed bill attachmentType: billCopy mimeType: image/png name: March Bill url: 'https://mycsp.com:7070/docloader?docnum=3534555' '@type': Attachment channel: id: '8774' name: self service '@type': ChannelRef note: - id: '77456' author: Jack Smith date: '2022-05-31T07:34:45.968Z' text: 'This is quite important, please approach me as soon as possible' '@type': Note relatedEntity: - role: disputedBill '@type': RelatedEntity entity: id: '3472' href: 'https://mycsp.com:8080/tmf-api/customerBillManagement/v5/customerBill/8297' name: March 2019 Bill '@type': EntityRef '@referredType': CustomerBill relatedParty: - role: member partyOrPartyRole: id: '9866' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9866' name: Sandy Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: reporter partyOrPartyRole: id: '9877' name: Jacob Jac Miller '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: customer partyOrPartyRole: id: '9176' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/customer/9176' name: Jack Smith '@type': PartyRoleRef '@referredType': Customer '@type': RelatedPartyRefOrPartyRoleRef statusChangeHistory: - statusChangeDate: '2022-05-31T07:34:45.968Z' statusChangeReason: Need more information from the customer status: pending '@type': StatusChange - statusChangeDate: '2022-06-01T07:34:45.968Z' statusChangeReason: Give credit and resent bill to customer status: resolved '@type': StatusChange troubleTicketRelationship: - id: '567433' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/567433' name: Network Coverage relationshipType: dependecy '@type': TroubleTicketRelationship '@schemaLocation': 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/schema/troubleTicket.yml' '@type': TroubleTicket description: Response message TroubleTicket_partialupdate_example_application_json_patch_request: value: - op: replace path: /severity value: Minor - op: add path: /note value: '@type': Note id: '77456' author: Jack Smith text: 'This is quite important, please approach me as soon as possible' description: >- Here's an example of a request for updating a trouble ticket - set severity to Minor and add new Note. This example illustrating patch json TroubleTicket_partialupdate_example_application_json_patch_response: value: id: '3180' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3180' creationDate: '2022-05-31T07:34:45.968Z' description: >- I do not accept the last VOD charge, since the movie was constantly interrupted, I had to quick watching the movie in the middle expectedResolutionDate: '2019-06-10T07:34:45.968Z' lastUpdate: '2022-05-31T07:34:45.968Z' name: complaint over last bill priority: Medium requestedResolutionDate: '2022-05-31T07:34:45.968Z' severity: Minor status: pending statusChangeDate: '2022-05-31T07:34:45.968Z' statusChangeReason: Need more information from the customer ticketType: Bill Dispute attachment: - description: Scanned disputed bill attachmentType: billCopy mimeType: image/png name: March Bill url: 'https://mycsp.com:7070/docloader?docnum=3534555' '@type': Attachment channel: id: '8774' name: self service '@type': ChannelRef note: - id: '77456' author: Jack Smith date: '2019-05-31T07:34:45.968Z' text: 'This is quite important, please approach me as soon as possible' '@type': Note relatedEntity: - role: disputedBill '@type': RelatedEntity entity: id: '3472' href: 'https://mycsp.com:8080/tmf-api/customerBillManagement/v5/customerBill/8297' name: March 2019 Bill '@type': EntityRef '@referredType': CustomerBill relatedParty: - role: member partyOrPartyRole: id: '9866' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9866' name: Sandy Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: reporter partyOrPartyRole: id: '9877' name: Jacob Jac Miller '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: customer partyOrPartyRole: id: '9176' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/customer/9176' name: Jack Smith '@type': PartyRoleRef '@referredType': Customer '@type': RelatedPartyRefOrPartyRoleRef statusChangeHistory: - statusChangeDate: '2019-05-31T07:34:45.968Z' statusChangeReason: Need more information from the customer status: pending '@type': StatusChange troubleTicketRelationship: - id: '567433' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/567433' name: Network Coverage relationshipType: dependecy '@type': TroubleTicketRelationship '@schemaLocation': 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/schema/troubleTicket.yml' '@type': TroubleTicket description: Response message TroubleTicket_partialupdate_example_application_json_patch_query_request: value: - op: replace path: /sererity value: Minor - op: replace path: /note?id=77456 value: author: Jack Smith text: Please approach me as soon as possible. Thanks in advance description: >- Here's an example of a request for updating a trouble ticket - set severity to Minor and update a specific Nate. This example illustrating patch json TroubleTicket_partialupdate_example_application_json_patch_query_response: value: id: '3180' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3180' creationDate: '2022-05-31T07:34:45.968Z' description: >- I do not accept the last VOD charge, since the movie was constantly interrupted, I had to quick watching the movie in the middle expectedResolutionDate: '2019-06-10T07:34:45.968Z' lastUpdate: '2022-05-31T07:34:45.968Z' name: complaint over last bill priority: High requestedResolutionDate: '2022-05-31T07:34:45.968Z' severity: Minor status: pending statusChangeDate: '2022-05-31T07:34:45.968Z' statusChangeReason: Need more information from the customer ticketType: Bill Dispute attachment: - description: Scanned disputed bill attachmentType: billCopy mimeType: image/png name: March Bill url: 'https://mycsp.com:7070/docloader?docnum=3534555' '@type': Attachment channel: id: '8774' name: self service '@type': ChannelRef note: - id: '77456' author: Jack Smith date: '2022-05-31T07:34:45.968Z' text: Please approach me as soon as possible. Thanks in advance '@type': Note relatedEntity: - role: disputedBill '@type': RelatedEntity entity: id: '3472' href: 'https://mycsp.com:8080/tmf-api/customerBillManagement/v5/customerBill/8297' name: March 2019 Bill '@type': EntityRef '@referredType': CustomerBill relatedParty: - role: member partyOrPartyRole: id: '9866' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9866' name: Sandy Smith '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: reporter partyOrPartyRole: id: '9877' name: Jacob Jac Miller '@type': PartyRef '@referredType': Individual '@type': RelatedPartyRefOrPartyRoleRef - role: customer partyOrPartyRole: id: '9176' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/customer/9176' name: Jack Smith '@type': PartyRoleRef '@referredType': Customer '@type': RelatedPartyRefOrPartyRoleRef troubleTicketRelationship: - id: '567433' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/567433' name: Network Coverage relationshipType: dependecy '@type': TroubleTicketRelationship '@schemaLocation': 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/schema/troubleTicket.yml' '@type': TroubleTicket description: Response message TroubleTicketSpecification_partialupdate_application_json_request: value: lifecycleStatus: active description: Bill Dispute Specification '@type': TroubleTicketSpecification description: >- Here's an example of a request for updating a trouble ticket - set status to active and update description. This example illustrating patch merge, When PATCH is implemeted merge syntax is mandatory TroubleTicketSpecification_partialupdate_application_json_response: value: href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/25632415' id: '25632415' '@type': TroubleTicketSpecification description: >- This trouble ticket specification describes the characteristic and rules to apply when creating a Trouble Ticket... creationDate: '2022-05-22T10:36:30.709Z' lastUpdate: '2022-06-22T10:36:30.709Z' name: Bill Dispute Specification relatedParty: - role: approver '@type': RelatedPartyRefOrPartyRoleRef partyOrPartyRole: id: '6678' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/6678' name: Sara Smith '@type': PartyRef '@referredType': Individual lifecycleStatus: active specCharacteristic: - id: '1' name: disputeAmount valueType: number configurable: true description: >- The amount that is on dispute, it can be the entire charge amount or partial amount of the charge maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification - id: '2' name: creditAmount valueType: number configurable: true description: >- The positive amount to be credit, it can be equal or less than the dispute amount. In case credit is given a credit reason must be provided. In case no credit is given a reject reason must be provided maxCardinality: 0 minCardinality: 1 charSpecRelationship: - '@type': CharacteristicSpecificationRelationship '@baseType': string '@schemaLocation': string characteristicSpecificationId: '3' name: creditReason relationshipType: dependency parentSpecificationId: '25632415' '@type': CharacteristicSpecification - id: '3' name: creditReason valueType: string configurable: true description: >- The reason for giving the credit, in case credit apply. In case no credit apply a reject reason must be provided maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification - id: '4' name: rejectReason valueType: string configurable: true description: 'The reason for rejecting the dispute, in case no credit apply.' maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification - id: '5' name: currency valueType: string configurable: true description: Currency (ISO4217 norm uses 3 letters to define the currency) maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification validFor: startDateTime: '2022-06-22T23:20:50.52Z' version: '1' description: Response message TroubleTicketSpecification_partialupdate_application_merge_json_request: value: lifecycleStatus: active description: Bill Dispute Specification '@type': TroubleTicketSpecification description: >- Here's an example of a request for updating a trouble ticket - set status to active and update description. This example illustrating patch merge, When PATCH is implemeted merge syntax is mandatory TroubleTicketSpecification_partialupdate_application_merge_json_response: value: href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/25632415' id: '25632415' '@type': TroubleTicketSpecification description: >- This trouble ticket specification describes the characteristic and rules to apply when creating a Trouble Ticket... creationDate: '2022-05-22T10:36:30.709Z' lastUpdate: '2022-06-22T10:36:30.709Z' name: Bill Dispute Specification relatedParty: - role: approver '@type': RelatedPartyRefOrPartyRoleRef partyOrPartyRole: id: '6678' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/6678' name: Sara Smith '@type': PartyRef '@referredType': Individual lifecycleStatus: active specCharacteristic: - id: '1' name: disputeAmount valueType: number configurable: true description: >- The amount that is on dispute, it can be the entire charge amount or partial amount of the charge maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification - id: '2' name: creditAmount valueType: number configurable: true description: >- The positive amount to be credit, it can be equal or less than the dispute amount. In case credit is given a credit reason must be provided. In case no credit is given a reject reason must be provided maxCardinality: 0 minCardinality: 1 charSpecRelationship: - '@type': CharacteristicSpecificationRelationship '@baseType': string '@schemaLocation': string characteristicSpecificationId: '3' name: creditReason relationshipType: dependency parentSpecificationId: '25632415' '@type': CharacteristicSpecification - id: '3' name: creditReason valueType: string configurable: true description: >- The reason for giving the credit, in case credit apply. In case no credit apply a reject reason must be provided maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification - id: '4' name: rejectReason valueType: string configurable: true description: 'The reason for rejecting the dispute, in case no credit apply.' maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification - id: '5' name: currency valueType: string configurable: true description: Currency (ISO4217 norm uses 3 letters to define the currency) maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification validFor: startDateTime: '2022-06-22T23:20:50.52Z' version: '1' description: Response message TroubleTicketSpecification_partialupdate_application_json_patch_request: value: - op: replace path: /lifecycleStatus value: active - op: replace path: /name value: Bill Dispute Specification description: >- Here's an example of a request for updating a trouble ticket spesification - set status to active and update description. This example illustrating patch json TroubleTicketSpecification_partialupdate_application_json_patch_response: value: href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/25632415' id: '25632415' '@type': TroubleTicketSpecification description: >- This trouble ticket specification describes the characteristic and rules to apply when creating a Trouble Ticket... creationDate: '2022-05-22T10:36:30.709Z' lastUpdate: '2022-06-22T10:36:30.709Z' name: Bill Dispute Specification relatedParty: - role: approver '@type': RelatedPartyRefOrPartyRoleRef partyOrPartyRole: id: '6678' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/6678' name: Sara Smith '@type': PartyRef '@referredType': Individual lifecycleStatus: active specCharacteristic: - id: '1' configurable: true description: >- The amount that is on dispute, it can be the entire charge amount or partial amount of the charge maxCardinality: 0 minCardinality: 1 name: disputeAmount valueType: number '@type': CharacteristicSpecification - id: '2' configurable: true description: >- The positive amount to be credit, it can be equal or less than the dispute amount. In case credit is given a credit reason must be provided. In case no credit is given a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditAmount valueType: number '@type': CharacteristicSpecification charSpecRelationship: - '@type': CharacteristicSpecificationRelationship characteristicSpecificationId: '3' name: creditReason relationshipType: dependency parentSpecificationId: '25632415' - id: '3' configurable: true description: >- The reason for giving the credit, in case credit apply. In case no credit apply a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditReason valueType: string '@type': CharacteristicSpecification - id: '4' configurable: true description: 'The reason for rejecting the dispute, in case no credit apply.' maxCardinality: 0 minCardinality: 1 name: rejectReason valueType: string '@type': CharacteristicSpecification - id: '5' configurable: true description: Currency (ISO4217 norm uses 3 letters to define the currency) maxCardinality: 0 minCardinality: 1 name: currency valueType: string '@type': CharacteristicSpecification validFor: startDateTime: '2022-06-22T23:20:50.52Z' version: '1' description: Response message TroubleTicketSpecification_partialupdate_application_json_patch_query_request: value: - op: replace path: /specCharacteristic?id=5 value: configurable: false description: >- Here's an example of a request for updating a trouble ticket - set characteristic id=5 to readonly. This example illustrating patch query json TroubleTicketSpecification_partialupdate_application_json_patch_query_response: value: href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/25632415' id: '25632415' '@type': TroubleTicketSpecification description: >- This trouble ticket specification describes the characteristic and rules to apply when creating a Trouble Ticket... creationDate: '2022-05-22T10:36:30.709Z' lastUpdate: '2022-06-22T10:36:30.709Z' name: Bill Dispute Specification relatedParty: - role: approver '@type': RelatedPartyRefOrPartyRoleRef partyOrPartyRole: id: '6678' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/6678' name: Sara Smith '@type': PartyRef '@referredType': Individual lifecycleStatus: active specCharacteristic: - id: '1' configurable: true description: >- The amount that is on dispute, it can be the entire charge amount or partial amount of the charge maxCardinality: 0 minCardinality: 1 name: disputeAmount valueType: number '@type': CharacteristicSpecification - id: '2' configurable: true description: >- The positive amount to be credit, it can be equal or less than the dispute amount. In case credit is given a credit reason must be provided. In case no credit is given a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditAmount valueType: number charSpecRelationship: - '@type': CharacteristicSpecificationRelationship characteristicSpecificationId: '3' name: creditReason relationshipType: dependency parentSpecificationId: '25632415' '@type': CharacteristicSpecification - id: '3' configurable: true description: >- The reason for giving the credit, in case credit apply. In case no credit apply a reject reason must be provided maxCardinality: 0 minCardinality: 1 name: creditReason valueType: string '@type': CharacteristicSpecification - id: '4' configurable: true description: 'The reason for rejecting the dispute, in case no credit apply.' maxCardinality: 0 minCardinality: 1 name: rejectReason valueType: string '@type': CharacteristicSpecification - id: '5' configurable: false description: Currency (ISO4217 norm uses 3 letters to define the currency) maxCardinality: 0 minCardinality: 1 name: currency valueType: string '@type': CharacteristicSpecification validFor: startDateTime: '2022-06-22T23:20:50.52Z' version: '1' description: Response message TroubleTicketCreateEvent_request: value: correlationId: 95003dd3-e325 description: TroubleTicketCreateEvent illustration domain: Commercial eventId: 4010-9b59-509a64cf85a8 eventTime: '2022-08-25T12:18:12.171Z' eventType: TroubleTicketCreateEvent priority: '1' timeOccurred: '2022-08-25T12:18:06.252Z' title: TroubleTicketCreateEvent event: troubleTicket: id: '3180' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/3180' creationDate: '2022-05-31T07:34:45.968Z' description: >- I do not accept the last VOD charge, since the movie was constantly interrupted, I had to quit watching the movie in the middle expectedResolutionDate: '2019-06-10T07:34:45.968Z' lastUpdate: '2022-05-31T07:34:45.968Z' name: complaint over last bill priority: High requestedResolutionDate: '2022-05-31T07:34:45.968Z' resolutionDate: '2022-05-31T07:34:45.968Z' severity: Minor status: resolved statusChangeDate: '2022-05-31T07:34:45.968Z' statusChangeReason: Apply full credit ticketType: Bill Dispute troubleTicketSpecification: id: '25632415' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/25632415' name: Bill Dispute version: '1' '@type': TroubleTicketSpecificationRef '@referredType': TroubleTicketSpecification '@baseType': TroubleTicketSpecificationRef '@schemaLocation': 'https://github.com/mycsp/schemas/v5/TroubleTicketSpecificationRef.schema.json' troubleTicketCharacteristic: - id: '1' name: disputeAmount valueType: number value: 40 '@type': NumberCharacteristic '@baseType': Characteristic '@schemaLocation': 'https://github.com/mycsp/schemas/v5/NumberCharacteristic.schema.json' - id: '2' name: creditAmount valueType: number value: 40 characteristicRelationship: - id: '4' relationshipType: dependency '@type': CharacteristicRelationship '@baseType': CharacteristicRelationship '@schemaLocation': 'https://github.com/mycsp/schemas/v5/CharacteristicRelationship.schema.json' '@type': NumberCharacteristic '@baseType': Characteristic '@schemaLocation': 'https://github.com/mycsp/schemas/v5/Characteristic.schema.json' - id: '3' name: currency valueType: string value: USD '@type': StringCharacteristic '@baseType': Characteristic '@schemaLocation': 'https://github.com/mycsp/schemas/v5/StringCharacteristic.schema.json' - id: '4' name: creditReason valueType: string value: Network connectivity issues '@type': StringCharacteristic '@baseType': Characteristic '@schemaLocation': 'https://github.com/mycsp/schemas/v5/StringCharacteristic.schema.json' attachment: - id: '34345' href: 'https://mycsp.com:8080/tmf-api/attachment/v5/attachment/34345' description: Scanned disputed bill name: March Bill '@baseType': AttchmentRef '@type': AttachmentRef '@referredType': Attachment '@schemaLocation': 'https://github.com/mycsp/schemas/v5/AttachmentRef.schema.json' channel: id: '8774' href: 'https://mycsp.com:8080/tmf-api/channelManagement/v5/Channel/8774' name: self service '@type': ChannelRef '@baseType': ChannelRef '@referredType': Channel '@schemaLocation': 'https://github.com/mycsp/schemas/v5/ChannelRef.schema.json' note: - id: '77456' author: Jack Smith date: '2019-05-31T07:34:45.968Z' text: 'This is quite important, please approach me as soon as possible' '@type': Note '@baseType': Note '@schemaLocation': 'https://github.com/mycsp/schemas/v5/Note.schema.json' relatedEntity: - role: disputedBill entity: id: '3472' href: 'https://mycsp.com:8080/tmf-api/customerBillManagement/v5/customerBill/3472' name: March 2019 Bill '@type': EntityRef '@referredType': CustomerBill '@baseType': EntityRef '@schemaLocation': 'https://github.com/mycsp/schemas/v5/EntityRef.schema.json' '@type': RelatedEntity '@baseType': RelatedEntity '@schemaLocation': 'https://github.com/mycsp/schemas/v5/RelatedEntity.schema.json' relatedParty: - role: member partyOrPartyRole: id: '9866' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9866' name: Sandy Smith '@type': PartyRef '@referredType': Individual '@baseType': PartyRef '@schemaLocation': 'https://github.com/mycsp/schemas/v5/PartyRef.schema.json' '@type': RelatedPartyRefOrPartyRoleRef '@baseType': RelatedPartyRefOrPartyRoleRef '@schemaLocation': 'https://github.com/mycsp/schemas/v5/RelatedPartyRefOrPartyRoleRef.schema.json' - role: reporter partyOrPartyRole: id: '9867' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/9867' name: Jacob Jac Miller '@type': PartyRef '@referredType': Individual '@baseType': PartyRef '@schemaLocation': 'https://github.com/mycsp/schemas/v5/PartyRef.schema.json' '@type': RelatedPartyRefOrPartyRoleRef '@baseType': RelatedPartyRefOrPartyRoleRef '@schemaLocation': 'https://github.com/mycsp/schemas/v5/RelatedPartyRefOrPartyRoleRef.schema.json' - role: customer partyOrPartyRole: id: '9176' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/customer/9176' name: Jack Smith Family partyId: '9177' partyName: Jack Smith '@type': PartyRoleRef '@referredType': Customer '@baseType': PartyRoleRef '@schemaLocation': 'https://github.com/mycsp/schemas/v5/PartyRoleRef.schema.json' '@type': RelatedPartyRefOrPartyRoleRef '@baseType': RelatedPartyRefOrPartyRoleRef '@schemaLocation': 'https://github.com/mycs/pschemas/v5/RelatedPartyRefOrPartyRoleRef.schema.json' statusChangeHistory: - statusChangeDate: '2022-05-28T07:34:45.968Z' statusChangeReason: 'trouble ticket created ' status: acknowledged '@type': StatusChange '@baseType': StatusChange '@schemaLocation': 'https://github.com/mycsp/schemas/v5/StatusChange.schema.json' - statusChangeDate: '2022-05-28T08:34:45.968Z' statusChangeReason: start process status: inProgress '@type': StatusChange '@baseType': StatusChange '@schemaLocation': 'https://github.com/mycsp/schemas/v5/StatusChange.schema.json' - statusChangeDate: '2022-05-29T07:34:45.968Z' statusChangeReason: Need more information from the customer status: pending '@type': StatusChange '@baseType': StatusChange '@schemaLocation': 'https://github.com/mycsp/schemas/v5/StatusChange.schema.json' - statusChangeDate: '2022-05-31T07:34:45.968Z' statusChangeReason: Apply full credit status: resolved '@type': StatusChange '@baseType': StatusChange '@schemaLocation': 'https://github.com/mycsp/schemas/v5/StatusChange.schema.json' troubleTicketRelationship: - id: '567433' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicket/567433' name: Network Coverage relationshipType: dependecy '@type': TroubleTicketRelationship '@referredType': TroubleTicket '@baseType': TroubleTicketRelationship '@schemaLocation': 'https://github.com/mycsp/schemas/v5/TroubleTicketRelationship.schema.json' externalIdentifier: - id: '3331234' owner: BMC Remedy externalIdentifierType: Incident '@type': ExternalIdentifier '@baseType': ExternalIdentifier '@schemaLocation': 'https://github.com/mycsp/schemas/v5/ExternalIdentifier.schema.json' '@type': TroubleTicket '@baseType': TroubleTicket '@schemaLocation': 'https://github.com/mycsp/schemas/v5/TroubleTicket.schema.json' reportingSystem: id: '759' name: APP-745 '@type': ReportingResource '@referredType': LogicalResource source: id: '705' name: APP-317 '@type': ReportingResource '@referredType': LogicalResource '@baseType': Event '@type': TroubleTicketCreateEvent description: Message example for TroubleTicketCreateEvent event TroubleTicket_listener_troubleTicketCreateEvent_POST_204_1_request: value: '@type': TroubleTicketCreateEvent '@baseType': MGNOO '@schemaLocation': YJEDX href: MTEXW id: CCDHH correlationId: PALEV domain: NUVRK title: ECURP description: LEPGY priority: QXDEE timeOccurred: '2025-05-05T12:23:35Z' source: '@type': BJSXY '@baseType': EXXLX '@schemaLocation': TMWGO href: SQTXY id: EVOXQ name: NXGOB '@referredType': FIVCV reportingSystem: '@type': ETAVV '@baseType': JYATV '@schemaLocation': XSVLG href: RYBGR id: LXMXU name: JPHUQ '@referredType': YSKTD relatedParty: - '@type': RelatedPartyRefOrPartyRoleRef '@baseType': TBFUA '@schemaLocation': SMLPH role: IKDHQ partyOrPartyRole: '@type': PartyRef '@baseType': LLFEJ '@schemaLocation': EPPLD href: HHGQS id: PBRIU name: CNGSV '@referredType': FOYOT analyticCharacteristic: - '@type': BooleanArrayCharacteristic '@baseType': PJYQO '@schemaLocation': QQJHN id: QGBFG name: QYDGG valueType: DOYTH characteristicRelationship: - '@type': CharacteristicRelationship '@baseType': WJKRX '@schemaLocation': LDOOE id: PMBLV relationshipType: RALDQ value: - false - true - '@type': BooleanArrayCharacteristic '@baseType': LATHA '@schemaLocation': HRIWV id: KEFPW name: EVSDK valueType: LAUVE characteristicRelationship: - '@type': CharacteristicRelationship '@baseType': TYNPL '@schemaLocation': PDBTF id: PJEFC relationshipType: ISIMH value: - false eventId: SOVHF eventTime: '2025-05-05T12:23:35Z' eventType: CXJAD event: troubleTicket: '@type': TroubleTicket '@baseType': IOSLD '@schemaLocation': FQMNX href: LJWMS id: WLIAH name: UAGHM description: FFNTR severity: PRETR ticketType: HQXCG attachment: - '@type': Attachment '@baseType': KTVDG '@schemaLocation': IIOSS href: DYIQF id: HCDXE name: WEIGQ description: WCMNY url: XOVTW content: HBWEM size: amount: 545 units: VTKHI validFor: startDateTime: '2025-05-05T12:23:35Z' endDateTime: '2025-05-05T12:23:35Z' attachmentType: DHGVA mimeType: VBLEV - '@type': Attachment '@baseType': AIMEI '@schemaLocation': WPVLO href: DEMOR id: VCWJV name: CJRMJ description: FTBFH url: CVJRA content: PEWQR size: amount: 424 units: TEVFQ validFor: startDateTime: '2025-05-05T12:23:35Z' endDateTime: '2025-05-05T12:23:35Z' attachmentType: UCTBF mimeType: SJFIT channel: '@type': ChannelRef '@baseType': XHOAW '@schemaLocation': VIUKY href: GMXAQ id: PHFLO name: FSBBY '@referredType': ASFFO creationDate: '2025-05-05T12:23:35Z' requestedResolutionDate: '2025-05-05T12:23:35Z' expectedResolutionDate: '2025-05-05T12:23:35Z' resolutionDate: '2025-05-05T12:23:35Z' externalIdentifier: - '@type': ExternalIdentifier '@baseType': SFUHC '@schemaLocation': WATEM owner: OFNSI externalIdentifierType: ICRVN id: TBQYI - '@type': ExternalIdentifier '@baseType': BESVU '@schemaLocation': NBHMU owner: NJWBC externalIdentifierType: XOBMF id: WHDJB lastUpdate: '2025-05-05T12:23:35Z' note: - '@type': Note '@baseType': XCKDJ '@schemaLocation': MIEXF id: QOKPV author: SKVQW date: '2025-05-05T12:23:35Z' text: LQERS - '@type': Note '@baseType': FTSMD '@schemaLocation': GOBYB id: NDMYX author: NGJID date: '2025-05-05T12:23:35Z' text: GUYEG priority: OMNAD relatedEntity: - '@type': RelatedEntity '@baseType': LCGNA '@schemaLocation': EJMKN role: ILAKE entity: '@type': CEPEW '@baseType': QDPBL '@schemaLocation': EMSWA href: VJABE id: LVXIG name: CHTSA '@referredType': EGDDO relatedParty: - '@type': RelatedPartyRefOrPartyRoleRef '@baseType': SQJYY '@schemaLocation': UPPXM role: VORTU partyOrPartyRole: '@type': PartyRef '@baseType': SQHUY '@schemaLocation': QCCYS href: TTEMX id: DCNXW name: CUVXO '@referredType': VQQAI - '@type': RelatedPartyRefOrPartyRoleRef '@baseType': DKQIX '@schemaLocation': YSRWL role: LUTLF partyOrPartyRole: '@type': PartyRef '@baseType': YLTED '@schemaLocation': BKWYO href: ECVYC id: PJHRD name: TTMFN '@referredType': IFFWS status: acknowledged statusChangeDate: '2025-05-05T12:23:35Z' statusChangeReason: TGJBB statusChangeHistory: - '@type': StatusChange '@baseType': MJUTN '@schemaLocation': JVNNE statusChangeDate: '2025-05-05T12:23:35Z' statusChangeReason: OWNRJ status: acknowledged - '@type': StatusChange '@baseType': OBSPM '@schemaLocation': USBSO statusChangeDate: '2025-05-05T12:23:35Z' statusChangeReason: COXIF status: acknowledged troubleTicketRelationship: - '@type': TroubleTicketRelationship '@baseType': QOEKV '@schemaLocation': AYOPH href: DMYTU id: BEFEI name: RDQDL '@referredType': LBBKJ relationshipType: BGSTP - '@type': TroubleTicketRelationship '@baseType': HIOUK '@schemaLocation': NUFUV href: MBYQL id: UEBQG name: MJIRI '@referredType': ETWEQ relationshipType: IFMFD troubleTicketSpecification: '@type': TroubleTicketSpecificationRef '@baseType': GVTCD '@schemaLocation': NHWUR href: FMIJR id: NRKOI name: PBVMU '@referredType': MNBYT version: HMNEE troubleTicketCharacteristic: - '@type': BooleanArrayCharacteristic '@baseType': TFQDR '@schemaLocation': XCCUF id: JUDEB name: KMKCF valueType: IDIOI characteristicRelationship: - '@type': CharacteristicRelationship '@baseType': RGVMJ '@schemaLocation': MPKTA id: ORRNI relationshipType: SUPJT - '@type': CharacteristicRelationship '@baseType': HLEMQ '@schemaLocation': WMDBJ id: MGVEM relationshipType: VNRAJ value: - true - '@type': BooleanArrayCharacteristic '@baseType': IMSRR '@schemaLocation': ENMEJ id: IWJKH name: HQWMF valueType: YAMEN characteristicRelationship: - '@type': CharacteristicRelationship '@baseType': RJUEO '@schemaLocation': TBCXG id: PRSRD relationshipType: LXJHW - '@type': CharacteristicRelationship '@baseType': ECOHW '@schemaLocation': EHRJT id: OBXOD relationshipType: PIQNE value: - true description: >- This is an example of a request to create a new entity at the /listener/troubleTicketCreateEvent endpoint when the entity has @type value as TroubleTicket TroubleTicketAttributeValueChangeEvent_request: value: correlationId: d107a5f0-9257 description: TroubleTicketAttributeValueChangeEvent illustration domain: Commercial eventId: 456b-8663-72338e38d4f0 eventTime: '2022-08-25T12:18:12.181Z' eventType: TroubleTicketAttributeValueChangeEvent priority: '1' timeOccurred: '2022-08-25T12:18:11.750Z' title: TroubleTicketAttributeValueChangeEvent event: troubleTicket: href: 'https://host:port/troubleTicket/v5/troubleTicket/3180' id: '3180' '@type': TroubleTicket attachment: - description: Scanned disputed bill attachmentType: billCopy mimeType: image/png name: March Bill url: 'https://mycsp.com:7070/docloader?docnum=3534555' '@type': Attachment reportingSystem: id: '759' name: APP-745 '@type': ReportingResource '@referredType': LogicalResource source: id: '705' name: APP-317 '@type': ReportingResource '@referredType': LogicalResource '@baseType': Event '@type': TroubleTicketAttributeValueChangeEvent description: Message example for TroubleTicketAttributeValueChangeEvent event TroubleTicketStatusChangeEvent_request: value: correlationId: 0f874cb9-c70d description: TroubleTicketStatusChangeEvent illustration domain: Commercial eventId: 41cf-ad81-d65ea1c2840c eventTime: '2022-08-25T12:18:12.191Z' eventType: TroubleTicketStatusChangeEvent priority: '5' timeOccurred: '2022-08-25T12:18:08.202Z' title: TroubleTicketStatusChangeEvent event: troubleTicket: id: '3180' href: 'https://host:port/troubleTicket/v5/troubleTicket/3180' '@type': TroubleTicket lastUpdate: '2019-05-31T07:34:45.968Z' priority: High status: pending statusChangeDate: '2019-05-31T07:34:45.968Z' statusChangeReason: Need more information from the customer statusChangeHistory: - statusChangeDate: '2019-05-31T07:34:45.968Z' statusChangeReason: Need more information from the customer status: pending '@type': StatusChange reportingSystem: id: '759' name: APP-745 '@type': ReportingResource '@referredType': LogicalResource source: id: '705' name: APP-317 '@type': ReportingResource '@referredType': LogicalResource '@baseType': Event '@type': TroubleTicketStatusChangeEvent description: Message example for TroubleTicketStatusChangeEvent event TroubleTicketDeleteEvent_request: value: correlationId: 90cfc73d-deb7 description: TroubleTicketDeleteEvent illustration domain: Commercial eventId: 47d6-9751-40e4f01440c9 eventTime: '2022-08-25T12:18:12.202Z' eventType: TroubleTicketDeleteEvent priority: '4' timeOccurred: '2022-08-25T12:18:07.224Z' title: TroubleTicketDeleteEvent event: troubleTicket: id: '3180' href: 'https://host:port/troubleTicket/v5/troubleTicket/3180' '@type': TroubleTicketRef reportingSystem: id: '759' name: APP-745 '@type': ReportingResource '@referredType': LogicalResource source: id: '705' name: APP-317 '@type': ReportingResource '@referredType': LogicalResource '@baseType': Event '@type': TroubleTicketDeleteEvent description: Message example for TroubleTicketDeleteEvent event TroubleTicketResolvedEvent_request: value: correlationId: 86c9c4c9-b7a5 description: TroubleTicketResolvedEvent illustration domain: Commercial eventId: 41ad-b3e1-aa39d233a157 eventTime: '2022-08-25T12:18:12.213Z' eventType: TroubleTicketResolvedEvent priority: '5' timeOccurred: '2022-08-25T12:18:10.103Z' title: TroubleTicketResolvedEvent event: troubleTicket: id: '3180' href: 'https://host:port/troubleTicket/v5/troubleTicket/3180' '@type': TroubleTicket status: resolved statusChangeDate: '2019-05-31T07:34:45.968Z' statusChangeReason: A refund was issued statusChangeHistory: - statusChangeDate: '2019-05-31T07:34:45.968Z' statusChangeReason: Need more information from the customer status: pending '@type': StatusChange reportingSystem: id: '759' name: APP-745 '@type': ReportingResource '@referredType': LogicalResource source: id: '705' name: APP-317 '@type': ReportingResource '@referredType': LogicalResource '@baseType': Event '@type': TroubleTicketResolvedEvent description: Message example for TroubleTicketResolvedEvent event TroubleTicketInformationRequiredEvent_request: value: correlationId: 23ad1947-6b0a description: TroubleTicketInformationRequiredEvent illustration request for attachment domain: Commercial eventId: 4655-9378-c6258e688816 eventTime: '2022-08-25T12:18:12.224Z' eventType: TroubleTicketInformationRequiredEvent priority: '2' timeOccurred: '2022-08-25T12:18:07.161Z' title: TroubleTicketInformationRequiredEvent event: troubleTicket: id: '3180' href: 'https://host:port/troubleTicket/v5/troubleTicket/3180' name: complaint over last bill '@type': TroubleTicket informationRequired: op: add path: /attachment reportingSystem: id: '759' name: APP-745 '@type': ReportingResource '@referredType': LogicalResource source: id: '705' name: APP-317 '@type': ReportingResource '@referredType': LogicalResource '@baseType': Event '@type': TroubleTicketInformationRequiredEvent description: Message example for TroubleTicketInformationRequiredEvent event TroubleTicketSpecificationCreateEvent_request: value: correlationId: 95003dd3-e325 description: TroubleTicketSpecificationCreateEvent illustration domain: Commercial eventId: 4010-9b59-509a64cf85a8 eventTime: '2022-08-25T12:18:12.171Z' eventType: TroubleTicketSpecificationCreateEvent priority: '1' timeOccurred: '2022-08-25T12:18:06.252Z' title: TroubleTicketSpecificationCreateEvent event: troubleTicketSpecification: id: '25632415' href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/25632415' name: Bill Dispute description: >- This trouble ticket specification describes the characteristic and rules to apply when creating a Trouble Ticket... creationDate: '2022-05-22T10:36:30.709Z' lastUpdate: '2022-06-22T10:36:30.709Z' relatedParty: - role: approver partyOrPartyRole: id: '6678' href: 'https://mycsp.com:8080/tmf-api/partyManagement/v5/individual/6678' name: Sara Smith '@type': PartyRef '@referredType': Individual '@baseType': PartyRef '@schemaLocation': 'https://github.com/mycsp/schemas/v5/PartyRef.schema.json' '@type': RelatedPartyRefOrPartyRoleRef '@baseType': RelatedPartyRefOrPartyRoleRef '@schemaLocation': 'https://github.com/mycsp/schemas/v5/RelatedPartyRefOrPartyRoleRef.schema.json' lifecycleStatus: active specCharacteristic: - id: '1' name: disputeAmount valueType: number configurable: true description: >- The amount that is on dispute, it can be the entire charge amount or partial amount of the charge maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification '@baseType': CharacteristicSpecification '@schemaLocation': 'https://github.com/mycsp/schemas/v5/CharacteristicSpecification.schema.json' - id: '2' name: creditAmount valueType: number configurable: true description: >- The positive amount to be credit, it can be equal or less than the dispute amount. In case credit is given a credit reason must be provided. In case no credit is given a reject reason must be provided maxCardinality: 0 minCardinality: 1 charSpecRelationship: - characteristicSpecificationId: '3' name: creditReason relationshipType: dependency parentSpecificationId: '25632415' '@type': CharacteristicSpecificationRelationship '@referredType': CharacteristicSpecification '@baseType': CharacteristicSpecificationRelationship '@schemaLocation': >- https://github.com/mycsp/schemas/v5/CharacteristicSpecificationRelationship.schema.json '@type': CharacteristicSpecification '@baseType': CharacteristicSpecification '@schemaLocation': 'https://github.com/mycsp/schemas/v5/CharacteristicSpecification.schema.json' - id: '3' name: creditReason valueType: string configurable: true description: >- The reason for giving the credit, in case credit apply. In case no credit apply a reject reason must be provided maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification '@baseType': CharacteristicSpecification '@schemaLocation': 'https://github.com/mycsp/schemas/v5/CharacteristicSpecification.schema.json' - id: '4' name: rejectReason valueType: string configurable: true description: 'The reason for rejecting the dispute, in case no credit apply.' maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification '@baseType': CharacteristicSpecification '@schemaLocation': 'https://github.com/mycsp/schemas/v5/CharacteristicSpecification.schema.json' - id: '5' name: currency valueType: string configurable: true description: Currency (ISO4217 norm uses 3 letters to define the currency) maxCardinality: 0 minCardinality: 1 '@type': CharacteristicSpecification '@baseType': CharacteristicSpecification '@schemaLocation': 'https://github.com/mycsp/schemas/v5/CharacteristicSpecification.schema.json' validFor: startDateTime: '2022-06-22T23:20:50.52Z' version: '1' '@type': TroubleTicketSpecification '@baseType': TroubleTicketSpecification '@schemaLocation': 'https://github.com/mycsp/schemas/v5/TroubleTicketSpecification.schema.json' reportingSystem: id: '759' name: Catalog Publishing '@type': ReportingResource '@referredType': LogicalResource source: id: '705' name: Catalog Authoring '@type': ReportingResource '@referredType': LogicalResource '@baseType': Event '@type': TroubleTicketSpecificationCreateEvent description: Message example for TroubleTicketSpecificationCreateEvent event TroubleTicketSpecificationAttributeValueChangeEvent_request: value: correlationId: d107a5f0-9257 description: TroubleTicketSpecificationAttributeValueChangeEvent illustration domain: Commercial eventId: 456b-8663-72338e38d4f0 eventTime: '2022-08-25T12:18:12.181Z' eventType: TroubleTicketSpecificationAttributeValueChangeEvent priority: '1' timeOccurred: '2022-08-25T12:18:11.750Z' title: TroubleTicketSpecificationAttributeValueChangeEvent event: troubleTicketSpecification: href: 'https://host:port/troubleTicketSpecification/v5/troubleTicketSpecification/3180' id: '3180' '@type': TroubleTicketSpecification lifecycleStatus: active reportingSystem: id: '759' name: APP-745 '@type': ReportingResource '@referredType': LogicalResource source: id: '705' name: APP-317 '@type': ReportingResource '@referredType': LogicalResource '@baseType': Event '@type': TroubleTicketSpecificationAttributeValueChangeEvent description: Message example for TroubleTicketSpecificationAttributeValueChangeEvent event TroubleTicketSpecificationStatusChangeEvent_request: value: correlationId: 95003dd3-e325 description: TroubleTicketSpecificationStatusChangeEvent illustration domain: Commercial eventId: 4010-9b59-509a64cf85a8 eventTime: '2022-08-25T12:18:12.171Z' eventType: TroubleTicketSpecificationStatusChangeEvent priority: '1' timeOccurred: '2022-08-25T12:18:06.252Z' title: TroubleTicketSpecificationStatusChangeEvent event: troubleTicketSpecification: href: 'https://mycsp.com:8080/tmf-api/troubleTicket/v5/troubleTicketSpecification/25632415' id: '25632415' '@type': TroubleTicketSpecification lastUpdate: '2022-06-22T10:36:30.709Z' lifecycleStatus: active reportingSystem: id: '759' name: Catalog Publishing '@type': ReportingResource '@referredType': LogicalResource source: id: '705' name: Catalog Authoring '@type': ReportingResource '@referredType': LogicalResource '@baseType': Event '@type': TroubleTicketSpecificationStatusChangeEvent description: Message example for TroubleTicketSpecificationStatushangeEvent event TroubleTicketSpecificationDeleteEvent_request: value: correlationId: 90cfc73d-deb7 description: TroubleTicketSpecificationDeleteEvent illustration domain: Commercial eventId: 47d6-9751-40e4f01440c9 eventTime: '2022-08-25T12:18:12.202Z' eventType: TroubleTicketSpecificationDeleteEvent priority: '4' timeOccurred: '2022-08-25T12:18:07.224Z' title: TroubleTicketSpecificationDeleteEvent event: troubleTicketSpecification: id: '3180' href: 'https://host:port/troubleTicket/v5/troubleTicketSpecification/4499' '@type': TroubleTicketSpecificationRef reportingSystem: id: '759' name: Catalog Publishing '@type': ReportingResource '@referredType': LogicalResource source: id: '705' name: Catalog Authoring '@type': ReportingResource '@referredType': LogicalResource '@baseType': Event '@type': TroubleTicketSpecificationDeleteEvent description: Message example for TroubleTicketSpecificationDeleteEvent event