How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TM Forum serviceSpecification API

The serviceSpecification API from TM Forum — 2 operation(s) for servicespecification.

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.2.0, at version 4.0.0.

Requests are made against a single base URL, https://serverRoot/tmf-api/serviceCatalogManagement/v4/.

5 operations 2 paths 23 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Server
https://serverRoot/tmf-api/serviceCatalogManagement/v4/
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.

serviceSpecification 5
GET
/serviceSpecification
List or find ServiceSpecification objects
listServiceSpecification 3 params → 200400401403404405409500
POST
/serviceSpecification
Creates a ServiceSpecification
createServiceSpecification body → 201400401403405409500
GET
/serviceSpecification/{id}
Retrieves a ServiceSpecification by ID
retrieveServiceSpecification 2 params → 200400401403404405409500
PATCH
/serviceSpecification/{id}
Updates partially a ServiceSpecification
patchServiceSpecification 1 param body → 200400401403404405409500
DELETE
/serviceSpecification/{id}
Deletes a ServiceSpecification
deleteServiceSpecification 1 param → 204400401403404405409500

Schemas 23

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), FeatureSpecificationCharacteristic (17 properties). Each schema is shown below with its type and property counts.

Quantity
object
An amount in a given unit
2 properties
TargetEntitySchema
object
The reference object to the schema and type of target entity which is described by a specification
2 properties 2 required
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
CharacteristicValueSpecification
object
specification of a value (number or text or an object) that can be assigned to a Characteristic.
12 properties
FeatureSpecificationRelationship
object
Relationship between feature specifications
6 properties 2 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
FeatureSpecificationCharacteristic
object
Configuration feature characteristic specification.
17 properties 1 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.
14 properties
EntitySpecificationRelationship
object
A migration, substitution, dependency or exclusivity relationship between/among entity specifications.
11 properties 1 required
CharacteristicSpecification
object
This class defines a characteristic specification.
17 properties
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 2 required
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
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
CharacteristicSpecificationRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic i…
6 properties
ConstraintRef
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties 1 required
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 properties 1 required
Any
FeatureSpecification
object
Specification for resource, service or product features
9 properties
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 properties 1 required
AssociationSpecificationRef
object
reference to an AssociationSpecification object
7 properties 1 required
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 properties 1 required
FeatureSpecificationCharacteristicRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among FeatureSpecificationCharacteristics.
7 properties
ServiceSpecRelationship
object
A dependency, substitution or exclusivity relationship between/among service specifications.
10 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-servicespecification-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
Where this information came from

This is an independent, third-party profile of TM Forum serviceSpecification API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.