TM Forum troubleTicketSpecification API

Operations for TroubleTicketSpecification Resource

OpenAPI Specification

tm-forum-troubleticketspecification-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Product Catalog Management agreement troubleTicketSpecification 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: troubleTicketSpecification
  description: Operations for TroubleTicketSpecification Resource
paths:
  /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:
  responses:
    '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
    200TroubleTicketSpecification_Get:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TroubleTicketSpecification_RES'
          examples:
            TroubleTicketSpecification_retrieve_example:
              $ref: '#/components/examples/TroubleTicketSpecification_retrieve_example_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
    '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
    '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
    '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
    '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
    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'
    201TroubleTicketSpecification:
      description: OK/Created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TroubleTicketSpecification_RES'
          examples:
            TroubleTicketSpecification_create_example:
              $ref: '#/components/examples/TroubleTicketSpecification_create_example_response'
    '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
    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'
    '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
  examples:
    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.
    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_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_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.
    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_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_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_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_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
  schemas:
    JsonPatchOperations:
      description: JSONPatch Operations document as defined by RFC 6902
      type: array
      items:
        $ref: '#/components/schemas/JsonPatch'
    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'
    TroubleTicketSpecification:
      a

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/openapi/tm-forum-troubleticketspecification-api-openapi.yml