Pre-production Open API table
This table contains APIs in the early adoption or still in development. For Production APIs please click here. For previous versions which are no longer supported please click here.
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.
TM Forum Open APIssorted ascending | ODA domain | Document number | Version | Publication date | Notes | |
---|---|---|---|---|---|---|
Account Management APIProvides standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts | Business Partner, Customer | TMF666 | v4.1.0 | 10-Jan-2022 | No notes | |
Closed Loop ManagementClosedloop formally defines a system of “control mechanisms”, “feed forwards”, “feedback” workflows that altogether operates as a framework in which outputs of the system, workflow or process, are circled back (feedback) and used as inputs to improve future outputs. Please refer to IG1219 for the formal TM Forum definition (also check TMF071). | Common | TMF753 | v5.0.0 | No notes | ||
Customer360 Management APIAn API to give a consolidated Customer overview. This is a view-only API, based on the various underlying involved TM Forum Open APIs. This API provides references where one can find detailed information for: Account, Agreement, Appointment, CustomerBill, InteractionItem, LoyaltyBalance, ProductOrder, ProductValue, Promotion, Quote, ServiceProblem, TroubleTicket, UsageSpecification | Customer | TMF717 | v4.0.0 | 05-Jan-2022 | No notes | |
DCS 5GSlice Service Activation APIDomain Context Specialization of TMF640 for 5G Service Slice, Swagger of Contract is strongly bound to the GSMA Service Definition | Service | TMF924 | v4.0.0 | No notes | ||
Dunning Case ManagementNo description available yet | Common | TMF728 | v4.0.0 | No notes | ||
Entity Inventory Management APIThe intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory. | Common | TMF703 | v4.0.0 | 22-Nov-2021 | No notes | |
Event Management APIThe 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. | Common | TMF688 | v4.0.0 | 22-Nov-2021 | No notes | |
Federated ID Management APIThe 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, …). | Common | TMF691 | v4.0.0 | 22-Nov-2021 | No notes | |
Geographic Location Management APIProvides the information of a geographic region of the entity (customer, equipment, address). | Common | TMF675 | v4.0.0 | 22-Nov-2021 | No notes | |
Geographic Site Management APICovers the operations to manage (create, read, delete) sites that can be associated with a customer, account, service delivery or other entities. This API defines a Site as a convenience class that allows easy reference to places important to other entities, where a geographic place is an entity that can answer the question “where?” | Common | TMF674 | v5.0.0 | No notes | ||
IoT Agent and Device Management APIIn 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. | Resource | TMF908 | v4.0.0 | 22-Nov-2021 | No notes | |
IoT Service Management APIThe 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. | Product, Common, Resource, Service | TMF914 | v4.0.0 | 22-Nov-2021 | No notes | |
Loyalty Management APISupports the management of loyalty program specifications, loyalty program members, their associated products and loyalty accounts with loyalty balances | TMF658 | v4.0.0 | 29-Feb-2024 | No notes | ||
Metadata Catalog Management APIMetadata Catalog | Common | TMF725 | v4.0.0 | 10-Jan-2022 | No notes | |
Network as a Service Management APIThe API Component Suite supports of a set of Operational Domains exposing and managing “Network” Services. These services are referred to as Network as a Service (NaaS) and include all services offered from a service provider including connectivity, end points, media services, etc. | Common, Product, Service | TMF909 | v4.2.0 | No notes | ||
Party Role Management APIA standardized mechanism for general party roles and includes operations such as creation, update, retrieval, deletion and notification of events. Notice that for the management of customers there is a specific Customer Management API.Party Role management API manages the following data resources: PartyRole | Business Partner | TMF669 | v4.1.0 | 08-06-2022 | No notes | |
Payment Method Management APIThis API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer. | Customer | TMF670 | v5.0.0 | 22-Nov-2021 | No notes | |
Performance Management APIProvides 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. | Service, Common | TMF628 | v4.0.0 | 22-Nov-2021 | No notes | |
Performance Thresholding Management APIProvides a standardized mechanism for performance management such as creation, partial or full update and retrieval of the resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It allows also notification of events related to performance | TMF649 | v4.0.0 | 3-12-2022 | No notes | ||
Policy Management APIPolicy API is designed from SID Policy description. The Policy API is defined from Event-Condition-ActionECA definition: The Event part specifies the signal that triggers the invocation of the rule. The condition part is a logical test that, if satisfied or evaluates to true, causes the action to becarried out. The action part consists of updates or invocations on the local data | Common | TMF723 | v5.0.0 | No notes | ||
Prepay Balance Management APIREST API for Balance Management. It includes the model definition as well as all available operations for prepay balance management. Prepaid subscribers pay fees before using services. Therefore, the subscribers must have sufficient balances. Operators can provide multiple recharge channels for subscribers. Subscribers can pass credit between different subscriptions, therefore transferring the balance from one account to another. | Customer | TMF654 | v4.1.0 | 17-Feb-23 | No notes | |
Private Optimized BindingPrivate Optimized Binding API goal is to provide the ability to connect a User Equipment with a Cloud Application. | Common | TMF759 | v5.0.0 | No notes | ||
Process Flow Management APIThe ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action: | Common | TMF701 | v5.0.0 | 22-Nov-2021 | No notes | |
Process Flow Management APIThe ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action: | Common | TMF701 | v4.1.0 | 22-Nov-2021 | No notes | |
Product Offering Qualification Management APIProduct Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility. | Product | TMF679 | v5.0.0 | No notes | ||
Promotion Management APIUsed to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit | Product | TMF671 | v4.0.0 | 22-Nov-2021 | No notes | |
Quote Management APIThe Quote API is one of the Pre-Ordering Management APIs. The customer Quote API provides a standardized mechanism for placing a customer quote with all the necessary quote parameters. | Customer | TMF648 | v5.0.0 | No notes | ||
Resource Inventory Management APIThe intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory. | Resource | TMF639 | v5.0.0 | No notes | ||
Sales Management APIThe Sales Management API provides interfaces for Sales Lead, Sales Opportunity, Sales Quote and the other management capabilities to support the sales activities to build relationship with the prospect customer who could be a person or organization that has an interest in the goods and/or services and possibly become the actual customers with one or more subscriptions. | MarketingSales | TMF699 | v5.0.0 | 08-06-2022 | No notes | |
Sales Management APIThe Sales Management API provides interfaces for Sales Lead, Sales Opportunity, Sales Quote and the other management capabilities to support the sales activities to build relationship with the prospect customer who could be a person or organization that has an interest in the goods and/or services and possibly become the actual customers with one or more subscriptions. | MarketingSales | TMF699 | v4.1.0 | 08-06-2022 | No notes | |
Service Activation Management APIThe REST API for Activation and Configuration allows the user to retrieve, create, update, delete services and retrieve the monitor resource used to monitor the execution of asynchronous requests on a specific resource. Although all the examples given in the API specification are relative to Services, the same API can be used to Activate and Configure Services or Resources. | Common, Service | TMF640 | v4.2.0 | 29-Feb-2024 | No notes | |
Service Activation Management APIThe REST API for Activation and Configuration allows the user to retrieve, create, update, delete services and retrieve the monitor resource used to monitor the execution of asynchronous requests on a specific resource. Although all the examples given in the API specification are relative to Services, the same API can be used to Activate and Configure Services or Resources. | Common, Service | TMF640 | v5.0.0 | No notes | ||
Service Catalog Management APIThe Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | Service | TMF633 | v5.0.0 | No notes | ||
Service Inventory Management APIThe intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory. | TMF638 | v4.2.0 | 7-Mar-2024 | No notes | ||
Service Ordering Management APIThe REST API for Service Order Management provides a standardized mechanism for placing a service order with all the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications. | Service | TMF641 | v5.0.0 | No notes | ||
Service Problem Management APIThe SPM API is used to manage service problems. Service problems are generated based on the information declared by a partner or the event information notified from infrastructure providers. The event information includes alarm information, performance anomaly information, trouble ticket information, SLA violation, maintenance information, and prediction information. | Service | TMF656 | v5.0.0 | No notes | ||
Service Qualification Management APIService Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location. | Service | TMF645 | v4.2.0 | No notes | ||
Service Qualification Management APIService Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location. | Service | TMF645 | v5.0.0 | 29-Feb-2024 | No notes | |
Service Test Management APIThe Service Test API provides a standardized mechanism for placing a service test with all 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. | Service | TMF653 | v5.0.0 | 1-Mar-2024 | No notes | |
Service Usage Management APIThe Service Usage Management API provides a standardized mechanism for service usage management such as the creation, update, retrieval, import and export of a collection of service usages. | TMF727 | v4.0.0 | No notes | |||
Service Usage Management APIThe Service Usage Management API provides a standardized mechanism for service usage management such as the creation, update, retrieval, import and export of a collection of service usages. | TMF727 | v5.0.0 | 08-06-2022 | No notes | ||
Shipment Management Management APIShipment Management | Business Partner | TMF711 | v4.0.0 | 10-Jan-2022 | No notes | |
Shipping Order Management APIProvides the necessary functionality to create, update and query Shipping Orders. A Shipping Order is a document used by a business to specify what items are to be transferred from a storage location or warehouse to which person and to which new location. A ShippingOrder typically is sent along with a shipment of goods so that the person receiving them can verify that the document correctly reflects the items that they actually received. | Business Partner | TMF700 | v4.0.0 | 22-Nov-2021 | No notes | |
Topology Management APINo description yet | TMF686 | v4.0.0 | 17-02-2023 | No notes | ||
Trouble Ticket Management APIProvides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets among partners as a result of an issue or problem identified by a customer or another system. Examples of Trouble Ticket API clients include CRM applications, network management or fault management systems, or other trouble ticket management systems (e.g. B2B). | Common | TMF621 | v4.1.0 | 29-Feb-2024 | No notes | |
Usage Management APIProvides standardized mechanism for usage management such as creation, update, retrieval, import and export of a collection of usages. The API manages both rated and non-rated usage. For example, it allows a service provider to 1) retrieve usage generated by a partner service platform in order to rate it and 2) to provide rated usage to a partner for consumption follow-up purposes. | TMF635 | v4.1.0 | 7-Mar-2024 | No notes | ||
Warranty ManagementNo description available yet | Common | TMF715 | v4.0.0 | No notes | ||
Work ManagementNo description available yet | Common | TMF713 | v4.0.0 | No notes | ||
Work Order Management APIThe Work Order API performs the following operations on a workOrder resource: | Business Partner | TMF697 | v4.0.0 | 22-Nov-2021 | No notes | |
Work Order Management APIThe Work Order API performs the following operations on a workOrder resource: | Business Partner | TMF697 | v5.0.0 | 22-Nov-2021 | No notes | |
Work Qualification ManagementNo description available yet | Common | TMF714 | v4.0.0 | No notes | ||