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

The serviceCategory API from TM Forum — 2 operation(s) for servicecategory.

TM Forum serviceCategory 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 serviceCategory. 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.

serviceCategory 5
GET
/serviceCategory
List or find ServiceCategory objects
listServiceCategory 3 params → 200400401403404405409500
POST
/serviceCategory
Creates a ServiceCategory
createServiceCategory 1 param → 201400401403405409500
GET
/serviceCategory/{id}
Retrieves a ServiceCategory by ID
retrieveServiceCategory 2 params → 200400401403404405409500
PATCH
/serviceCategory/{id}
Updates partially a ServiceCategory
patchServiceCategory 2 params → 200400401403404405409500
DELETE
/serviceCategory/{id}
Deletes a ServiceCategory
deleteServiceCategory 1 param → 204400401403404405409500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ServiceCategory (15 properties), ServiceCategory_Create (13 properties), ServiceCategory_Update (12 properties), ServiceCategoryRef (8 properties). Each schema is shown below with its type and property counts.

ServiceCandidateRef
object
ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.
8 properties 1 required
ServiceCategory
object
The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.
15 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
ServiceCategory_Update
object
The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories. Skipped properties: id,href…
12 properties
ServiceCategory_Create
object
The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories. Skipped properties: id,href
13 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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