TM Forum serviceSpecification 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 serviceSpecification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
5 operations
across 2 paths,
and defines 23 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 paths23 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 23 schemas that model the data the API accepts and returns. The most detailed are ServiceSpecification (22 properties), ServiceSpecification_Create (20 properties), ServiceSpecification_Update (19 properties), CharacteristicSpecification (17 properties). Each schema is shown below with its type and property counts.
ServiceSpecification
object
ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instant…
22 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
Relationship between feature specifications
6 properties2 required
ServiceSpecRelationship
object
A dependency, substitution or exclusivity relationship between/among service specifications.
10 properties1 required
AssociationSpecificationRef
object
reference to an AssociationSpecification object
7 properties1 required
ServiceSpecification_Create
object
ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instant…
20 properties1 required
CharacteristicSpecificationRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic i…
6 properties
EntitySpecificationRelationship
object
A migration, substitution, dependency or exclusivity relationship between/among entity specifications.
11 properties1 required
FeatureSpecification
object
Specification for resource, service or product features
9 properties
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
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ServiceSpecification_Update
object
ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instant…
19 properties
Any
TargetEntitySchema
object
The reference object to the schema and type of target entity which is described by a specification
2 properties2 required
AttachmentRefOrValue
object
An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture.
This class defines a characteristic specification.
17 properties
ServiceLevelSpecificationRef
object
A Service Level Specification represents a pre-defined or negotiated set of Service Level Objectives. In addition, certain consequences are associated with not…
7 properties1 required
CharacteristicValueSpecification
object
specification of a value (number or text or an object) that can be assigned to a Characteristic.
12 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
FeatureSpecificationCharacteristicRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among FeatureSpecificationCharacteristics.
7 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.
