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 | 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 |
|---|
| |
|
| 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 |
|---|
| |
|
| 19.5.0 (v4.0.0) | Pre-production |
AI Management Communication API Component Suite The API Component Suite for AI Management defines the set of operations that should be offered in order that a Service Provider can govern Artificial Intelligence systems deployed at scale. Effective governance and management of AI must span the lifecycle from design through deployment and eventual withdrawal from service. However, the initial focus of the AI Management API is restricted to the in-life aspects of AI and in particular on the management of ‘model contracts’. Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. | TMF681TMF915 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF915TMF681_AIManagementSuiteCommunication |
|---|
| Name | AI Management Communication API Component Suite |
|---|
| |
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532119134792901/TMF915TMF681_AICommunication_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | AI Management Communication API Component Suite |
|---|
| |
|
| | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production |
Customer Bill Management API This API allows operations to find and retrieve one or several customer bills (also called invoices) produced for a customer also allows operations to find and retrieve the details of applied customer billing rates presented on a customer bill. | TMF678 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0CTK-Conformance |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/143532098/TMF915_AI_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2-apis/TMF678_CustomerBill |
|---|
| Name | Customer Bill Management API | Name | AI Management API Component Suite |
|---|
| |
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTKSpecification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532500/TMF915_AI_V4-0-0.zip134792897/TMF678_Customer_Bill_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | AI Customer Bill Management API Component Suite |
|---|
| |
|
| Not Yet Available | Not Yet Available |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146277001/TMF915TMF678-AIManagementCustomer_Bill-v4.zip?api=v2 |
|---|
| Name | AI Customer Bill Management API Component Suite |
|---|
| |
|
| 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 | PostmanSwagger |
|---|
| Licence | RANDApache 2.0 |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/143534323/TMF915-AIManagement-v4-Postman.zip?api=v2-apis/TMF662_EntityCatalog |
|---|
| Name | AI Entity Catalog Management API Component Suite |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 (v4.0.0) | Pre-production |
Communication Entity Inventory Management API Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. 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. | TMF703TMF681 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF681TMF703_CommunicationEntityInventory |
|---|
| Name | Communication Entity Inventory Management API |
|---|
| |
|
| Show If |
|---|
| Open API Table - Pre-production (Beta) | | 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 |
|---|
| |
| | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production | Customer Bill Management API This API allows operations to find and retrieve one or several customer bills (also called invoices) produced for a customer also allows operations to find and retrieve the details of applied customer billing rates presented on a customer bill. | TMF678 | | 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 |
|---|
|
| | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
| | Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF678_CustomerBillTMF688-Event |
|---|
| Name | Customer Bill Management Event management API |
|---|
| |
|
| 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 |
|---|
| | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0Specification PDF |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/134792897/TMF678_Customer_Bill_Management_API_User_Guide_v4.0.0.pdf?api=v2-apis/TMF691_FederatedIdentity |
|---|
| Name | Federated Identity | Name | Customer Bill Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | RISpecification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146277001/TMF678-Customer_Bill-v4.zip134792909/TMF691_Federated_ID_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Customer Bill Management Federated Identity API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 1920.50.0 (v4.0.0) | Pre-production |
Entity Catalog Geographic Address 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. 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. | TMF673TMF662 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF662TMF673_EntityCatalogGeographicAddress |
|---|
| Name | Entity Catalog Geographic Address Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0
|
| 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 |
|---|
|  Image Added
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.0.0 (v4.0.0) | Pre-production |
Geographic Location Management API Provides the information of a geographic region of the entity (customer, equipment, address). | TMF675 | )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/TMF703TMF675_EntityInventoryGeographicLocation |
|---|
| Name | Entity Inventory Geographic Location Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 2019.5.0 (v4.0.0) | Pre-production |
Event Geographic Site 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. Covers 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?” | TMF674TMF688 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF688-EventTMF674_GeographicSite |
|---|
| Name | Event management Geographic Site Management API |
|---|
| |
|
| 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 | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134776996/TMF674_Geographic_Site_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Geographic Site Management API |
|---|
| |
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
| Image Added |
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| CTK-Conformance | | Link | https://github.com/tmforum-apis/TMF691_FederatedIdentityprojects.tmforum.org/wiki/download/attachments/143532476/TMF674B_Geographic_Site_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Geographic Site Management | Name | Federated Identity API |
|---|
| |
|
| Not Yet Available | Not Yet Available |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RANDSpecification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792909/TMF691_Federated_ID_Management_API_User_Guide_v4.0.0.pdf143534323/TMF674-GeographicSite-v4-Postman.zip?api=v2 |
|---|
| Name | Federated Identity Geographic Site Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | | 19.520.0.0 (v4.0.0) | Pre-production |
Geographic Address IoT Device 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 | 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 |
|---|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.0.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 |
|---|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production | Geographic Site Management API Covers 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?” | TMF674 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF674_GeographicSite |
|---|
| Name | Geographic Site Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134776996/TMF674_Geographic_Site_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Geographic Site Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532476/TMF674B_Geographic_Site_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Geographic Site Management API |
|---|
|
|
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/TMF674-GeographicSite-v4-Postman.zip?api=v2 |
|---|
| Name | Geographic Site Management API |
|---|
|
|
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 Management Component Suite |
|---|
|
|
| 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 Management Component Suite |
|---|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.0.0 (v4.0.0) | Pre-production | 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 | 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 |
|---|
|
|
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.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. | TMF676 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF676_PaymentManagement |
|---|
| Name | Payment Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532510/TMF676_Payment_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Payment Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532517/TMF676B_Payment_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Payment Management API |
|---|
|
|
Not Yet Available | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146277001/TMF676-Payment-v4.zip?api=v2 |
|---|
| Name | Payment Management API |
|---|
|
|
Not Yet Available | 19.5.0 (4.0.0) | Pre-production | Prepay Balance Management API REST 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. | TMF654 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF654_PrepayBalanceManagement |
|---|
| Name | Prepay Balance Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532459/TMF654_PrepayBalance_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Prepay Balance Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532463/TMF654B_Prepay_Balance_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Prepay Balance Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532500/TMF654_Prepay_Balance_V4-0-0.zip?api=v2 |
|---|
| Name | Prepay Balance Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146277001/TMF654-PrepayBalance-v4.zip?api=v2 |
|---|
| Name | Prepay Balance Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143534323/TMF654-PrepayBalance-v4-Postman.zip?api=v2 |
|---|
| Name | Prepay Balance Management API |
|---|
|
|
20.0.0 (4.0.0) | Pre-production | Privacy Management API The Privacy management API provides a standardized mechanism for privacy profile types, privacy profiles and privacy agreements such as creation, update, retrieval, deletion and notification of events. | TMF644 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/123090132/TMF644_Privacy-4.0.0.swagger.json?version=1&modificationDate=1573117743866&api=v2 |
|---|
| Name | Privacy Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792881/TMF644_Privacy_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Privacy Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532424/TMF644B_Privacy_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Privacy Management API |
|---|
|
|
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/TMF644-Privacy-v4-Postman.zip?api=v2 |
|---|
| Name | Privacy Management API |
|---|
|
|
19.5.0 (4.0.0) | Pre-production | 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 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF680_Recommendation |
|---|
| Name | Recommendation API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134777000/TMF680_Recommendation_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Recommendation API |
|---|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.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 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF702-ResourceActivationConfiguration |
|---|
| Name | Resource Activation & Configuration API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792913/TMF702_Resource_Activation_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Activation & Configuration API |
|---|
|
|
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 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF634_ResourceCatalog |
|---|
| Name | Resource Catalog API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134776967/TMF634_Resource_Catalog_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Catalog API |
|---|
|
|
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/TMF634-ResourceCatalog-v4-Postman.zip?api=v2 |
|---|
| Name | Resource Catalog API |
|---|
|
|
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 | TMF664 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF664_ResourceFunctionActivationConfiguration |
|---|
| Name | Resource Function Activation and Configuration API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134776992/TMF664_Resource_Function_Activation_and_Configuration_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Function Activation and Configuration API |
|---|
|
|
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 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF639_ResourceInventory |
|---|
| Name | Resource Inventory API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792865/TMF639_Resource_Inventory_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Inventory API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532386/TMF639B_Resource_Inventory_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Inventory API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532500/TMF639_Resource_Inventory_V4-0-0.zip?api=v2 |
|---|
| Name | Resource Inventory API |
|---|
|
|
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/TMF639-ResourceInventory-v4-Postman.zip?api=v2 |
|---|
| Name | Resource Inventory API |
|---|
|
| | 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
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF908_IoTAgentAndDeviceComponentSuite |
|---|
| Name | IoT Agent and Device Management Component Suite |
|---|
| |
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|  Image Added
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Specification PDF | | Link | https://github.com/tmforum-apis/TMF652_ResourceOrderManagementprojects.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 Management Component Suite | Name | Resource Order Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.0.0 (v4.0.0) | Pre-production | 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.0Specification PDF |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/143532439/TMF652_Resource_Order_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Order Management API |
|---|
| |
| | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
| | -apis/TMF683_PartyInteraction | | Name | Party Interaction Management API |
|---|
| |
Open API Table - Pre-production (Beta)
|
| 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| @authenticated | | match | all |
|---|
| group | not-tmforum-members |
|---|
| Image Added |
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger | Licence | Apache 2.0Specification PDF |
|---|
| Link | https://github.com/tmforum-apis/TMF696_RiskManagementprojects.tmforum.org/wiki/download/attachments/134792905/TMF683_Party_Interaction_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Party Interaction | Name | Risk Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (4.0.0) 20.5.0 | Pre-production Service Activation and Configuration |
Payment Management API The | REST API for Service 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. .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. | TMF676 | | TMF640| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF640TMF676_ActivationConfigurationPaymentManagement |
|---|
| Name | Service Activation & Configuration Payment Management API |
|---|
| |
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792872143532510/TMF640TMF676_Service_ActivationPayment_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Activation & Configuration Payment Management API |
|---|
| |
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532402143532517/TMF640BTMF676B_ServicePayment_ActivationManagement_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Activation & Configuration Payment Management API |
|---|
| |
|
| Not Yet Available |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTKRI |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532500146277001/TMF640TMF676-Service-Activation-And-Configuration_V4-0-0Payment-v4.zip?api=v2 |
|---|
| Name | Service Activation & Configuration Payment Management API |
|---|
| |
|
| Not Yet Available | 19.5.0 (4.0.0) | Pre-production |
Privacy Management API The Privacy management API provides a standardized mechanism for privacy profile types, privacy profiles and privacy agreements such as creation, update, retrieval, deletion and notification of events. | TMF644 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | RANDRI |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146277001123090132/TMF640-ServiceActivation-v4.zip?TMF644_Privacy-4.0.0.swagger.json?version=1&modificationDate=1573117743866&api=v2 |
|---|
| Name | Service Activation & Configuration Privacy Management API |
|---|
| |
|
| | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Specification PDF | | Link | https://projects.tmforum.org/wiki/download/attachments/143534323/TMF640-ServiceActivation-v4-Postman.zip134792881/TMF644_Privacy_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Activation & Configuration Privacy Management API |
|---|
| |
|
| 20.0.0 (v4.0.0) | Pre-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
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger | Licence | Apache 2.0CTK-Conformance |
|---|
| Link | https://github.com/tmforum-apis/TMF633_ServiceCatalogprojects.tmforum.org/wiki/download/attachments/143532424/TMF644B_Privacy_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Privacy | Name | Service Catalog Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | | Not Yet Available | Not Yet Available | 20.5.0 (v4.0.0) | Pre-production | Service Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory. | TMF638 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | SwaggerPostman |
|---|
| Licence | Apache 2.0RAND |
|---|
| Link | https://github.com/tmforum-apis/TMF638_ServiceInventoryprojects.tmforum.org/wiki/download/attachments/143534323/TMF644-Privacy-v4-Postman.zip?api=v2 |
|---|
| Name | Privacy | Name | Service Inventory Management API |
|---|
| |
|
| 19.5.0 (4.0.0) | Pre-production |
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 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792858/TMF638_Service_Inventory_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Swagger | | Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF680_Recommendation |
|---|
| Name | Recommendation | Name | Service Inventory Management API |
|---|
| |
|
| | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK-ConformanceSpecification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532378134777000/TMF638BTMF680_ServiceRecommendation_InventoryManagement_API_ConformanceUser_ProfileGuide_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Inventory Management Recommendation API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.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 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0CTK |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/143532500/TMF638_Service_Inventory_V4-0-0.zip?api=v2-apis/TMF702-ResourceActivationConfiguration |
|---|
| Name | Resource Activation & Configuration | Name | Service Inventory Management API |
|---|
| |
|
| | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | RISpecification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146277001/TMF638-ServiceInventory-v4.zip134792913/TMF702_Resource_Activation_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Inventory Management Resource Activation & Configuration API |
|---|
| |
|
| 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 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | PostmanSwagger |
|---|
| Licence | RANDApache 2.0 |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/143534323/TMF638-ServiceInventory-v4-Postman.zip?api=v2-apis/TMF634_ResourceCatalog |
|---|
| Name | Resource Catalog | Name | Service Inventory Management API |
|---|
| |
|
| 20.0.0 (v4.0.0) | Pre-production | Service Ordering Management API The REST API for Service Order Management provides a standardized mechanism for placing a service order with all of the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications. | TMF641 | |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Specification PDF | | Link | https://github.com/tmforum-apis/TMF641_ServiceOrder/tree/masterprojects.tmforum.org/wiki/download/attachments/134776967/TMF634_Resource_Catalog_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Catalog | Name | Service Ordering Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RANDSpecification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792876/TMF641_Service_Ordering_Management_API_User_Guide_v4.0.0.pdf.tmforum.org/wiki/download/attachments/143534323/TMF634-ResourceCatalog-v4-Postman.zip?api=v2 |
|---|
| Name | Service Ordering Management Resource Catalog API |
|---|
| |
|
| 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 | TMF664 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0CTK-Conformance |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/143532420/TMF641B_Service_Ordering_API_Conformance_Profile_v4.0.0.pdf?api=v2-apis/TMF664_ResourceFunctionActivationConfiguration |
|---|
| Name | Resource Function Activation and Configuration | Name | Service Ordering Management API |
|---|
| |
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTKSpecification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532500/TMF641_Service_Ordering_V4-0-0.zip134776992/TMF664_Resource_Function_Activation_and_Configuration_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Ordering Management Resource Function Activation and Configuration API |
|---|
| |
|
| 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 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0RI |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/146277001/TMF641-ServiceOrdering-v4.zip?api=v2-apis/TMF639_ResourceInventory |
|---|
| Name | Resource Inventory | Name | Service Ordering Management API |
|---|
| |
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Postman | Licence | RANDSpecification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143534323/TMF641-ServiceOrdering-v4-Postman.zip134792865/TMF639_Resource_Inventory_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Ordering Management Resource Inventory API |
|---|
| |
|
| 20.0.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 | |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| CTK-Conformance | | Link | https://github.com/tmforum-apis/TMF645_ServiceQualification/tree/masterprojects.tmforum.org/wiki/download/attachments/143532386/TMF639B_Resource_Inventory_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Inventory | Name | Service Qualification API |
|---|
| |
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDFCTK |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792885143532500/TMF645TMF639_ServiceResource_Qualification_Management_API_User_Guide_v4.0.0.pdfInventory_V4-0-0.zip?api=v2 |
|---|
| Name | Service Qualification Resource Inventory API |
|---|
| |
|
| Not Yet Available |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RANDCTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532433/TMF645B_Service_Qualification_API_Conformance_Profile_v4.0.0.pdf143534323/TMF639-ResourceInventory-v4-Postman.zip?api=v2 |
|---|
| Name | Service Qualification Resource Inventory API |
|---|
| |
|
| 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. | TMF652Not Yet Available |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | PostmanSwagger |
|---|
| Licence | RANDApache 2.0 |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/143534323/TMF645-ServiceQualification-v4-Postman.zip?api=v2-apis/TMF652_ResourceOrderManagement |
|---|
| Name | Resource Order Management | Name | Service Qualification API |
|---|
| |
|
| 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 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Specification PDF | | Link | https://github.com/tmforum-apis/TMF657_ServiceQualityManagementprojects.tmforum.org/wiki/download/attachments/143532439/TMF652_Resource_Order_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Order | Name | Service Quality Management API |
|---|
| |
|
| 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 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0Specification PDF |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_API_User_Guide_v4.0.0.pdf?api=v2-apis/TMF696_RiskManagement |
|---|
| Name | Risk | Name | Service Quality Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 | Pre-production | (Beta) |
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 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | PostmanSwagger |
|---|
| Licence | RANDApache 2.0 |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/143534323/TMF657-ServiceQualityManagement-v4-Postman.zip?api=v2-apis/TMF633_ServiceCatalog |
|---|
| Name | Service Quality Catalog Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 2019.5.0 (v4.0.0) | Pre-production |
Service Test Management Qualification 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. | TMF653Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location. | TMF645 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF645_ServiceQualification/tree/master |
|---|
| Name | Service Qualification API |
|---|
| |
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
| Image Added |
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Specification PDF | | Link | https://github.com/tmforum-apis/TMF653_ServiceTestManagementprojects.tmforum.org/wiki/download/attachments/134792885/TMF645_Service_Qualification_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Test Management Qualification API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.0.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 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger | Licence | Apache 2.0CTK-Conformance |
|---|
| Link | https://github.com/tmforum-apis/TMF704_TestCaseprojects.tmforum.org/wiki/download/attachments/143532433/TMF645B_Service_Qualification_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Qualification | Name | Test Case Managment API |
|---|
| |
|
| Not Yet Available | Not Yet Available |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RANDSpecification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/141167930/TMF704_Test_Case_Management_API_User_Guide_v4.0.0.pdf143534323/TMF645-ServiceQualification-v4-Postman.zip?api=v2 |
|---|
| Name | Test Case Managment Service Qualification API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 (v4.0.0) | | 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 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF657_ServiceQualityManagement |
|---|
| Name | Service Quality Management API |
|---|
| |
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
| Image Added |
| Pre-production | Usage Management API Provides 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 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger | Licence | Apache 2.0Specification PDF |
|---|
| Link | https://github.com/tmforum-apis/TMF635_UsageManagementprojects.tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Quality | Name | Usage Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RANDSpecification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532412/TMF635_Usage_Management_API_User_Guide_v4.0.0.pdf143534323/TMF657-ServiceQualityManagement-v4-Postman.zip?api=v2 |
|---|
| Name | Usage Service Quality Management API |
|---|
| |
|
| Show If |
|---|
| Open API Table - Pre-production (Beta) | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
| | Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532416/TMF635B_Usage_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Usage Management API |
|---|
| |
|---|
|  Image Added
|
| 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 |
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
|
| | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
| | Trackinglink |
|---|
| Type | CTK |
|---|
| Link | https://projectsgithub.tmforum.org/wiki/download/attachments/143532500/TMF635_Usage_V4-0-0-fixed.zip?api=v2com/tmforum-apis/TMF653_ServiceTestManagement |
|---|
| Name | Service Test | Name | Usage Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.0.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 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0RI |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/146277001/TMF635-Usage-v4.zip?api=v2-apis/TMF704_TestCase |
|---|
| Name | Test Case Managment | Name | Usage Management API |
|---|
| |
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Specification PDF | | Link | https://projects.tmforum.org/wiki/download/attachments/143534323/TMF635-Usage-v4-Postman.zip141167930/TMF704_Test_Case_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Usage Management Test Case Managment API |
|---|
| |
|
| 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 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF672_UserRolesPermissions |
|---|
| Name | User Roles & Permissions API |
|---|
| |
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792889/TMF672_User_Role_Permission_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | User Roles & Permissions API |
|---|
| |
|
| 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/TMF672-UserRolePermission-v4-Postman.zip?api=v2 |
|---|
| Name | User Roles & Permissions API |
|---|
| |
|
| 19.5.0 (v4.0.0) | Pre-production |
