TM Forum resourceCandidate 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 resourceCandidate. 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 ResourceCandidate (13 properties), ResourceCandidate_Update (11 properties), ResourceCandidate_Create (11 properties), ResourceSpecificationRef (8 properties). Each schema is shown below with its type and property counts.
ResourceCategoryRef
object
The (resource) category resource is used to group resource candidates in logical containers. Categories can contain other categories.
8 properties1 required
ResourceCandidate
object
ResourceCandidate is an entity that makes a resource specification available to a catalog. A ResourceCandidate and its associated resource specification may be…
13 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties2 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ResourceSpecificationRef
object
Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consume…
8 properties1 required
ResourceCandidate_Create
object
ResourceCandidate is an entity that makes a resource specification available to a catalog. A ResourceCandidate and its associated resource specification may be…
11 properties1 required
ResourceCandidate_Update
object
ResourceCandidate is an entity that makes a resource specification available to a catalog. A ResourceCandidate and its associated resource specification may be…
11 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
