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 |
TMF642match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF642_AlarmManagementBeta/4.1.0/swagger/TMF666-Account-v4.1.0.swagger.json | Name |
---|
|
|
|
Alarm @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.5.0 | v4.1.0 | 10-Jan-2022 | Business Partner, Customer | |
Async Trouble Ticket API Async API Enabled for Trouble Ticket, Async API conpect supporting the event-based architecture | TMF925 |
Show If |
---|
|
Image Removedmatch | all |
Specification PDFSwagger | Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
projects.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/TMF925-TroubleTicket-v4.0.0 |
|
|
|
.pdf?api=v2Alarm Management @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 | 22 |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19()Pre-production | | Common | |
Change Management API The Change Management API provides the standard integration capabilities between external applications and Change Management Application | TMF655 |
Communication API Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. | TMF681match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF681_Communicationtmf-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 |
---|
|
|
|
Name | Communication @authenticatedmatchall | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
| 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 |
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-tmforumOpen 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/TMF717-Customer360-v4.0.0.swagger.json |
---|
Name | Customer360 Management API |
---|
| |
|
|
Open API Table - Pre-production (Beta) Yet Available Yet Available Yet Available yet available | Not yet available | Not |
Yet Available 19()Preproduction Bill Management APIThis 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.
| |
DCS 5GSlice Service Activation API Domain Context Specialization of TMF640 for 5G Service Slice, Swagger of Contract is strongly bound to the GSMA Service Definition | TMF924 |
TMF678match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF678_CustomerBilltmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF924-dcs-5gslice-sa-swagger.json | Name | DCS 5GSlice Service Activation |
---|
|
|
|
Name | Customer Bill Management @authenticatedmatchall | group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
Show If |
---|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v4.0.0 | | Service | |
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. |
---|
| |
|
| 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 | |
Dunning Case Management No description available yet | TMF728 |
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/TMF728-DunningCase-v4.0.0.swagger.json |
---|
Name | Dunning Case Management |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v4.0.0 | | 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 |
---|
| |
|
| 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 |
---|
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 |
---|
|
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 | v4.0.0 | 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-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 ID 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/TMF691_Federated_Identity_API_user_guides_21.5.0.pdf |
---|
Name | Federated ID Management API |
---|
| |
|
| 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 |
---|
| |
|
| 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 | |
Geographic Site Management API Covers the operations to manage (create, read, delete) sites that can be associated with a customer, account, service delivery or other entities. This API defines a Site as a convenience class that allows easy reference to places important to other entities, where a geographic place is an entity that can answer the question “where?” | TMF674 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF674-GeographicSite-v5.0.0.oas.yaml |
---|
Name | Geographic Site 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/5.0.0/user_guides/TMF674-GeographicSite-v5.0.0.pdf |
---|
Name | Geographic Site Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | 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 |
---|
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/TMF921-Intent-v4.0.2.swagger.json |
---|
Name | Intent |
---|
| |
|
|
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/TMF921_Intent_Management_API_REST_Specification_v4-0-0v3.pdf |
---|
Name | Intent |
---|
| |
|
| 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 |
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/TMF908-IoTAgentAndDevice-v4.0.0.swagger.json |
---|
Name | IoT Agent and Device 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/TMF908_IoT_Device_Management_API_Component_Suite_user_guides_21.5.0.pdf |
---|
Name | IoT Agent and Device Management API |
---|
| |
|
| 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://tmf-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 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 |
---|
| |
|
| 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 |
---|
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 Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | | v4.0.0 | 10-Jan-2022 | Common | |
Network as a Service Management API The API Component Suite supports of a set of Operational Domains exposing and managing “Network” Services. These services are referred to as Network as a Service (NaaS) and include all services offered from a service provider including connectivity, end points, media services, etc. | TMF909 |
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/TMF909-NetworkasaService-v4.2.0.swagger.json |
---|
Name | Network as a Service 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/TMF909_Network_as_a_Service_Management_API_REST_Specification_v4-2-0.pdf |
---|
Name | Network as a Service Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 18.5.1 | v4.2.0 | | Common, Product, Service | |
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 |
---|
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/TMF669-PartyRole-v4.1.0.swagger.json |
---|
Name | Party Role 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.1.0/user_guides/TMF669_Party_Role_Management_API_REST_Specification_v4.1.0.pdf |
---|
Name | Party Role 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.1.0/conformance/TMF669_Party_Role_v4.1.0_conformance.pdf |
---|
Name | Party Role Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | 22.0.0 | v4.1.0 | 08-06-2022 | Business Partner | |
Payment Method Management 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.1.0/swagger/TMF670-PaymentMethod-v4.1.0.swagger.json |
---|
Name | Payment Method Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.1.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/TMF628-Performance-v4.0.0.swagger.json |
---|
Name | Performance 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 | 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 | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-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 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.1.0/user_guides/TMF701_Process_Flow_Management_API_Specification_v4.1.0.pdf |
---|
Name | Process Flow 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.1.0/conformance/TMF701_Process_Flow_Management_Conformance-v4.1.0.pdf |
---|
Name | Process Flow Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | 19.0.1 | v4.1.0 | 22-Nov-2021 | Common | |
Product Catalog Management API Provides a standardized solution for rapidly adding partners’ products to an existing Catalog. It brings the capability for Service Providers to directly feed partners systems with the technical description of the products they propose to them. | TMF620 |
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/5.0.0/swagger/TMF620-Product_Catalog_Management-v5.0.0.oas.yaml |
---|
Name | Product Catalog Management API |
---|
| |
|
| |
special | @authenticated |
---|
match | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134792897/TMF678_Customer_Bill_Management_API_User_Guide_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF620-Product_Catalog_Management-v5.0.0.pdf |
|
|
|
?api=v2 | Name | Product Catalog Management API |
---|
| |
|
|
Name | Customer Bill Management 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(v4)Pre-production | Event | Product | |
Product Inventory 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.
Provides standardized mechanism for product inventory management such as creation, partial or full update and retrieval of the representation of a product in the inventory. It also allows the notification of events related to product lifecycle. | TMF637 |
TMF688match | allApache 2.0 | Link | https://github.com/tmforum-apis/TMF688-Event |
---|
| Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF637-ProductInventory-v5.0.0.oas.yaml |
---|
Name | Product Inventory Management |
---|
|
|
|
Name | Event management @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 | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production | Federated Identity API The management of principals of any kind (persons, objects, …) and their access to resources in an open environment which can span across different enterprise boundaries. It relies on authentication, authorization and consent mechanisms to protect privacy with a simple and easy user experience. Different parties can provide identity services (operators, social networks, GSMA, …). | TMF691 | |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF637-ProductInventory-v5.0.0.pdf |
---|
Name | Product Inventory Management API |
---|
| |
|
|
Not Yet Available @authenticatedmatchall | group | tmforum-members |
---|
Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/134792909/TMF691_Federated_ID_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
---|
Name | Federated Identity API |
---|
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | Product | |
Product Offering Qualification Management API Product Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility. | TMF679 |
matchall | not-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. | TMF673 |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF679-ProductOfferingQualification-v5.0.0.oas.yaml |
---|
Name | Product Offering Qualification Management API |
---|
| |
|
|
Not Yet Available @authenticated | match | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134792893/TMF673_Geographic_Address_Management_API_User_Guide_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF679-ProductOfferingQualification-v5.0.0.pdf |
|
|
|
?api=v2Geographic Address Product Offering Qualification Management API |
| |
|
|
@authenticated | match | all |
groupnot-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.5.0 | v5 |
20.0.0
(v4)Pre-production | Geographic Location | Product | |
Product Ordering Management API Provides |
the information of a geographic region of the entity (customer, equipment, address).a standardized mechanism for placing a product order with all the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order negotiation systems in a consistent manner. A product order is created based on a product offering that is defined in a catalog. The product offering identifies the product or set of products that are available to a customer and includes characteristics such as pricing, product options and market. | TMF622 |
TMF675matchall | |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF675_GeographicLocationName | Geographic Location Management API |
---|
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF622-ProductOrdering-v5.0.0.oas.yaml | Name | Product Ordering Management API |
---|
| |
|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production | Geographic Site Management API Covers the operations to manage (create, read, delete) sites that can be associated with a customer, account, service delivery or other entities. This API defines a Site as a convenience class that allows easy reference to places important to other entities, where a geographic place is an entity that can answer the question “where?” | TMF674@authenticated | match | allSwaggerApache 2.0github |
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com |
|
|
|
/tmforum-apis/TMF674_GeographicSiteName | Geographic Site Management API |
---|
/Beta/5.0.0/user_guides/TMF622-ProductOrdering-v5.0.0.pdf | Name | Product Ordering Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | Customer, Product | |
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 | |
match | allSpecification PDFprojects.tmforum.org/wiki/download/attachments/134776996/TMF674_Geographic_Site_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=v2Geographic Site @authenticated | match | all |
---|
group | not-tmforum-members |
---|
| 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 | |
Quote Management API The Quote API is one of the Pre-Ordering Management APIs. The customer Quote API provides a standardized mechanism for placing a customer quote with all the necessary quote parameters. | TMF648 |
Open API Table - Pre-production (Beta)@anonymousOpen 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 | |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF648-Quote-v5.0.0.oas.yaml |
---|
Name | Quote Management API |
---|
| |
|
|
Party Interaction Management API A User Interaction captures information about past interactions in order to re-use it in future ones. This allows agents to serve users better by knowing the steps they went through. It also allows customers to see better the actions they have performed and how they interacted with us. | TMF683@authenticated | match | allSwagger | Licence | Apache 2.0 |
---|
Link | https://github.com/tmforum-apis/TMF683_PartyInteraction |
---|
Specification PDF | Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF648-Quote-v5.0.0.pdf |
---|
Name | Quote |
---|
|
|
|
Name | Party Interaction @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 | 22.5.0 | v5.0.0 | | Customer | |
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 | |
match | all |
Specification PDFprojects.tmforum.org/wiki/download/attachments/134792905/TMF683_Party_Interaction_Management_API_User_Guide_tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF680-Recommendation-v4.0.0 |
|
|
|
.pdf?api=v2Party Interaction Recommendation Management API |
| |
|
|
@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/TMF680_Recommendation_API_user_guides_21.5.0.pdf |
---|
Name | Recommendation Management API |
---|
|
|
|
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@authenticatedmatchallgrouptmforum-membersSwaggerApache 2.0githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com |
|
|
|
/tmforum-apis/TMF676_PaymentManagement/Beta/4.0.0/conformance/TMF680_Recommendation_API_conformance_21.5.0.pdf | Name |
---|
|
|
|
Payment Recommendation Management API |
| |
|
|
@authenticated | match | all |
---|
group | not-tmforum-members |
---|
| Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Customer | |
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 |
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 | Not Yet Available | 19.5.0 (4.0.0) | Pre-production | Prepay Balance Management API REST API for Balance Management. It includes the model definition as well as all available operations for prepay balance management. Prepaid subscribers pay fees before using services. Therefore, the subscribers must have sufficient balances. Operators can provide multiple recharge channels for subscribers. Subscribers can pass credit between different subscriptions, therefore transferring the balance from one account to another. | |
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/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json |
---|
Name | Resource Function Activation and Configuration API |
---|
|
|
|
TMF654@authenticated | match | allSwaggerApache 2.0github.com/tmforum-apis/TMF654_PrepayBalanceManagementName | Prepay Balance Management tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF664_Resource_Function_Activation_Management_API_REST_Specification_v4-0-0.pdf | Name | Resource Function Activation and Configuration API |
---|
| |
|
|
@authenticated | match | all |
groupnot-tmforum-members | Open API Table - Pre-production (Beta) |
| Not yet available | Not yet available | Not yet available | Not yet available | 22 |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20(4)Pre-production | Privacy 08-06-2022 | Resource, Common | |
Sales Management API The |
Privacy management Sales 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.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 |
TMF644matchall | RANDprojects.tmforum.org/wiki/download/attachments/123090132/TMF644_Privacy-4.0tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF699-Sales-v4.1.0.swagger.json |
|
|
|
?version=1&modificationDate=1573117743866&api=v2Privacy Management API | |
Show If |
---|
|
Image Removed |
Show If |
---|
|
Open API Table - Pre-production (Beta)@authenticated | match | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134792881/TMF644_Privacytmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF699_Sales_Management_API_ |
|
|
|
UserGuide0?api=v2Name | Privacy Management 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 195(40)Pre-production | Recommendation API Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel. | 08-06-2022 | MarketingSales | |
Service Activation Management API The REST API for Activation and Configuration allows the user to retrieve, create, update, delete services and retrieve the monitor resource used to monitor the execution of asynchronous requests on a specific resource. Although all the examples given in the API specification are relative to Services, the same API can be used to Activate and Configure Services or Resources. | TMF640 |
TMF680match | allLicence | Apache 2.0 |
---|
Link | https://github.com/tmforum-apis/TMF680_Recommendation |
---|
| Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF640-Service_Activation_and_Configuration-v5.0.0.oas.yaml |
---|
Name | Service Activation Management |
---|
|
|
|
Name | Recommendation @authenticatedmatch | all |
---|
group | not-tmforum-members |
---|
Open API Table - Pre-production (Beta) |
@authenticated | matchall@authenticated | group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134777000/TMF680_Recommendation_Management_API_User_Guide_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF640-Service_Activation_and_Configuration-v5.0.0.pdf |
|
|
|
?api=v2Recommendation Service Activation Management 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(v4)Pre-production | | | Common, Service | |
Service Catalog Management API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | TMF633 |
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.
| TMF702match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF702-ResourceActivationConfigurationName | Resource Activation & Configuration tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF633-Service_Catalog_Management-v5.0.0.oas.yaml | Name | Service Catalog Management API |
---|
| |
|
|
@authenticated | match | all |
---|
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/TMF702_Resource_Activation_Management_API_User_Guide_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF633-Service_Catalog_Management-v5.0.0.pdf |
|
|
|
?api=v2 | Name | Service Catalog Management API |
---|
| |
|
|
Name | Resource Activation & Configuration 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(v4)Pre-production | Resource Catalog | Service | |
Service Inventory 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.intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory. | TMF638 |
TMF634matchall | |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com |
|
|
|
/tmforum-apis/TMF634_ResourceCatalogName | Resource Catalog API |
---|
/Beta/5.0.0/swagger/TMF638-Service_Inventory_Management-v5.0.0.oas.yaml | Name | Service Inventory Management API |
---|
| |
|
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Open API Table - Pre-production (Beta)Image Removedmatch | all |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134776967/TMF634_Resource_Catalog_Management_API_User_Guide_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF638-Service_Inventory_Management-v5.0.0.pdf |
|
|
|
?api=v2Resource Catalog API | |
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Service Inventory Management API |
| |
|
|
Open API Table - Pre-production (Beta)Open API Table - Pre-production (Beta) Yet Available Yet Available Yet Available Yet Available 19(v4)Pre-production | Resource Function Activation and Configuration API This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function | | Service | |
Service Ordering Management API The REST API for Service Order Management provides a standardized mechanism for placing a service order with all the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications. | TMF641 |
TMF664match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com |
|
|
|
/tmforum-apis/TMF664_ResourceFunctionActivationConfigurationName | Resource Function Activation and Configuration /Beta/5.0.0/swagger/TMF641-ServiceOrdering-v5.0.0.oas.yaml | Name | Service Ordering Management API |
---|
| |
|
|
@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/5.0.0/user_guides/TMF641-ServiceOrdering-v5.0.0.pdf |
---|
Name | Service Ordering Management API |
---|
| |
|
|
Show If |
---|
|
Open API Table - Pre-production (Beta)@authenticatedmatch | all |
---|
group | tmforum-members |
---|
Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/134776992/TMF664_Resource_Function_Activation_and_Configuration_API_User_Guide_v4.0.0.pdf?api=v2 |
---|
Name | Resource Function Activation and Configuration API |
---|
|
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | Service | |
Service Test Management API The Service Test API provides a standardized mechanism for placing a service test with all the necessary test parameters. The API consists of a simple set of operations that interact with CRM/Service Management systems in a consistent manner. A service test is a procedure intended to check the quality, performance, or reliability of a service. | TMF653 | |
match | allnot--membersOpen 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/5.0.0/swagger/TMF653-Service_Test_Management-v5.0.0.oas.yaml |
---|
Name | Service Test Management API |
---|
| |
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production | Resource Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory. | TMF639@authenticated | match | allSwaggerApache 2.0githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF639_ResourceInventoryName | Resource Inventory API |
---|
Beta/5.0.0/user_guides/TMF653-Service_Test_Management-v5.0.0.pdf | Name | Service Test Management API |
---|
| |
|
|
|
Show If |
---|
|
Image Removed@authenticatedmatchall | group | tmforum-members |
---|
Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/134792865/TMF639_Resource_Inventory_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
---|
Name | Resource Inventory API |
---|
|
| Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v5.0.0 | 10-Dec-2021 | Service | |
Service Usage Management API No description available yet | TMF727 |
matchall | not-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/TMF727-ServiceUsage- |
---|
|
|
|
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 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 |
---|
| |
|
|
TMF652match | all |
SwaggerApache 2.0github.com/tmforum-apis/TMF652_ResourceOrderManagementName | Resource Order Management API |
---|
|
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF727_Service_Usage_Management_API_REST_Specification_v4-0-0.pdf | Name | Service Usage Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Open API Table - Pre-production (Beta)Image Removed Yet Available Yet Available Yet Available Yet Available Not Yet Available | 19.5()PreproductionService 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. . | 2022 | | |
Shipment Management Management API Shipment Management | TMF711 |
TMF640@authenticated | matchall@authenticated | group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF640_ActivationConfigurationName | Service Activation & Configuration tmf-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 Management API |
---|
| |
|
|
@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 | | 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 |
---|
|
Image Removed@authenticated | matchall@authenticated | group | tmforum-members |
---|
|
|
|
Specification PDFprojects.tmforum.org/wiki/download/attachments/134792872/TMF640_Service_Activation_Management_API_User_Guide_v4.0.0.pdf?api=v2tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF700-ShippingOrder-v4.0.0.swagger.json | Name | Shipping Order Management API |
---|
| |
|
|
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@authenticated | match | allSwaggerApache 2.0github.com/tmforum-apis/TMF638_ServiceInventoryName | Service Inventory Management API |
---|
|
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 |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Open API Table - Pre-production (Beta)Image Removedmatchalltmforumgroup | members Trackinglink |
---|
Type | Specification PDFprojects.tmforum.org/wiki/download/attachments/134792858/TMF638_Service_Inventory_Management_API_User_Guide_tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF700_Shipping_Order_v4.0.0_conformance.pdf |
|
|
|
?api=v2 | Name | Shipping Order Management API |
---|
| |
|
|
Name | Service Inventory Management 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 Not Yet Available | 20.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. | 22-Nov-2021 | Business Partner | |
SLA Management API Provides 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. | TMF623 |
TMF641match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
/github.com/tmforum-apis/TMF641_ServiceOrder/tree/masterName | Service Ordering tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF623-SLA-v4.0.0.swagger.json | Name | SLA Management API |
---|
| |
|
|
@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 | 22.0.0 | v4.0.0 | 08-06-2022 | Business Partner | |
Stock Management No description available yet | TMF687 |
Show If |
---|
|
Image Removedmatch | allSpecification PDFprojects.tmforum.org/wiki/download/attachments/134792876/TMF641_Service_Ordering_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/TMF687-Stock-v4.1.0.swagger.json | Name | Stock Management |
---|
|
|
|
Name | Service Ordering Management API@authenticated | match | all |
---|
group | not-tmforum-members |
---|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.5.2 | v4.1.0 | 16-11-2022 | Common | |
Trouble Ticket Management API Provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets among partners as a result of an issue or problem identified by a customer or another system. Examples of Trouble Ticket API clients include CRM applications, network management or fault management systems, or other trouble ticket management systems (e.g. B2B). | TMF621 |
Open API Table - Pre-production (Beta)@anonymousOpen 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 | 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 | |
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/TMF621-TroubleTicket-v4.1.0.swagger.json |
---|
Name | Trouble Ticket Management API |
---|
| |
|
|
Not Yet Available @authenticated | match | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134792885/TMF645_Service_Qualification_Management_API_User_Guide_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF621-Trouble_Ticket-v5.0.0.pdf |
|
|
|
?api=v2Service Qualification Trouble Ticket Management API |
| |
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
groupnot-tmforum-members | Open API Table - Pre-production (Beta) |
Open API Table - Pre-production (Beta) Yet Available Yet Available Yet Available Yet Available 200(0)Pre-production | Service Quality | Common | |
Usage Consumption 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.
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 |
TMF657 | match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link |
---|
|
|
|
https://github.com/tmforum-apis/TMF657_ServiceQualityManagement | Name | Service Quality 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 |
---|
| |
|
|
@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 | |
Warranty Management No description available yet | TMF715 |
Show If |
---|
|
Open API Table - Pre-production (Beta)matchall | Specification PDFprojects.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/TMF715-WarrantyManagement-v4.0.0. |
|
|
|
pdf?api=v2swagger.json | Name | Warranty Management |
---|
| |
|
|
Name | Service Quality Management API |
---|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Open API Table - Pre-production (Beta)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. | | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v4.0.0 | | Common | |
Work Management No description available yet | TMF713 |
TMF653match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF653_ServiceTestManagementName | Service Test Management APItmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF713-WorkManagement-v4.0.0.swagger.json | Name | Work Management |
---|
| |
|
|
@authenticated | match | all |
group20.0.0
(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.5.0 |
)Pre-production | | Common | |
Work Order Management API The Work Order API performs the following operations on a workOrder resource: | TMF697 |
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 | allSwagger | Licence | Apache 2.0 |
---|
Link | https://github.com/tmforum-apis/TMF672_UserRolesPermissions |
---|
| 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 |
---|
|
|
|
Name | User Roles & Permissions @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 | | v4.0.0 | 22-Nov-2021 | Business Partner | |
Work Qualification Management No description available yet | TMF714 |
Show If |
---|
|
Open API Table - Pre-production (Beta)matchall | Specification PDFSwagger | Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
projects.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/TMF714-WorkQualification-v4.0.0. |
|
|
|
pdf?api=v2User Roles & Permissions APIWork Qualification Management |
| |
|
|
@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 | 22 |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19()Pre-production