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

The serviceCatalog API from TM Forum — 2 operation(s) for servicecatalog.

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

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

serviceCatalog 5
GET
/serviceCatalog
List or find ServiceCatalog objects
listServiceCatalog 3 params → 200400401403404405409500
POST
/serviceCatalog
Creates a ServiceCatalog
createServiceCatalog 1 param → 201400401403405409500
GET
/serviceCatalog/{id}
Retrieves a ServiceCatalog by ID
retrieveServiceCatalog 2 params → 200400401403404405409500
PATCH
/serviceCatalog/{id}
Updates partially a ServiceCatalog
patchServiceCatalog 2 params → 200400401403404405409500
DELETE
/serviceCatalog/{id}
Deletes a ServiceCatalog
deleteServiceCatalog 1 param → 204400401403404405409500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ServiceCatalog (13 properties), ServiceCatalog_Create (11 properties), ServiceCatalog_Update (10 properties), RelatedParty (8 properties). Each schema is shown below with its type and property counts.

ServiceCatalog
object
The root entity for service catalog management. A service catalog is a group of service specifications made available through service candidates that an organi…
13 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
ServiceCategoryRef
object
The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.
8 properties 1 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ServiceCatalog_Update
object
The root entity for service catalog management. A service catalog is a group of service specifications made available through service candidates that an organi…
10 properties
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 2 required
ServiceCatalog_Create
object
The root entity for service catalog management. A service catalog is a group of service specifications made available through service candidates that an organi…
11 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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