TM Forum serviceCandidate 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 serviceCandidate. 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 operations2 paths7 schemas1 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.
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ServiceCandidate (13 properties), ServiceCandidate_Create (11 properties), ServiceCandidate_Update (10 properties), ServiceSpecificationRef (8 properties). Each schema is shown below with its type and property counts.
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties2 required
ServiceCategoryRef
object
The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.
8 properties1 required
ServiceCandidate_Create
object
ServiceCandidate is an entity that makes a service specification available to a catalog. A ServiceCandidate and its associated service specification may be pub…
11 properties2 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ServiceCandidate
object
ServiceCandidate is an entity that makes a service specification available to a catalog. A ServiceCandidate and its associated service specification may be pub…
13 properties
ServiceSpecificationRef
object
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
8 properties1 required
ServiceCandidate_Update
object
ServiceCandidate is an entity that makes a service specification available to a catalog. A ServiceCandidate and its associated service specification may be pub…
10 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
