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 events subscription API

Endpoints to register and terminate an Event Listener

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

This API exposes 3 operations across 2 paths, and defines 6 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/.

3 operations 2 paths 6 schemas 1 DELETE1 GET1 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 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

events subscription 3

Endpoints to register and terminate an Event Listener

POST
/hub
TM Forum Create a Subscription (hub) to Receive Events
createHub body → 201default
DELETE
/hub/{id}
TM Forum Remove a Subscription (hub) to Receive Events
hubDelete 1 param → 204default
GET
/hub/{id}
TM Forum Retrieve a Subscription (hub)
hubGet 1 param → 200default

Schemas 6

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

Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Entity
object
Base entity schema for use in TMForum Open-APIs. 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
Hub
object
Sets the communication endpoint address the service instance must use to deliver notification information
Hub_FVO
object
Sets the communication endpoint address the service instance must use to deliver notification information
1 required
Addressable
object
Base schema for adressable entities
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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