Pre-Production_____________________________________ | Document Number | Swagger (Apache 2.0 or RAND) | API User Guide / Specification (RAND) | Conformance Profile (RAND) | CTK |
---|
Reference Sample 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. | 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 |
TMF642matchall | |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF642_AlarmManagementtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF666-Account-v4.1.0.swagger.json | Name | Account |
---|
|
|
|
Name | Alarm @authenticatedmatchall | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
| 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 |
---|
|
Image Removedmatch | all |
Specification PDFprojects.tmforum.org/wiki/download/attachments/134776981/TMF642_Alarm_Management_API_User_Guide_tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF655-Change-v4.0.0 |
|
|
|
.pdf?api=v2Alarm @authenticatedNot Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0
(match | all |
---|
group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | |
)Pre-production | Communication API Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. | 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 |
TMF681match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF681_CommunicationBeta/4.0.0/swagger/TMF717-Customer360-v4.0.0.swagger.json | Name | Customer360 Management |
---|
|
|
|
Name | Communication @authenticatedmatchall | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
| 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 |
---|
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 |
---|
|
match | allnot-Open API Table - Pre-production (Beta) |
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- |
---|
|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.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 | .swagger.json | Name | Digital Identity Management API. |
---|
| |
|
|
@authenticatedmatchall | group | tmforum-members |
---|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://github.com/tmforum-apis/TMF678_CustomerBill |
---|
Name | Customer Bill 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 | 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 |
matchall | not-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/134792897/TMF678_Customer_Bill_Management_API_User_Guide_ |
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 |
---|
|
|
|
.pdf?api=v2Customer Bill Entity Inventory Management API |
| |
|
|
@authenticatedmatchall | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21 |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19()Pre-production | Entity Catalog 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.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 |
TMF662match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF662_EntityCatalogtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF688-Event-v4.0.0.swagger.json | Name | Event |
---|
|
|
|
Name | Entity Catalog @authenticated | match | allnot-Open API Table - Pre-production (Beta) |
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. |
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 |
---|
| |
|
|
TMF688matchallgroup | tmforum-members |
---|
Trackinglink |
---|
Type | Swagger |
---|
CTK-Conformance | Licence | RAND |
---|
|
|
|
Licence | Apache 2.0github.com/tmforum-apis/TMF688-Eventtmf-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 @authenticatedmatchall | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | | Not yet available | Not yet available | Not yet available | 21 |
19()Pre-production22-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 | |
match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF691_FederatedIdentitytmf-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 @authenticated | match | all |
---|
group | not-tmforum-membersOpen API Table - Pre-production (Beta) |
Show If |
---|
|
Open API Table - Pre-production (Beta)match | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134792909/tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF691_Federated_ |
|
|
|
ID_ManagementUserGuidev40?api=v2 Identity @authenticated | match | all |
---|
group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
| 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 | |
@anonymous | Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.0.0 (v4.0.0) | Pre-production | Geographic Address Management API Provides a standardized client interface to an Address management system. It allows looking for worldwide addresses. It can also be used to validate geographic address data, to be sure that it corresponds to a real geographic address. Finally, it can be used to look for a geographic address by: searching an area as a start (city, town ...), then zooming on the streets of this area, and finally listing all the street segments (numbers) in a street. | @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 |
---|
| |
|
|
TMF673@authenticatedmatchall | group | tmforum-members |
---|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://github.com/tmforum-apis/TMF673_GeographicAddress |
---|
Name | Geographic Address 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 | 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 |
match | all |
not-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/134792893/TMF673_Geographic_Address_Management_API_User_Guide_
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/TMF921-Intent-v4.0.0. |
---|
|
|
|
pdf?api=v2Geographic Address Management API@authenticatedmatch | all |
---|
group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22 |
20()PreproductionGeographic Location Management API Provides the information of a geographic region of the entity (customer, equipment, address). | 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 |
TMF675match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF675_GeographicLocationBeta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0.0.swagger.json | Name | IoT Agent and Device |
---|
|
|
|
Name | Geographic Location @authenticated | match | allnot-Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production |
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 Agent and Device Management API |
---|
| |
|
|
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@authenticatedmatchall | | 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 | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF674_GeographicSitetmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF914-IotService-v4.0.0.swagger.json | Name | IoT Service |
---|
|
|
|
Name | Geographic Site @authenticated | match | allnot-Open API Table - Pre-production (Beta) |
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 |
---|
|
|
|
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 @authenticatedmatch | all |
---|
group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | | Not yet available | Not yet available | Not yet available | Not yet available | 21 |
19()Pre-production | 22-Nov-2021 | Product, Common, Resource, Service | |
Metadata Catalog Management API Metadata Catalog | TMF725 |
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. | TMF683match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF683_PartyInteractionBeta/4.0.0/swagger/TMF725-MetadataCatalog-v4.0.0.swagger.json | Name | Metadata Catalog |
---|
|
|
|
Name | Party Interaction @authenticatedmatchall | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
| 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 | |
Show If |
---|
special | @authenticated |
---|
match | allSpecification PDFprojects.tmforum.org/wiki/download/attachments/134792905/TMF683_Party_Interaction_Management_API_User_Guide_v4.0.0.pdf?api=v2tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF669-PartyRole-v4.1.0.swagger.json | Name | Party Role |
---|
|
|
|
Name | Party Interaction @authenticatedmatchall | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
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 |
| 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 | |
match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubName | Payment Management API |
---|
|
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com |
|
|
|
/tmforum-apis/TMF676_PaymentManagement/Beta/4.0.0/swagger/TMF628-Performance-v4.0.0.swagger.json | Name | Performance Management API |
---|
| |
|
|
Open API Table - Pre-production (Beta) Yet Available Yet Available Yet Available Yet Available Yet Available 19(4)PreproductionPrepay Balance TMF654 |
2021 | Service, Common | |
Process Flow 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.
The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action: | TMF701 | |
match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF654_PrepayBalanceManagementtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF701-ProcessFlow-v4.1.0.swagger.json | Name | Process Flow |
---|
|
|
|
Name | Prepay Balance @authenticated | match | allnot-Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.0.0 (4.0.0) | Pre-production |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF701_Process_Flow_Management_API_Specification_v4.1.0.pdf |
---|
Name | Process Flow Management API |
---|
| |
|
|
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@authenticatedmatchallgrouptmforum-membersSwaggerCTK-Conformance | Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/123090132/TMF644_Privacy-4.0.0.swagger.json?version=1&modificationDate=1573117743866&api=v2tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/conformance/TMF701_Process_Flow_Management_Conformance-v4.1.0.pdf | Name | Process Flow |
---|
|
|
|
Name | Privacy Image Removed |
| 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 |
---|
match | allSpecification PDFSwagger | Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134792881/TMF644_Privacy_Management_API_User_Guide_tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF671-Promotion-v4.0.0. |
|
|
|
pdf?api=v2Privacy @authenticatedmatch | all |
---|
group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21 |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19(4)Pre-production22-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 |
omni-channelmatch | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF680_Recommendationtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF680-Recommendation-v4.0.0.swagger.json | Name | Recommendation Management API |
---|
| |
|
|
@authenticated | match | all |
groupnot-tmforum-members | Open API Table - Pre-production (Beta) |
match | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134777000/tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF680_Recommendation_ |
|
|
|
Management_UserGuidev40?api=v2 | Name | Recommendation Management API |
---|
| |
|
|
@authenticated | match | all |
---|
group | not-tmforum-members |
Open API Table - Pre-production (Beta)@anonymous | 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 | Resource Activation and Configuration API
The Resource Activation and Configuration API can |
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.pdf |
---|
Name | 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 | |
match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF702-ResourceActivationConfigurationtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF702-ResourceActivation-v4.0.0.swagger.json | Name | Resource Activation |
---|
|
|
|
& Configuration @authenticated | matchall | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
match | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134792913/tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF702_Resource_Activation_ |
|
|
|
ManagementUserGuidev40?api=v2 & Configuration @authenticated | match | all |
---|
group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
@anonymousOpen API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | CTK-Conformance | Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF702_Resource_Activation_ |
---|
|
|
|
19.5.0
()Pre-production Catalog TMF634 | Activation 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.
@authenticatedmatchallgrouptmforum-membersSwaggerApache 2.0githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF634_ResourceCatalogBeta/4.0.0/ctk/TMF702-ResourceActivation.zip | Name | Resource |
---|
|
|
|
Catalog Activation Management API |
| |
|
| |
matchallgroup | not-tmforum-members |
Open API Table - Pre-production (Beta)RI | Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ri/TMF702_Resource_activation.zip |
---|
Name | Resource Activation Management API |
---|
| |
|
|
Image Removedmatchallgrouptmforum-members | Trackinglink |
---|
Type | Specification PDFprojects.tmforum.org/wiki/download/attachments/134776967/TMF634_Resource_Catalog_Management_API_User_Guide_v4.0.0.pdf?api=v2tmf-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 Management |
---|
|
|
|
Name | Resource Catalog @authenticatedmatch | all |
---|
group | not-tmforum-members |
---|
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 | Resource Function Activation and Configuration API
| 21.5.0 | v4.0.0 | 22-Nov-2021 | Resource, Common | |
Resource Function Activation and Configuration API This 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 | |
match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF664_ResourceFunctionActivationConfigurationBeta/4.0.0/swagger/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json | Name | Resource Function Activation and Configuration API |
---|
| |
|
|
@authenticated | match | all |
---|
group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
Show If |
---|
|
Open API Table - Pre-production (Beta)match | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134776992tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF664_Resource_Function_Activation_ |
|
|
|
andConfiguration_UserGuide..?api=v2 | Name | Resource Function Activation and Configuration API |
---|
| |
|
|
@authenticated | match19.5.0
(all | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | | Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 |
)Preproduction Inventory , Common | |
Sales Management API The |
intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.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 |
TMF639match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF639_ResourceInventorytmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF699-Sales-v4.1.0.swagger.json | Name | Sales Management |
---|
|
|
|
Name | Resource Inventory @authenticated | match | allnot- Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Open API Table - Pre-production (Beta) |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134792865/TMF639_Resource_Inventorytmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF699_Sales_Management_API_ |
|
|
|
UserGuide0?api=v2Resource Inventory @authenticatedmatch | all |
---|
group | not-tmforum-members |
Open API Table - Pre-production (Beta) | 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 | |
@anonymous | Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | 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/TMF727-ServiceUsage- |
---|
|
|
|
19.5.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. | .swagger.json | Name | 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 |
TMF652match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF652_ResourceOrderManagementtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF711-ShipmentManagement-v4.0.0.swagger.json | Name | Shipment Management |
---|
|
|
|
Name | Resource Order 19.5.0
(@authenticated | match | all |
---|
group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | |
)Pre-production | 10-Jan-2022 | Business Partner | |
Shipping Order |
Risk TMF696 | Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://github.com/tmforum-apis/TMF696_RiskManagement |
---|
Name | Risk Management API |
---|
|
|
Service Activation and Configuration 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. . | TMF640 | Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://github.com/tmforum-apis/TMF640_ActivationConfiguration |
---|
Name | Service Activation & Configuration API |
---|
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/134792872/TMF640_Service_Activation_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
---|
Name | Service Activation & Configuration API |
---|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.0.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 | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://github.com/tmforum-apis/TMF638_ServiceInventory |
---|
Name | Service Inventory Management API |
---|
|
|
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 |
---|
Name | Service Inventory Management API |
---|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 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 |
---|
Link | https://github.com/tmforum-apis/TMF641_ServiceOrder/tree/master |
---|
Name | Service Ordering Management API |
---|
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/134792876/TMF641_Service_Ordering_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
---|
Name | Service Ordering Management API |
---|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 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 |
---|
Link | https://github.com/tmforum-apis/TMF645_ServiceQualification/tree/master |
---|
Name | Service Qualification API |
---|
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/134792885/TMF645_Service_Qualification_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
---|
Name | Service Qualification API |
---|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.0.0 (v4.0.0) | Pre-production | Service Quality Management API Through this API, any Enterprise is able to access a Service Quality Management application and extract Service Level Specifications and associated Service Level Objectives (SLO) and their thresholds. | 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 |
---|
|
|
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.
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 | |
match | all |
Specification PDFSwagger | Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_API_User_Guide_tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF700-ShippingOrder-v4.0.0. |
|
|
|
pdf?api=v2Service Quality Shipping Order Management API |
| |
|
|
@authenticated | match | allnot-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 | 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. |
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/TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0.pdf |
---|
Name | Shipping Order Management API |
---|
| |
|
|
TMF653@authenticatedmatchallgrouptmforum-membersSwaggerApache 2.0//github.com/tmforum-apis/TMF653_ServiceTestManagement//tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF700_Shipping_Order_v4.0.0_conformance.pdf | Name | Shipping Order |
---|
|
|
|
Name | Service Test 20.0.0
(@authenticated | match | all |
---|
group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | | Not yet available | Not yet available | Not yet available | 21.5.0 |
)Pre-production | 22-Nov-2021 | Business Partner | |
SLA |
Usage Management API Provides a 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.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. | TMF623 |
TMF635match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/ |
---|
|
|
|
/github.com/tmforum-apis/TMF635_UsageManagement4.0.0/swagger/TMF623-SLA-v4.0.0.swagger.json | Name |
---|
|
|
|
Usage @authenticated | match20.5.0
(all | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 |
)Pre-production | | 08-06-2022 | Business 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 |
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. | TMF672match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF672_UserRolesPermissionsBeta/4.0.0/swagger/TMF677-UsageConsumption-v4.0.1.swagger.json | Name | Usage Consumption Management |
---|
|
|
|
Name | User Roles & Permissions -ifspecial | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Open API Table - Pre-production (Beta) |
| 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 |
---|
|
Open API Table - Pre-production (Beta)matchall | Trackinglink |
---|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
|
|
|
Type | Specification PDFprojects.tmforum.org/wiki/download/attachments/134792889/TMF672_User_Role_Permission_Management_API_User_Guide_tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF697-WorkOrder-v4.0.0. |
|
|
|
pdf?api=v2swagger.json | Name | Work Order Management API |
---|
| |
|
|
Name | User Roles & Permissions API |
---|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Open API Table - Pre-production (Beta)Open API Table - Pre-production (Beta) Yet Available Yet Available Yet Available Yet Available 19.5.0
(yet available | Not yet available | |
)Pre-production | 22-Nov-2021 | Business Partner | |