openapi: 3.0.1 info: title: Product Catalog Management agreement troubleTicket API description: "Product Catalog API is one of Catalog Management API Family. Product Catalog API goal is to provide a catalog of products. \n### Operations\nProduct Catalog API performs the following operations on the resources :\n- Retrieve an entity or a collection of entities depending on filter criteria\n- Partial update of an entity (including updating rules)\n- Create an entity (including default values and creation rules)\n- Delete an entity\n- Manage notification of events" version: 5.0.0 servers: - url: https://serverRoot/productCatalogManagement/v5/ tags: - name: troubleTicket description: Operations for TroubleTicket Resource paths: /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' components: schemas: TroubleTicketStatusType: enum: - acknowledged - rejected - pending - held - inProgress - cancelled - closed - resolved type: string description: Possible values for the status of the trouble ticket 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' 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' 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' 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' 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' 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' 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' 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' 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' 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' 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' 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_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' 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. 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.. \nSeverity 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' JsonPatchOperations: description: JSONPatch Operations document as defined by RFC 6902 type: array items: $ref: '#/components/schemas/JsonPatch' 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 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' 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' 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' 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' 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' PartyRef_MVO: type: object description: A Party reference allOf: - $ref: '#/components/schemas/EntityRef_MVO' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef_MVO' 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' PartyRef: type: object description: A Party reference allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef' 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' 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.. \nSeverity 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' 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' 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' 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' 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' 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.. \nSeverity 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' 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_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' 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' 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' 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' 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) 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' 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. Entity: type: object description: Base entity schema for use in TMForum Open-APIs. Property. allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' 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' 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' 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_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' 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' 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' 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' Addressable: type: object description: Base schema for addressable entities properties: href: type: string description: Hyperlink reference id: type: string description: unique identifier 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' PartyRef_FVO: type: object description: A Party reference allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef_FVO' 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' 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' 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' 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' 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' 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' 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' 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 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' 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' 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 parameters: 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 Offset: name: offset in: query description: Requested index for start of resources to be provided in response schema: type: integer After: name: after in: query description: An opaque string value representing the page results after the cursor value schema: type: string Filter: name: filter in: query description: Filter a collection using JSONPath schema: type: string example: attachment[?(@size==300)] Limit: name: limit in: query description: Requested number of resources to be provided in response schema: type: integer 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 Before: name: before in: query description: An opaque string value representing the page results before the cursor value schema: type: string headers: X-Result-Count: description: Actual number of items returned in the response body schema: type: integer X-Total-Count: description: Total number of items matching criteria schema: type: integer responses: '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 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' '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 201TroubleTicket: description: OK/Created content: application/json: schema: $ref: '#/components/schemas/TroubleTicket_RES' examples: TroubleTicket_create_example: $ref: '#/components/examples/TroubleTicket_create_example_response' '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 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' '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 '202': description: Accepted '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 '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 '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 '204': description: Deleted '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 examples: 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_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_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_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_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. 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_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_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_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.