TM Forum Open APIs _____________________________________ | Document Number | Swagger (Apache 2.0 or RAND) | API User Guide / Specification (RAND) | Conformance Profile (RAND) | CTK | Sample Implementation Code | Postman Collection | Release | Swagger Version | Publication Date | ODA Domain | Notes |
---|
Account Management API Provides standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts | TMF666 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF666-Account-v4.1.0.swagger.json |
---|
Name | Account Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.1.0 | 10-Jan-2022 | Business Partner, Customer | |
Change Management API The Change Management API provides the standard integration capabilities between external applications and Change Management Application | TMF655 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF655-Change-v4.0.0.swagger.json |
---|
Name | Change Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | | v4.0.0 | 10-Jan-2022 | Common | |
Customer360 Management API An 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 | TMF717 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF717-Customer360-v4.0.0.swagger.json |
---|
Name | Customer360 Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 05-Jan-2022 | Customer | |
Digital Identity Management API. Provides the ability to manage a digital identity. This digital identity allows identification of an individual, a resource, or a partyRole (a specific role - or set of roles - for a given individual). A digital identity is associated with credential / authentification method. These credential / authentification methods should be extensible to describe all types of authentification method such as login/password, biometric, token, etc.. A contact medium is also associated with digital identity (or directly at credential level) to manage credential recovery UCs. | TMF720 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF720-DigitalIdentity-v4.0.0.swagger.json |
---|
Name | Digital Identity Management API. |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Business Partner, Common | |
Entity Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory. | TMF703 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF703-EntityInventory-v4.0.0.swagger.json |
---|
Name | Entity Inventory Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Common | |
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 |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF688-Event-v4.0.0.swagger.json |
---|
Name | Event Management API |
---|
| |
|
Show If |
---|
| |
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF688_Event_Management_API_user_guides_21.5.0.pdf |
---|
Name | Event Management API |
---|
| |
|
Show If |
---|
| |
|
Show If |
---|
|
Trackinglink |
---|
Type | CTK-Conformance |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF688_Event_Management_API_conformance_21.5.0.pdf |
---|
Name | Event Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Common | |
Federated Identity ID Management 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 |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF691-FederatedIdentity-v4.0.0.swagger.json |
---|
Name | Federated Identity ID Management API |
---|
| |
|
Show If |
---|
| |
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF691_Federated_Identity_API_user_guides_21.5.0.pdf |
---|
Name | Federated Identity ID Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Common | |
Geographic Location Management API Provides the information of a geographic region of the entity (customer, equipment, address). | TMF675 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF675-GeographicLocation-v4.0.0.swagger.json |
---|
Name | Geographic Location Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Common | 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 | |
Intent The Component Suite for Intent Management API defines the set of operations that should be offered to manage intent and intent-driven interactions in a consistent manner. | TMF921 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF908TMF921-IoTAgentAndDeviceIntent-v4.0.0.swagger.json |
---|
Name | IoT Device Management API Component SuiteIntent |
---|
| |
|
Show If |
---|
| | Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF908_IoT_Device_Management_API_Component_Suite_user_guides_21.5.0.pdf |
---|
Name | IoT Device Management API Component Suite |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 | v4.0.0 | 08-06-2022 | | |
IoT Agent and Device Management API 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 | 21.5.0 | v4.0.0 | 22-Nov-2021 | Resource | 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@authenticated | group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0.0.swagger.json |
---|
Name | IoT Agent and Device Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | SwaggerSpecification PDF |
---|
Licence | Apache 2.0RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF914-IotService-v4.0.0.swagger.jsonuser_guides/TMF908_IoT_Device_Management_API_Component_Suite_user_guides_21.5.0.pdf |
---|
Name | IoT Service Agent and Device Management API Component Suite |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Resource | |
IoT Service Management API 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 |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDFSwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF914_IoT_Service_Management_API_Component_Suite_user_guides_21.5.0.pdfswagger/TMF914-IotService-v4.0.0.swagger.json |
---|
Name | IoT Service Management API Component Suite |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Product, Common, Resource, Service | Metadata Catalog Management API Metadata Catalog | TMF725 | Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
| Trackinglink |
---|
| Type | Swagger |
---|
Licence | Apache 2.0 Image Added
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF725-MetadataCatalog-v4.0.0.swagger.json | Name | Metadata Catalog user_guides/TMF914_IoT_Service_Management_API_Component_Suite_user_guides_21.5.0.pdf |
---|
Name | IoT Service Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available Not yet available | 21.5.0 | v4.0.0 | 1022-JanNov-20222021 | Product, Common | Performance Management API Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance. | TMF628, Resource, Service | |
Metadata Catalog Management API Metadata Catalog | TMF725 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF628TMF725-PerformanceMetadataCatalog-v4.0.0.swagger.json |
---|
Name | Performance Metadata Catalog Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | | v4.0.0 | 2210-NovJan-20212022 | Service, Common | |
Process Flow Party Role Management API The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action: | TMF701A 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 | TMF669 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF701TMF669-ProcessFlowPartyRole-v4.1.0.swagger.json |
---|
Name | Process Flow Party Role Management API |
---|
| |
|
Show If |
---|
| | Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF701_Process_Flow_Management_API_user_guides_19.0.1.pdf |
---|
Name | Process Flow Management API |
---|
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 | v4.1.0 | 08-06-2022 | Business Partner | |
Performance Management API Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance. | TMF628 |
Show If |
---|
special | @anonymous@authenticated |
---|
| Image Removed | show | ifspecialmembers | @authenticated |
|
Trackinglink |
---|
Type | CTK-ConformanceSwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF701_Process_Flow_Management_API_conformance_19swagger/TMF628-Performance-v4.0.0.1swagger.pdfjson |
---|
Name | Process Flow Performance Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 19 21.5.0 .1 | v4.10.0 | 22-Nov-2021 | Service, Common | Promotion API Used 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 | TMF671 | |
Process Flow Management API The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action: | TMF701 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.01.0/swagger/TMF671TMF701-PromotionProcessFlow-v4.01.0.swagger.json |
---|
Name | Promotion Process Flow Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Product | 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 |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF701_Process_Flow_Management_API_user_guides_19.0.1.pdf |
---|
Name | Process Flow Management API |
---|
| |
|
Show If |
---|
special | @authenticated@anonymous | group
---|
| Image Added | tmforum-members
|
Show If |
---|
|
Trackinglink |
---|
Type | SwaggerCTK-Conformance |
---|
Licence | Apache 2.0RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF680-Recommendation-v4conformance/TMF701_Process_Flow_Management_API_conformance_19.0.01.swagger.jsonpdf |
---|
Name | Recommendation Process Flow Management API |
---|
| |
|
Show If |
---|
| Image Removed | Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF680_Recommendation_API_user_guides_21.5.0.pdf |
---|
Name | Recommendation API |
---|
| |
Show If |
---|
| Trackinglink |
---|
| Type | CTK-Conformance |
---|
Licence | RAND | Link Image Added
| Not yet available | Not yet available | Not yet available | 19.0.1 | v4.1.0 | 22-Nov-2021 | Common | |
Promotion Management API Used 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 | TMF671 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF680_Recommendation_API_conformance_21.5.0.pdf | Name | Recommendation swagger/TMF671-Promotion-v4.0.0.swagger.json |
---|
Name | Promotion Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Customer | 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. | TMF702Product | |
Recommendation Management 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 |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF702TMF680-ResourceActivationRecommendation-v4.0.0.swagger.json |
---|
Name | Resource Activation and Configuration Recommendation Management API |
---|
| |
|
Show If |
---|
| |
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF702_Resource_Activation_and_ConfigurationTMF680_Recommendation_API_user_guides_21.5.0.pdf |
---|
Name | Resource Activation and Configuration Recommendation Management API |
---|
| |
|
Show If |
---|
| |
|
Show If |
---|
|
Trackinglink |
---|
Type | CTK-Conformance |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF702TMF680_Recommendation_ResourceAPI_Activationconformance_v421.05.0_conformance.pdf |
---|
Name | Resource Activation and Configuration Recommendation Management API |
---|
| |
|
Show If |
---|
| | Show If |
---|
| Trackinglink |
---|
Type | CTK |
---|
Licence | RAND
| Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Customer | |
Resource Activation Management 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 |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ctkswagger/TMF702-ResourceActivation.zip-v4.0.0.swagger.json |
---|
Name | Resource Activation and Configuration Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | RISpecification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/riuser_guides/TMF702_Resource_activation.zip_Activation_and_Configuration_API_user_guides_21.5.0.pdf |
---|
Name | Resource Activation and Configuration Management API |
---|
| |
|
| | PostmanCTK-Conformance | Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ |
---|
|
|
| postmanconformance/TMF702_Resource_Activation_ |
|
|
| and_Configuration_API_postman_21.5 | zippdf | Name | Resource Activation |
---|
|
|
| and Configuration |