TM Forum productSpecification 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 productSpecification. 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.0.1, at version 5.0.0.
Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.
5 operations2 paths74 schemas1 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.
productSpecification 5
Operations for ProductSpecification Resource
GET
/productSpecification
TM Forum List or Find ProductSpecification Objects
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), TimePeriod (2 properties). Each schema is shown below with its type and property counts.
EntityRef_FVO
ServiceSpecificationRef_MVO
PartyRefOrPartyRoleRef_MVO
object
PartyRoleRef_MVO
BundledProductSpecification
CharacteristicSpecificationRelationship_MVO
Attachment
PartyRoleRef_FVO
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 properties1 required
JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
ProductSpecificationRelationship
Quantity
object
An amount in a given unit
2 properties
ServiceSpecificationRef
PartyRoleRef
CharacteristicValueSpecification
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
2 properties
Attachment_FVO
CategoryRef_FVO
Entity_FVO
object
Base entity schema for use in TMForum Open-APIs. Property.
CharacteristicSpecification_FVO
BundledProductSpecification_FVO
AttachmentRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
CharacteristicSpecificationRelationship
ExternalIdentifier_MVO
ProductSpecificationRelationship_FVO
ProductSpecification
PartyRef_MVO
object
A Party reference
PartyRef
object
A Party reference
Entity_MVO
object
Base entity schema for use in TMForum Open-APIs. Property.
PolicyRef
IntentSpecificationRef_FVO
object
Attachment_MVO
CharacteristicValueSpecification_FVO
IntentSpecificationRef_MVO
object
CharacteristicSpecification_MVO
IntentSpecificationRef
object
RelatedPartyRefOrPartyRoleRef
ProductSpecification_FVO
RelatedPartyRefOrPartyRoleRef_MVO
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
ResourceSpecificationRef
TargetProductSchema_MVO
object
The reference object to the schema and type of target product which is described by product specification
2 properties
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties2 required
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.
CategoryRef
ProductSpecification_MVO
ServiceSpecificationRef_FVO
PartyRefOrPartyRoleRef_FVO
object
TargetProductSchema_FVO
object
The reference object to the schema and type of target product which is described by product specification
2 properties2 required
AttachmentRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
AttachmentRef_MVO
CharacteristicValueSpecification_MVO
CharacteristicSpecification
BundledProductSpecification_MVO
ExternalIdentifier
Addressable
object
Base schema for adressable entities
2 properties
ResourceSpecificationRef_FVO
ResourceSpecificationRef_MVO
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
PolicyRef_MVO
PartyRefOrPartyRoleRef
object
RelatedPartyRefOrPartyRoleRef_FVO
CategoryRef_MVO
Addressable_FVO
object
Base schema for adressable entities
1 property
AttachmentRef_FVO
PolicyRef_FVO
ProductSpecificationRelationship_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 properties1 required
EntityRef
ExternalIdentifier_FVO
CharacteristicSpecificationRelationship_FVO
AttachmentRef
Specification
The full machine-readable OpenAPI contract behind this narrative.
