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

TM Forum productCatalog API

Operations for ProductCatalog Resource

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

This API exposes 5 operations across 2 paths, and defines 34 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 34 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.

productCatalog 5

Operations for ProductCatalog Resource

GET
/productCatalog
TM Forum List or Find ProductCatalog Objects
listProductCatalog 3 params → 200400401403404405500501
POST
/productCatalog
TM Forum Creates a ProductCatalog
createProductCatalog 1 param body → 201202400401403404405409
GET
/productCatalog/{id}
TM Forum Retrieves a ProductCatalog by ID
retrieveProductCatalog 2 params → 200400401403404405500501
PATCH
/productCatalog/{id}
TM Forum Updates Partially a ProductCatalog
patchProductCatalog 2 params body → 200202400401403404405409
DELETE
/productCatalog/{id}
TM Forum Deletes a ProductCatalog
deleteProductCatalog 1 param → 202204400401403404405409

Schemas 34

The contract defines 34 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.

JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
Catalog_MVO
ProductCatalog
PartyRefOrPartyRoleRef_FVO
object
EntityRef_FVO
PartyRoleRef
PartyRefOrPartyRoleRef_MVO
object
PartyRoleRef_MVO
CategoryRef_FVO
Catalog
Entity_FVO
object
Base entity schema for use in TMForum Open-APIs. Property.
RelatedPartyRefOrPartyRoleRef
ProductCatalog_MVO
RelatedPartyRefOrPartyRoleRef_MVO
Addressable
object
Base schema for adressable entities
2 properties
PartyRef_FVO
object
A Party reference
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties 2 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.
PartyRoleRef_FVO
CategoryRef
PartyRef_MVO
object
A Party reference
PartyRefOrPartyRoleRef
object
Catalog_FVO
Addressable_FVO
object
Base schema for adressable entities
1 property
RelatedPartyRefOrPartyRoleRef_FVO
CategoryRef_MVO
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
Entity_MVO
object
Base entity schema for use in TMForum Open-APIs. Property.
PartyRef
object
A Party reference
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
ProductCatalog_FVO

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-productcatalog-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