Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

TM Forum

TM Forum troubleTicket API

Operations for TroubleTicket Resource

Documentation Provider Profile APIs.io OpenAPI GitHub

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 troubleTicket. 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.0.1, at version 5.0.0.

Requests are made against a single base URL, https://serverRoot/productCatalogManagement/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.0.1
API Version
5.0.0
Server
https://serverRoot/productCatalogManagement/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), Addressable (2 properties), TimePeriod (2 properties). Each schema is shown below with its type and property counts.

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

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
AE Profile APIs.io
TM Forum agreementSpecification API
AE Profile APIs.io
TM Forum billFormat API
AE Profile APIs.io
TM Forum billingAccount API
AE Profile APIs.io
TM Forum billingCycleSpecification API
AE Profile APIs.io
TM Forum billPresentationMedia API
AE Profile APIs.io
TM Forum cancelProductOrder API
AE Profile APIs.io
TM Forum cancelServiceOrder API
AE Profile APIs.io
TM Forum category API
AE Profile APIs.io
TM Forum customer API
AE Profile APIs.io
TM Forum events subscription API
AE Profile APIs.io
TM Forum exportJob API
AE Profile APIs.io
#troubleTicket
← Back to T APIs
API Details
ID
tm-forum:tm-forum-troubleticket-api
Server
https://serverRoot/productCatalogManagement/v5/
Docs
https://www.tmforum.org/resources/specification/tmf620-product-catalog-management-api-rest-specification-r17-5-0/
Provider
TM Forum
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network