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 Product Specification API

Operations for ProductSpecification Resource

TM Forum Product Specification 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 Product Specification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.

5 operations 2 paths 74 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.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.

Product Specification 5

Operations for ProductSpecification Resource

GET
/productSpecification
TM Forum List or Find ProductSpecification Objects
listProductSpecification 3 params → 200400401403404405500501
POST
/productSpecification
TM Forum Creates a ProductSpecification
createProductSpecification 1 param body → 201202400401403404405409
GET
/productSpecification/{id}
TM Forum Retrieves a ProductSpecification by ID
retrieveProductSpecification 2 params → 200400401403404405500501
PATCH
/productSpecification/{id}
TM Forum Updates Partially a ProductSpecification
patchProductSpecification 2 params body → 200202400401403404405409
DELETE
/productSpecification/{id}
TM Forum Deletes a ProductSpecification
deleteProductSpecification 1 param → 202204400401403404405409

Schemas 74

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

AttachmentRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
EntityRef
IntentSpecificationRef_FVO
object
PartyRef_FVO
object
A Party reference
Addressable_FVO
object
Base schema for adressable entities
1 property
BundledProductSpecification_FVO
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
ProductSpecificationRelationship_MVO
ProductSpecification_MVO
ExternalIdentifier
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
ProductSpecificationRelationship_FVO
RelatedPartyRefOrPartyRoleRef
CategoryRef_FVO
PartyRefOrPartyRoleRef_FVO
object
EntityRef_FVO
IntentSpecificationRef_MVO
object
Attachment
ResourceSpecificationRef_FVO
PartyRoleRef_MVO
PartyRefOrPartyRoleRef
object
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties 2 required
CharacteristicValueSpecification
BundledProductSpecification_MVO
ServiceSpecificationRef_MVO
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
RelatedPartyRefOrPartyRoleRef_FVO
ServiceSpecificationRef
ProductSpecification
PartyRoleRef
AttachmentRef_MVO
IntentSpecificationRef
object
CharacteristicValueSpecification_MVO
ProductSpecification_FVO
PartyRef
object
A Party reference
ServiceSpecificationRef_FVO
ExternalIdentifier_FVO
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
2 properties
AttachmentRef_FVO
ResourceSpecificationRef
CategoryRef_MVO
CharacteristicSpecificationRelationship
TargetProductSchema_MVO
object
The reference object to the schema and type of target product which is described by product specification
2 properties
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
PartyRefOrPartyRoleRef_MVO
object
ExternalIdentifier_MVO
Entity_FVO
object
Base entity schema for use in TMForum Open-APIs. Property.
JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
CategoryRef
CharacteristicSpecification
CharacteristicValueSpecification_FVO
RelatedPartyRefOrPartyRoleRef_MVO
CharacteristicSpecificationRelationship_MVO
Attachment_FVO
Addressable
object
Base schema for adressable entities
2 properties
CharacteristicSpecification_MVO
ResourceSpecificationRef_MVO
TargetProductSchema_FVO
object
The reference object to the schema and type of target product which is described by product specification
2 properties 2 required
BundledProductSpecification
Extensible_FVO
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
Quantity
object
An amount in a given unit
2 properties
Attachment_MVO
Entity_MVO
object
Base entity schema for use in TMForum Open-APIs. Property.
AttachmentRef
CharacteristicSpecificationRelationship_FVO
ProductSpecificationRelationship
AttachmentRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
PolicyRef
CharacteristicSpecification_FVO
AttachmentRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
PartyRef_MVO
object
A Party reference
PolicyRef_FVO
PolicyRef_MVO
PartyRoleRef_FVO

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-product-specification-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum Agreement API
TM Forum Agreement Specification API
TM Forum Bill Format API
TM Forum Billing Cycle Specification API
TM Forum Bill Presentation Media API
TM Forum Cancel Product Order API
TM Forum Cancel Service Order API
TM Forum Category API
TM Forum Customer API
TM Forum events subscription API
TM Forum Individual API
TM Forum notification listener API
Where this information came from

This is an independent, third-party profile of TM Forum Product Specification 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.