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 | EngagedPartyBusiness 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 | EngagedPartyBusiness Partner, Common | |
Document Entity Inventory Management API TMF667 Document API describes the meta-data of a Document, such as the name, creationDate and lifecycle status. The (typically binary) body of this document (such as a Word.doc, PDF, Video clip, or Image) will be held in the associated Attachment(s) either by Ref or Value. If by value - the binary content is held in the Attachment.content. If by reference, the Attachment.url might point to a (file:) or remote (http:) pointer to the Document media. A Document may be associated with a DocumentSpecification, which will detail the characteristics of that type of Document (an Image may have a width, height and format; a Video may have a length and format). A Document has a collection of RelatedParty's, for roles such as author, reviewer, publisher, and a lifecycle status to take the document through a simple set of production stages. | TMF667The 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 |
---|
special | @authenticated@anonymous |
---|
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/TMF667-Document-v4.0.0.swagger.json |
---|
Name | Document Management API |
---|
| |
Image Added |
| 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 |
---|
|
|
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/TMF667_Document_Management_API_REST_Specification_v4-0-0.pdfswagger/TMF688-Event-v4.0.0.swagger.json |
---|
Name | Event | Name | Document Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | CTK-ConformanceSpecification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF667_Document_v4.0.0_conformanceuser_guides/TMF688_Event_Management_API_user_guides_21.5.0.pdf |
---|
Name | Document Event Management API |
---|
| |
|
|
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/ctk/TMF667-Document-v4.0.0-ctk.zipconformance/TMF688_Event_Management_API_conformance_21.5.0.pdf |
---|
Name | Document Event Management API |
---|
| |
|
Show If |
---|
| Image Removed | Show If |
---|
| Trackinglink |
---|
Type | RI |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ri/TMF667_Document- Image Added |
| Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | -ri.zip
Name | Document Management API |
---|
|
| 22-Nov-2021 | Common | | Federated 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- |
---|
|
| Not yet available | 22.0.0 | v4.0.0 | 05-Jan-2022 | 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/TMF703TMF691-EntityInventoryFederatedIdentity-v4.0.0.swagger.json |
---|
Name | Entity Inventory Federated ID 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 | 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 ID Management API |
---|
| |
|
| Show If |
---|
special | @authenticated@anonymous |
---|
group | tmforum-members |
---|
| Image Added |
| 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 |
---|
| 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/TMF688TMF675-EventGeographicLocation-v4.0.0.swagger.json |
---|
Name | Event 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 | |
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 |
---|
| 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/TMF688_Event_Management_API_user_guides_21.5.0.pdfswagger/TMF921-Intent-v4.0.0.swagger.json |
---|
Name | Intent | Name | Event Management API |
---|
| |
|
Show If |
---|
| Image Removed | 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 |
---|
| |
| Not yet available | Not yet available | Not yet available | 21.5.0 | | 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 | v4.0.0 | 22-Nov-2021 | Common | 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 |
---|
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/TMF691TMF908-FederatedIdentityIoTAgentAndDevice-v4.0.0.swagger.json |
---|
Name | Federated Identity IoT Agent and Device 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/TMF691TMF908_IoT_FederatedDevice_IdentityManagement_API_Component_Suite_user_guides_21.5.0.pdf |
---|
Name | Federated Identity IoT Agent and Device 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 | CommonResource | |
Geographic Location IoT Service Management API Provides the information of a geographic region of the entity (customer, equipment, address). 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. | TMF914TMF675 |
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/TMF675TMF914-GeographicLocationIotService-v4.0.0.swagger.json |
---|
Name | Geographic Location IoT Service 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/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 | 21.5.0 | v4.0.0 | 22-Nov-2021 | Product, Common, Resource, Service | |
Metadata Catalog Management API Metadata Catalog | TMF725 | | 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 | 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/TMF908TMF725-IoTAgentAndDeviceMetadataCatalog-v4.0.0.swagger.json |
---|
Name | IoT Device Metadata Catalog Management API Component Suite |
---|
| |
|
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 | | v4.0.0 | 10-Jan-2022 | Common | |
Party Role Management API A 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 | | 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 | 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/TMF914TMF669-IotServicePartyRole-v4.01.0.swagger.json |
---|
Name | IoT Service Party Role Management API Component Suite |
---|
| |
|
Show If |
---|
| |
| 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 | @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/TMF628-Performance-v4.0.0.swagger.json |
---|
Name | Performance Management API |
---|
|
| 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/TMF914_IoT_Service_Management_API_Component_Suite_user_guides_21.5.0.pdf |
---|
Name | IoT Service Management API Component Suite |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | ProductService, Common, Resource, Service | |
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 | 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.01.0/swagger/TMF725TMF701-MetadataCatalogProcessFlow-v4.01.0.swagger.json |
---|
Name | Metadata Catalog Process Flow 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 | |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https |
---|
|
|
| Payment Method API This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer. | TMF670 | 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/TMF670-PaymentMethod-v4.0.0.swagger.jsonuser_guides/TMF701_Process_Flow_Management_API_Specification_v4.1.0.pdf |
---|
Name | Process Flow Management | Name | Payment Method API |
---|
| |
|
|
Show If |
---|
special | @authenticated | group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDFCTK-Conformance |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.01.0/user_guidesconformance/TMF670TMF701_PaymentProcess_MethodFlow_API_user_guides_21.5Management_Conformance-v4.1.0.pdf |
---|
Name | Payment Method Process Flow Management API |
---|
| |
|
Show If |
---|
| Image Removed | 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/TMF670_Payment_Method_v4.0.0_conformance.pdf |
---|
Name | Payment Method API |
---|
| 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 | | Not yet available | | @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/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 | Product | |
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 omnichannel. | TMF680 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link |
---|
|
|
| Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Customer | 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 | @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/TMF628TMF680-PerformanceRecommendation-v4.0.0.swagger.json |
---|
Name | Performance Recommendation 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 | Service, Common | | | 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 | SwaggerSpecification PDF |
---|
Licence | Apache 2.0RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF701-ProcessFlow-v4.0user_guides/TMF680_Recommendation_API_user_guides_21.5.0.swagger.jsonpdf |
---|
Name | Process Flow Recommendation Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDFCTK-Conformance |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guidesconformance/TMF701TMF680_Process_FlowRecommendation_Management_API_user_guides_19conformance_21.5.0.1.pdf |
---|
Name | Process Flow Recommendation Management API |
---|
| |
|
| 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 |
---|
|
| 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/TMF701_Process_Flow_Management_API_conformance_19swagger/TMF702-ResourceActivation-v4.0.0.1swagger.pdfjson |
---|
Name | Process Flow Resource Activation Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | 19.0.1 | v4.0.0 | 22-Nov-2021 | 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 |
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_Configuration_API_user_guides_21.5.0.pdf |
---|
Name | Resource Activation Management API |
---|
| |
|
Show If |
---|
special | @authenticated@anonymous | group
---|
| Image Added |
|
Show If |
---|
special | @authenticatedtmforum-members |
---|
|
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/TMF671-Promotion-conformance/TMF702_Resource_Activation_v4.0.0_conformance.swagger.jsonpdf |
---|
Name | Promotion Resource Activation 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 | 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 |
---|
|
Trackinglink |
---|
Type | CTK |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ctk/TMF702-ResourceActivation.zip |
---|
Name | Resource Activation Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated | group | tmforum-members |
---|
|
Trackinglink |
---|
Type | SwaggerRI |
---|
Licence | Apache 2.0RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF680-Recommendation-v4.0.0.swagger.jsonri/TMF702_Resource_activation.zip |
---|
Name | Resource Activation Management | Name | Recommendation API |
---|
| |
|
| | group | tmforum-members | | Specification PDFPostman | Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ |
---|
|
|
| user_guides/TMF680_Recommendationpostman/TMF702_Resource_Activation_and_Configuration_API_ |
|
|
| user_guides | pdf | Recommendation Resource Activation Management API |
| |
|
| 21.5.0 | v4.0.0 | 22-Nov-2021 | Resource, Common | |
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 |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents. |
---|
|
| Image Removed | 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/TMF680_Recommendation_API_conformance_21.5.0.pdfswagger/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json |
---|
Name | Resource Function Activation and Configuration | Name | Recommendation API |
---|
| |
|
| 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. | TMF702 | |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
|
| 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/TMF702-ResourceActivation-v4.0.0.swagger.jsonuser_guides/TMF664_Resource_Function_Activation_Management_API_REST_Specification_v4-0-0.pdf |
---|
Name | Resource Function Activation and Configuration API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 | v4.0.0 | 08-06-2022 | Resource, Common | |
Sales Management API The 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. | TMF699 |
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. |
---|
|
| 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.01.0/user_guides/TMF702_Resource_Activation_and_Configuration_API_user_guides_21.5.0.pdfswagger/TMF699-Sales-v4.1.0.swagger.json |
---|
Name | Sales Management | Name | Resource Activation and Configuration API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | CTK-ConformanceSpecification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.01.0/conformance/TMF702_Resource_Activationuser_guides/TMF699_Sales_Management_API_REST_Specification_v4.01.0_conformance.pdf |
---|
Name | Resource Activation and Configuration Sales Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 | v4.1.0 | 08-06-2022 | MarketingSales | |
Service Usage Management API | TMF727 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | CTKSwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ctkswagger/TMF702-ResourceActivation.zipTMF727-ServiceUsage-v4.0.0.swagger.json |
---|
Name | Resource Activation and Configuration Service Usage Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 | v4.0.0 | 08-06-2022 | | |
Shipment Management Management API Shipment Management | TMF711 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | RISwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ri/TMF702_Resource_activation.zipswagger/TMF711-ShipmentManagement-v4.0.0.swagger.json |
---|
Name | Shipment Management Management | Name | Resource Activation and Configuration API |
---|
| |
|
| Show If |
---|
|
Trackinglink |
---|
Type | Postman |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/postman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zip |
---|
Name | Resource Activation and Configuration API |
---|
|
|
21.5.0 | v4.0.0 | 22-Nov-2021 | Resource, Common | Service Test Management API Service Test Description | TMF653 | 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.2.0/swagger/TMF653-ServiceTest-v4.2.0.swagger.json |
---|
Name | Service Test Management API |
---|
|
|
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.2.0/user_guides/TMF653_Service_Test_Management_API_REST_Specification_v4-2-0.pdf |
---|
Name | Service Test Management API |
---|
|
|
Show If |
---|
|
Trackinglink |
---|
Type | CTK-Conformance |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.2.0/conformance/TMF653_Service_Test_v4.2.0_conformance.pdf |
---|
Name | Service Test Management API |
---|
|
|
Show If |
---|
|
Trackinglink |
---|
Type | CTK |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.2.0/ctk/TMF653-ServiceTest.zip |
---|
Name | Service Test Management API |
---|
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | | v4.0.0 | 10-Jan-2022 | Business Partner | | Shipping Order Management API Provides 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. | TMF700 | |
Show If |
---|
special | @anonymous@authenticated |
---|
| Image Removed | show | ifspecialmembers | @authenticated |
|
Trackinglink |
---|
Type | RISwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.20.0/ri/TMF653_ServiceTest.zipswagger/TMF700-ShippingOrder-v4.0.0.swagger.json |
---|
Name | Service Test Shipping Order Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
|
| PostmanSpecification PDF | Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4. |
---|
|
|
| 2 | postman/TMF653-ServiceTest-v4.2.0.postman_collection.jsonuser_guides/TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0.pdf | Name | Shipping Order |
---|
|
|
| Name | Service Test |
---|
Image Removed |
21.5.0 | v4.2.0 | 10-Dec-2021 | Service | Shipment Management API Shipment Management | TMF711 |
Show If |
---|
special | @authenticated | group | tmforum-members |
---|
|
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/TMF711-ShipmentManagement-conformance/TMF700_Shipping_Order_v4.0.0_conformance.swagger.jsonpdf |
---|
Name | Shipment Shipping Order 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 | EngagedPartyBusiness Partner | | Shipping Order SLA Management API Provides 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.a standardized interface for Service Level Agreement (SLA) life-cycle Management (SLA Negotiation, SLA configuration SLA Activation/enforcement, SLA Operations, SLA violation / consequence handling, SLA reporting) between a Customer and a Service Provider which provides offers (product with attached SLA in its catalogue) the customer can discover, browse, trigger and order. | TMF623TMF700 |
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/TMF700TMF623-ShippingOrderSLA-v4.0.0.swagger.json |
---|
Name | Shipping Order SLA Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21 22.50.0 | v4.0.0 | 2208-Nov06-20212022 | EngagedPartyBusiness Partner | |
Usage Consumption Management API This API provides the real-time value within buckets (SMS, Voice, Data, TV for example) that a customer consumes with each of their devices, related to subscribed communication products without having to wait for the bill cycle. A usage report retrieves the data related to these balances. | TMF677 |
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/TMF677-UsageConsumption-v4.0.1.swagger.json |
---|
Name | Usage Consumption 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 | |
Work Order Management API The Work Order API performs the following operations on a workOrder resource: | TMF697 |
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/TMF697-WorkOrder-v4.0.0.swagger.json |
---|
Name | Work Order Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | | v4.0.0 | 22-Nov-2021 | EngagedPartyBusiness Partner | |