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 category API

Operations for Category Resource

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

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

category 5

Operations for Category Resource

GET
/category
TM Forum List or Find Category Objects
listCategory 3 params → 200400401403404405500501
POST
/category
TM Forum Creates a Category
createCategory 1 param body → 201202400401403404405409
GET
/category/{id}
TM Forum Retrieves a Category by ID
retrieveCategory 2 params → 200400401403404405500501
PATCH
/category/{id}
TM Forum Updates Partially a Category
patchCategory 2 params body → 200202400401403404405409
DELETE
/category/{id}
TM Forum Deletes a Category
deleteCategory 1 param → 202204400401403404405409

Schemas 22

The contract defines 22 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
EntityRef_FVO
ProductOfferingRef_MVO
Category
CategoryRef_FVO
Entity_FVO
object
Base entity schema for use in TMForum Open-APIs. Property.
Addressable
object
Base schema for adressable entities
2 properties
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
ProductOfferingRef
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
CategoryRef
ProductOfferingRef_FVO
Category_FVO
CategoryRef_MVO
Addressable_FVO
object
Base schema for adressable entities
1 property
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
Category_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.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-category-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 customer API
TM Forum events subscription API
TM Forum exportJob API
TM Forum financialAccount API