TM Forum resourceSpecification 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 resourceSpecification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
5 operations
across 2 paths,
and defines 20 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 paths20 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 20 schemas that model the data the API accepts and returns. The most detailed are ResourceSpecification (19 properties), ResourceSpecification_Create (17 properties), ResourceSpecification_Update (17 properties), ResourceSpecificationCharacteristic (17 properties). Each schema is shown below with its type and property counts.
ResourceSpecificationCharacteristicRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among ResourceSpecificationCharacteristics. The specification character…
9 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties2 required
FeatureSpecificationRelationship
object
Configuration feature
9 properties2 required
ResourceSpecificationRelationship
object
A migration, substitution, dependency or exclusivity relationship between/among resource specifications.
13 properties
FeatureSpecification
object
Specification for applicable configuration features for a resource specification.
12 properties
FeatureSpecificationCharacteristicValue
object
A number or text that can be assigned to a FeatureSpecificationCharacteristic.
12 properties1 required
ConstraintRef
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties1 required
Quantity
object
An amount in a given unit
2 properties
ResourceSpecification_Create
object
Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consume…
17 properties1 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ResourceSpecification
object
Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consume…
19 properties
ResourceSpecificationCharacteristic
object
This class defines the characteristic features of a resource specification. Every ResourceSpecification has a variety of important attributes, methods, constra…
17 properties
Any
TargetResourceSchema
object
The reference object to the schema and type of target resource which is described by resource specification
3 properties2 required
ResourceSpecificationCharacteristicValue
object
A number or text that can be assigned to a ResourceSpecCharacteristic.
12 properties
AttachmentRefOrValue
object
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consume…
17 properties
FeatureSpecificationCharacteristicRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among FeatureSpecificationCharacteristics.
10 properties
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
