Page History

...

Table Filter
sparkName Sparkline datepattern yy-mm-dd id 1583007004662_405528633 sort Released TM Forum Open APIs (‍Asc) isOR AND separator Point (.)
TM Forum Open APIs Pre-Production _____________________________________ Document Number Swagger (Apache 2.0) API User Guide (RAND) Conformance Profile (RAND) CTK Reference Implementation Code Postman Collection Release Lifecycle 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 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF642_AlarmManagement Name Alarm Management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Show If special @authenticated match all group tmforum-members Trackinglink Type Specification PDF Link https://projects.tmforum.org/wiki/download/attachments/134776981/TMF642_Alarm_Management_API_User_Guide_v4.0.0.pdf?api=v2 Name Alarm Management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Not Yet Available  Not Yet Available  Not Yet Available  Show If special @authenticated match all group tmforum-members Trackinglink Type Postman Licence RAND Link https://projects.tmforum.org/wiki/download/attachments/143534323/TMF642-Alarm-v4-Postman.zip?api=v2 Name Alarm Management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous 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 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF681_Communication Name Communication API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Show If special @authenticated match all group tmforum-members Trackinglink Type Specification PDF Link https://projects.tmforum.org/wiki/download/attachments/134792901/TMF681_Communication_Management_API_User_Guide_v4.0.0.pdf?api=v2 Name Communication API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Not Yet Available  Not Yet Available  Not Yet Available  Not Yet Available  19.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 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF662_EntityCatalog Name Entity Catalog Management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous 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 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF703_EntityInventory Name Entity Inventory Management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous 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 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF688-Event Name Event management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous 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 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF691_FederatedIdentity Name Federated Identity API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Show If special @authenticated match all group tmforum-members Trackinglink Type Specification PDF Link https://projects.tmforum.org/wiki/download/attachments/134792909/TMF691_Federated_ID_Management_API_User_Guide_v4.0.0.pdf?api=v2 Name Federated Identity API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Not Yet Available  Not Yet Available  Not Yet Available  Not Yet Available  20.0.0 (v4.0.0) Pre-production General Test Artifact Management API TMF710 Not Yet Available  Show If special @authenticated match all group tmforum-members Trackinglink Type Specification PDF Link https://projects.tmforum.org/wiki/download/attachments/146293816/TMF710_General_Test_Artifact_Management_API_User_Guide_v4.0.pdf?api=v2 Name General Test Artifact Management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous 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 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF673_GeographicAddress Name Geographic Address Management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Show If special @authenticated match all group tmforum-members Trackinglink Type Specification PDF Link https://projects.tmforum.org/wiki/download/attachments/134792893/TMF673_Geographic_Address_Management_API_User_Guide_v4.0.0.pdf?api=v2 Name Geographic Address Management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Show If special @authenticated match all group tmforum-members Trackinglink Type CTK-Conformance Link https://projects.tmforum.org/wiki/download/attachments/146293800/TMF673B_Geographic_Address_API%20Conformance_Profile_v4.0.0.pdf?api=v2 Name Geographic Address Management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous 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 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF675_GeographicLocation Name Geographic Location Management API   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous 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 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF908_IoTAgentAndDeviceComponentSuite Name Iot Agent and Device API Suite   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Show If special @authenticated match all group tmforum-members Trackinglink Type Specification PDF Link https://projects.tmforum.org/wiki/download/attachments/123085401/TMF908_IoT_Agent_and_Device_Component_Suite_REST_Specification_v1.0.1.pdf?version=1&modificationDate=1592864314038&api=v2 Name Iot Agent and Device API Suite   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous 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 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF914_IoTServiceComponentSuite Name IoT Service Management API Suite   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Show If special @authenticated match all group tmforum-members Trackinglink Type Specification PDF Link https://projects.tmforum.org/wiki/download/attachments/143531023/TMF914_IOT_Service_Management_API_User_Guide_v4.0.0.pdf?api=v2 Name IoT Service Management API Suite   Show If special @authenticated match all group not-tmforum-members Show If special @anonymous Not Yet Available  Not Yet Available  Not Yet Available  Not Yet Available  20.5.0 (v4.0.0) Party Interaction Management API A User Interaction captures information about past interactions in order to re-use it in future ones. This allows agents to serve users better by knowing the steps they went through. It also allows customers to see better the actions they have performed and how they interacted with us. TMF683 Show If special @authenticated match all group tmforum-members Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF683_PartyInteraction Name Party Interaction Management API   Show If special @authenticated match all group not-tmforum-members Image Removed Show If special @anonymous Image Removed
Show If
special @authenticated match all group tmforum-members

Trackinglink
Type Specification PDF Link https://projects.tmforum.org/wiki/download/attachments/134792905/TMF683_Party_Interaction_Management_API_User_Guide_v4.0.0.pdf?api=v2 Name Party Interaction Management API

Show If
special @authenticated match all group not-tmforum-members
Image Removed

Show If
special @anonymous
Image Removed

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

19.5.0

(4.0.0)

Pre-production

Payment Management API

The Payments API provides the standardized client interface to Payment Systems for notifying about performed payments or refunds. Examples of Payment API originators (clients) include Web servers, mobile app servers, Contact center dashboards or retail store systems. 

TMF676Not Yet Available Not Yet Available 

19.5.0

(4.0.0)

Pre-production

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. 

TMF628Not 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.

TMF680Not 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.

TMF702Not 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.

TMF634Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.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

TMF664Not 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.

TMF639Not 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.

TMF652Not 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.

TMF696Not Yet Available 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.

TMF633Not Yet Available Not Yet Available 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.

TMF645Not 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.

TMF657Not 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.

TMF653Not 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.

TMF687Not Yet Available Not Yet Available 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.

TMF704Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-productionTest Data Management APITMF706Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-productionTest Environment Management APITMF705Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-productionTest Execution Management APITMF708Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-productionTest Result Management APITMF707Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-productionTest 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.

TMF672Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production