TM Forum · Schema

TroubleTicket

TelecommunicationsBSSOSSOpen APIsStandardsTM Forum

Properties

Name Type Description
name string Name of the trouble ticket, typically a short description provided by the user that create the ticket
description string Description of the trouble or issue
severity string The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. Severity values can be for example : Critical, Major, Minor
ticketType string Represent a business type of the trouble ticket e.g. incident, complain, request
attachment array File(s) attached to the trouble ticket. e.g. picture of broken device, scanning of a bill or charge
channel object
creationDate string The date on which the trouble ticket was created
requestedResolutionDate string The resolution date requested by the user
expectedResolutionDate string The expected resolution date determined by the trouble ticket system
resolutionDate string The date and time the trouble ticket was resolved
externalIdentifier array
lastUpdate string The date and time that the trouble ticket was last updated
note array The note(s) that are associated to the ticket.
priority string 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
relatedEntity array An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated.
relatedParty array The related party(ies) that are associated to the ticket.
status object
statusChangeDate string The date and time the status changed.
statusChangeReason string The reason for changing the status
statusChangeHistory array The status change history that are associated to the ticket. Populated by the server
troubleTicketRelationship array A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets
troubleTicketSpecification object
troubleTicketCharacteristic array List of characteristics of the trouble ticket
View JSON Schema on GitHub

JSON Schema

tm-forum-troubleticket-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TroubleTicket",
  "title": "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"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/tm-forum-troubleticket"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.