How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TM Forum troubleTicket API

Operations for TroubleTicket Resource

TM Forum troubleTicket API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Trouble Ticket. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 62 schemas. It is described by OpenAPI 3.2.0, at version 5.0.1.

Requests are made against a single base URL, {apiRoot}/tmf-api/troubleTicket/v5/.

5 operations 2 paths 62 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.0.1
Server
{apiRoot}/tmf-api/troubleTicket/v5/
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

troubleTicket 5

Operations for TroubleTicket Resource

GET
/troubleTicket
TM Forum List or Find TroubleTicket Objects
listTroubleTicket 7 params → 200400401403404405500501
POST
/troubleTicket
TM Forum Creates a TroubleTicket
createTroubleTicket 1 param body → 201202400401403404405409
GET
/troubleTicket/{id}
TM Forum Retrieves a TroubleTicket by ID
retrieveTroubleTicket 2 params → 200400401403404405500501
PATCH
/troubleTicket/{id}
TM Forum Updates Partially a TroubleTicket
patchTroubleTicket 2 params body → 200202400401403404405409
DELETE
/troubleTicket/{id}
TM Forum Deletes a TroubleTicket
deleteTroubleTicket 1 param → 202204400401403404405409

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are JsonPatch (4 properties), Extensible (3 properties), Quantity (2 properties), Addressable (2 properties). Each schema is shown below with its type and property counts.

PartyRoleRef_MVO
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
StatusChange
PartyRef
object
A Party reference
Attachment_MVO
Extensible
object
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
3 properties 1 required
PartyRoleRef
PartyRefOrPartyRoleRef_FVO
object
RelatedEntity_FVO
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties 2 required
Characteristic
ChannelRef_FVO
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
Note_MVO
AttachmentRef_FVO
PartyRefOrPartyRoleRef
object
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
PartyRoleRef_FVO
Note_FVO
Note
ExternalIdentifier_MVO
RelatedPartyRefOrPartyRoleRef_FVO
TroubleTicket_RES
object
Response object for TroubleTicket
2 required
RelatedEntity
TroubleTicket
CharacteristicRelationship_MVO
CharacteristicRelationship_FVO
AttachmentRef_MVO
PartyRef_MVO
object
A Party reference
TroubleTicketSpecificationRef_FVO
EntityRef_MVO
ChannelRef_MVO
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
PartyRef_FVO
object
A Party reference
ExternalIdentifier
CharacteristicRelationship
AttachmentRef
TroubleTicketSpecificationRef
ChannelRef
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
TroubleTicketStatusType
string
Possible values for the status of the trouble ticket
TroubleTicket_FVO
Attachment
TroubleTicketSpecificationRef_MVO
TroubleTicketRelationship_FVO
TroubleTicketRelationship
RelatedEntity_MVO
EntityRef
AttachmentRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
PartyRefOrPartyRoleRef_MVO
object
Quantity
object
An amount in a given unit
2 properties
AttachmentRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
Characteristic_FVO
RelatedPartyRefOrPartyRoleRef_MVO
TroubleTicket_MVO
ExternalIdentifier_FVO
AttachmentRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
Addressable
object
Base schema for addressable entities
2 properties
StatusChange_MVO
JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
RelatedPartyRefOrPartyRoleRef
Attachment_FVO
TroubleTicketRelationship_MVO
Characteristic_MVO

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-troubleticket-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum agreement API
TM Forum agreementSpecification API
TM Forum billFormat API
TM Forum billingAccount API
TM Forum billingCycleSpecification API
TM Forum billPresentationMedia API
TM Forum cancelProductOrder API
TM Forum cancelServiceOrder API
TM Forum category API
TM Forum customer API
TM Forum events subscription API
TM Forum exportJob API
Where this information came from

This is an independent, third-party profile of TM Forum troubleTicket API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.