Page tree
Skip to end of metadata
Go to start of metadata

The increasingly complex multi-partner digital services value chain raises new challenges in terms of ensuring time-to-market, seamless management, cost-effectiveness and revenue sharing.

In order to meet these challenges, TM Forum members including the world’s largest service providers and suppliers, have been working to develop APIs that enable the open digital ecosystem and provide critical management functionality to digital services.

This table contains links to Beta versions of the Open APIs which are available to TM Forum members oAPI Project Members only.

By default, the information in the table is sorted by API title, but can be re-sorted (for example, by Document Number or Release Version) by clicking on the relevant column headings.

Please note that Comments are no longer permitted on this page. If you have any questions regarding the content of the Open API Table please post them as discussion topics on the   Open API Community Forum .


To access the API table links below you will need to be logged in

To login with your TM Forum account please click on the Login button below

Login

Don't have an account? You can register by clicking here:

Register


TM Forum Open APIs

Early Adoption (Beta) Versions


Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


TM Forum Open APIs

Pre-Production

_____________________________________

Document Number

Swagger

(Apache 2.0)

API User Guide

(RAND)

Conformance Profile

(RAND)

CTK

Reference Implementation Code

Postman CollectionReleaseLifecycle Status

Alarm Management API

The Alarm Management API applies lessons that were learned in previous generations of similar APIs that were implemented in the Telecommunication industry, starting from ITU recommendations,, TM Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment initiative between 3GPP and TM Forum interfaces, and the more recent ETSI work on requirements for NFV interfaces.

TMF642

Not Yet Available 


Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

Communication API

Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users.

TMF681

Not Yet Available 


20.5.0

(v4.0.0)

Pre-production

Entity Catalog Management API

The entity catalog is intended to provide any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. The API provides management of the entity specifications and their associations thru CRUD operations.

TMF662

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

Entity Inventory Management API

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory.

The Entity Inventory API can be used to query the Entity and Association instances.

The Entity Inventory API can be called by an order management system to create new Entity/Association instances or update existing Entity/Association instances in the Entity Inventory.

TMF703

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

Event Management API

The Event Management API provides a standardized client interface to the enterprise event management system for  creating,  managing  and  receiving  service  related  events  to  (indicatively)  drive  automation workflows, notify other service providers for service outages and SLA violations, trigger Trouble Ticket  creation,  and  enable  more  complex  orchestration  scenarios  between  management  systems. The Event Management API can also be used to convey business level Events in support of other processes.

TMF688

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

Federated Identity API

The management of principals of any kind (persons, objects, …) and their access to resources in an open environment which can span across different enterprise boundaries. It relies on authentication, authorization and consent mechanisms to protect privacy with a simple and easy user experience. Different parties can provide identity services (operators, social networks, GSMA, …).

TMF691

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.0.0

(v4.0.0)

Pre-production
General Test Artifact Management APITMF710Not Yet Available 

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

Geographic Address Management API

Provides a standardized client interface to an Address management system. It allows looking for worldwide addresses. It can also be used to validate geographic address data, to be sure that it corresponds to a real geographic address. Finally, it can be used to look for a geographic address by: searching an area as a start (city, town ...), then zooming on the streets of this area, and finally listing all the street segments (numbers) in a street.

TMF673

Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

Geographic Location Management API

Provides the information of a geographic region of the entity (customer, equipment, address).

TMF675

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

IoT Device Management API Component Suite

In addition to including established TM Forum Open APIs, such as alarm management, resource management and activation APIs, the IoT Device Management API Component Suite also includes an IoT Data Access Endpoint API. This API allows for IoT data access using different types of protocols (MQTT IoT, CoAP, etc.). It encapsulates the protocols and allows devices to be easily integrated into solutions that support a host of IoT initiatives, including smart cities, smart factories and other vertical markets.

TMF908

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.0.0

(v4.0.0)

Pre-production

IoT Service Management API Component Suite

The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale.

TMF914

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)


Performance Management API

Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance. 

TMF628

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-producion

Recommendation API

Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.

TMF680

Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

Resource Activation and Configuration API

The Resource Activation and Configuration API can be used to query resource instances to acquire the resource activation states and attributes, and it can be used to create/update, configure and activate the resource instances.

TMF702

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

Resource Catalog Management API

The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering process.

TMF634

Not Yet Available Not Yet Available 

19.5.0

(v4.1.0)

Pre-production

Resource Function Activation and Configuration API

This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function

TMF664

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

Resource Inventory Management API

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.

TMF639

Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

Resource Ordering Management API

The REST API for Resource Order Management. It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Resource Orders (including filtering). A Resource Order API provides a standard mechanism for placing a Resource Order with all necessary order parameters.

TMF652

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

Risk Management API

The Risk Management API allows the retrieval of Risk Assessments during interaction with PartyRoles (individualsor organizations) typically engaged in an Order process from ProviderPartyRole. The Risk Assessment request is usually issued by the ProviderPartyRole (e.g. Service Provider). The resources used to retrieve these assessment are Task resources, as per the Open API guidelines for tasks.

TMF696

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 20.5.0Pre-production

Service Catalog API

The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.

TMF633

Not Yet Available 

Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

Service Qualification API

Service Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location.

TMF645

Not Yet Available Not Yet Available 

20.0.0

(v4.0.0)

Pre-production

Service Quality Management API

Through this API, any Enterprise is able to access a Service Quality Management application and extract Service Level Specifications and associated Service Level Objectives (SLO) and their thresholds.

TMF657

 

Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

Service Test Management API  

The Service Test API provides a standardized mechanism for placing a service test with all of the necessary test parameters. The API consists of a simple set of operations that interact with CRM/Service Management systems in a consistent manner. A service test is a procedure intended to check the quality, performance, or reliability of a service.

TMF653

Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

Stock Management API

The Stock Management API provides standardized mechanism for product stock management such as creation, update and retrieval of the representation of a product stock, reserve product stock, check or query product stock or adjust product stock. It also allows the notification of events related to them.

TMF687

Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0

Pre-Production

Test Case Management API

The intent of this API is to provide a consistent/standardized mechanism to manage test case models and related artifacts.

It includes the model definition as well as all available operations and is part of the TMF913 Test API Component Suite.

TMF704

 
Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production
Test Data Management APITMF706Not Yet Available 

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production
Test Environment Management APITMF705Not Yet Available 

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production
Test Execution Management APITMF708Not Yet Available 

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production
Test Result Management APITMF707Not Yet Available 

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production
Test Scenario Manegement APITMF709Not Yet Available 

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

User Roles & Permissions API

A user role is defined as the entity that defines a set of privileges covering various functions and/or manageable assets. When a user is assigned a given role then it is actually allocated all the privileges defined for that role type and the corresponding permissions are created for that user.

TMF672

Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

 

 

 

 






  • No labels