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. | TMF642| 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 | |
| match | all |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https:// |
|---|
|
|
|
github| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF642_AlarmManagement| Beta/4.1.0/swagger/TMF666-Account-v4.1.0.swagger.json | | Name |
|---|
|
|
|
Alarm @authenticatedmatchall | | group | not-tmforum-members |
|---|
 Image Removed
|
| Show If |
|---|
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.1.0 | 10-Jan-2022 | Business Partner, Customer | |
Change Management API The Change Management API provides the standard integration capabilities between external applications and Change Management Application | TMF655 |
Image Removedmatchall | Specification PDF| Swagger | | 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/TMF655-Change-v4.0.0 |
|
|
|
.pdf?api=v2Alarm @authenticated Image Removed
|
| Show If |
|---|
special | | match | all |
|---|
| group | not-tmforum-members |
|---|
Image Removed Yet Available Yet Available Yet Available | Show If |
|---|
| 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 | |
| special | @authenticated |
|---|
match | allPostmanRANDprojects.tmforum.org/wiki/download/attachments/143534323/TMF642-Alarm-v4-Postman.zip?api=v2| 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 |
|---|
|
|
|
Name | Alarm @authenticatedmatch Image Removed
|
19.5.0
(all | | group | not-tmforum-members |
|---|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 |
)| Trackinglink |
|---|
Pre-production | Communication API Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. | TMF681 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| 05-Jan-2022 | Customer | |
Digital Identity Management API. Provides the ability to manage a digital identity. This digital identity allows identification of an individual, a resource, or a partyRole (a specific role - or set of roles - for a given individual). A digital identity is associated with credential / authentification method. These credential / authentification methods should be extensible to describe all types of authentification method such as login/password, biometric, token, etc. A contact medium is also associated with digital identity (or directly at credential level) to manage credential recovery UCs. | TMF720 |
| Show If |
|---|
| special | @authenticated |
|---|
| group | tmforum-members |
|---|
|
|
|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https:// |
|---|
|
|
|
github.com/tmforum-apis/TMF681_Communication| 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. |
|---|
|
|
|
Name | Communication API@authenticatedmatchall | | 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 | 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 |
Image Removed |
| Show If |
|---|
|
Image Removedmatchall | Specification PDF| Swagger | | Licence | Apache 2.0 |
|---|
| Link | https:// |
|---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134792901/TMF681_Communication_Management_API_User_Guide_| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF703-EntityInventory-v4.0.0. |
|
|
|
pdf?api=v2Communication | Entity Inventory Management API |
| |
|
|
@authenticated| match | all |
|---|
| group | not-tmforum-members |
|---|
Image Removed |
| 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 | 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_EntityCatalog| 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 |
|---|
|
|
|
Name | Entity Catalog @authenticated | match | allnot-Image RemovedNot Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 (v4.0.0) | Pre-production | Entity Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory. The Entity Inventory API can be used to query the Entity and Association instances. The Entity Inventory API can be called by an order management system to create new Entity/Association instances or update existing Entity/Association instances in the Entity Inventory. | | 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 |
|---|
| |
|
|
TMF703| match | all |
|---|
grouptmforum-members | SwaggerApache 2.0github.com/tmforum-apis/TMF703_EntityInventory| 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 |
|---|
|
|
|
Name | Entity Inventory @authenticated | matchImage Removed |
| Show If |
|---|
special | all | | group | not-tmforum-members |
|---|
Image Removed Yet Available Yet Available Yet Available Not Yet Available | Not Yet Available | 20()Pre-production | | 22-Nov-2021 | Common | |
Federated ID |
Event 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.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 |
TMF688| match | all |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https:// |
|---|
|
|
|
github| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF688-Event| Beta/4.0.0/swagger/TMF691-FederatedIdentity-v4.0.0.swagger.json | | Name | Federated ID Management |
|---|
|
|
|
Name | Event management @authenticated | match | allnot-Image RemovedNot Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production | Federated Identity API The management of principals of any kind (persons, objects, …) and their access to resources in an open environment which can span across different enterprise boundaries. It relies on authentication, authorization and consent mechanisms to protect privacy with a simple and easy user experience. Different parties can provide identity services (operators, social networks, GSMA, …). | TMF691 | | Show If |
|---|
| 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 | |
| special | @authenticated |
|---|
match | all |
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https:// |
|---|
|
|
|
github.com/tmforum-apis/TMF691_FederatedIdentity| 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 |
|---|
|
|
|
Name | Federated Identity @authenticatedmatchall | | 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 | 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 |
Image Removed |
| Show If |
|---|
|
Image Removed| match | all |
|---|
Specification PDF| Swagger | | Licence | Apache 2.0 |
|---|
| Link | https:// |
|---|
|
|
|
projects.tmforum.org/wiki/download/attachments/134792909/TMF691_Federated_ID_Management_API_User_Guide_| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF921-Intent-v4.0.0 |
|
|
|
.pdf?api=v2Federated Identity API@authenticatedmatchall | | group | not-tmforum-members |
|---|
Image Removed |
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()PreproductionGeneral Test Artifact Management API | TMF710 | Not Yet Available | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146293816/TMF710_General_Test_Artifact_Management_API_User_Guide_v4.0.pdf?api=v2 |
|---|
| Name | General Test Artifact Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.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 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF673_GeographicAddress |
|---|
| Name | Geographic Address Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792893/TMF673_Geographic_Address_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Geographic Address Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146293800/TMF673B_Geographic_Address_API%20Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Geographic Address Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
 Image Removed
|
Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 (v4.0.0) | Pre-production | Geographic Location Management API Provides the information of a geographic region of the entity (customer, equipment, address). | TMF675 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF675_GeographicLocation |
|---|
| Name | Geographic Location Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production | IoT Device Management API Component Suite In addition to including established TM Forum Open APIs, such as alarm management, resource management and activation APIs, the IoT Device Management API Component Suite also includes an IoT Data Access Endpoint API. This API allows for IoT data access using different types of protocols (MQTT IoT, CoAP, etc.). It encapsulates the protocols and allows devices to be easily integrated into solutions that support a host of IoT initiatives, including smart cities, smart factories and other vertical markets. | TMF908 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF908_IoTAgentAndDeviceComponentSuite |
|---|
| Name | Iot Agent and Device API Suite |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| 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 | |
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/123085401/TMF908_IoT_Agent_and_Device_Component_Suite_REST_Specification_v1.0.1.pdf?version=1&modificationDate=1592864314038&api=v2 |
|---|
| Name | Iot Agent and Device API Suite |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.0.0 (v4.0.0) | Pre-production | IoT Service Management API Component Suite The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale. | TMF914 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF914_IoTServiceComponentSuite |
|---|
| Name | IoT Service Management API Suite |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143531023/TMF914_IOT_Service_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | IoT Service Management API Suite |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 (v4.0.0) | 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 |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF628_Performance |
|---|
| Name | Performance Management API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 (v4.0.0) | Pre-producion | Recommendation API Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel. | TMF680 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF680_Recommendation |
|---|
| Name | Recommendation API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134777000/TMF680_Recommendation_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Recommendation API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146293804/TMF680B_Recommendation_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Recommendation API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 (v4.0.0) | Pre-production | Resource Activation and Configuration API The Resource Activation and Configuration API can be used to query resource instances to acquire the resource activation states and attributes, and it can be used to create/update, configure and activate the resource instances.
| TMF702 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF702-ResourceActivationConfiguration |
|---|
| Name | Resource Activation & Configuration API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792913/TMF702_Resource_Activation_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Activation & Configuration API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production | Resource Catalog Management API The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering process. | TMF634 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF634_ResourceCatalog |
|---|
| Name | Resource Catalog API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134776967/TMF634_Resource_Catalog_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Catalog API |
|---|
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | | Show If |
|---|
| special | @authenticated |
|---|
match | allPostmanRANDprojects.tmforum.org/wiki/download/attachments/143534323/TMF634-ResourceCatalog-v4-Postman.zip?api=v2| Name | Resource Catalog API |
|---|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
19.5.0
(| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0.0 |
|
|
|
)Pre-production | Resource Function Activation and Configuration API This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function | | .swagger.json | | Name | IoT Agent and Device Management API |
|---|
| |
|
|
TMF664match | allSwaggerApache 2.0github| Name | Resource Function Activation and Configuration API |
|---|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com |
|
|
|
/tmforum-apis/TMF664_ResourceFunctionActivationConfiguration| /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 |
|---|
| |
|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
Link | https://projects.tmforum.org/wiki/download/attachments/134776992/TMF664_Resource_Function_Activation_and_Configuration_API_User_Guide_ | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 |
.pdf?api=v2 | 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 |
| Name | Resource Function Activation and Configuration API |
|---|
| match | all |
|---|
not-Image RemovedNot Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | | 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- |
|---|
|
|
|
19.5.0
()Pre-production | | .swagger.json | | Name | IoT Service Management API |
|---|
| |
|
|
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.0| Name | Resource Inventory API |
|---|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
github.com/tmforum-apis/TMF639_ResourceInventory| 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 |
|---|
| |
|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
Link | https://projects.tmforum.org/wiki/download/attachments/134792865/TMF639_Resource_Inventory_Management_API_User_Guide_ | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 |
.pdf?api=v2 | 22-Nov-2021 | Product, Common, Resource, Service | |
Metadata Catalog Management API Metadata Catalog | TMF725 |
| Name | Resource Inventory API |
|---|
match | allnot-Image Removedshow-ifspecial@anonymous | Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
Link | https://projects.tmforum.org/wiki/download/attachments/143532386/TMF639B_Resource_Inventory_API_Conformance_Profile_| 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. |
|---|
|
|
|
pdf?api=v2Resource Inventory | Metadata Catalog Management API |
| |
|
|
@authenticatedImage Removed |
| Show If |
|---|
special | | match | all |
|---|
| group | not-tmforum-members |
|---|
Image Removed |
| 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 | |
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 |
| Trackinglink |
|---|
| Type | CTK |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532500/TMF639_Resource_Inventory_V4-0-0.zip?api=v2 |
|---|
| Name | Resource Inventory API |
|---|
|
match | allnot-
Image Removedshow-ifspecial@anonymous | Image Removed |
Not Yet Available | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| 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 |
|---|
|
|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143534323/TMF639-ResourceInventory-v4-Postman.zip?api=v2 |
|---|
Name | Resource Inventory @authenticatedmatchall | | group | not-tmforum-members |
|---|
Image Removed |
19.5.0 (v4.0.0) | Pre-production | | 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 |
Resource Ordering Management API The REST API for Resource Order Management. It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Resource Orders (including filtering). A Resource Order API provides a standard mechanism for placing a Resource Order with all necessary order parameters. | TMF652| match | all |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https:// |
|---|
|
|
|
github.com/tmforum-apis/TMF652_ResourceOrderManagement| 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 |
|---|
| |
|
|
| Name | Resource Order Management API |
|---|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| Show If |
|---|
|
Image Removed@authenticatedmatchall | | group | tmforum-members |
|---|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143532439/TMF652_Resource_Order_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Order 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 |
| match | all |
|---|
not-Image Removedshow-ifspecial@anonymous | Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Pre-production | Risk Management API The Risk Management API allows the retrieval of Risk Assessments during interaction with PartyRoles (individualsor organizations) typically engaged in an Order process from ProviderPartyRole. The Risk Assessment request is usually issued by the ProviderPartyRole (e.g. Service Provider). The resources used to retrieve these assessment are Task resources, as per the Open API guidelines for tasks. | | 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 |
|---|
| |
|
|
TMF696@authenticated | match | allSwaggerApache 2.0github| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com |
|
|
|
/tmforum-apis/TMF696_RiskManagement| /Beta/4.1.0/user_guides/TMF701_Process_Flow_Management_API_Specification_v4.1.0.pdf | | Name | Process Flow |
|---|
|
|
|
Name | Risk @authenticated | | match | all |
|---|
groupService Catalog API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | TMF633 | not-tmforum-members | Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 | Pre-production | | match | all |
|---|
grouptmforum-members | SwaggerApache 2.0github.com/tmforum-apis/TMF633_ServiceCatalog| 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 |
|---|
|
|
|
Name | Service Catalog @authenticatedImage Removed |
| Show If |
|---|
special | | match | all |
|---|
| group | not-tmforum-members |
|---|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.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. | | 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 |
TMF645| match | all |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2 |
|---|
|
|
|
.0| Link | https://github.com/tmforum-apis/TMF645_ServiceQualification/tree/master |
|---|
| .0 | | Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF671-Promotion-v4.0.0.swagger.json |
|---|
| Name | Promotion Management |
|---|
|
|
|
Name | Service Qualification @authenticated | | match | all |
|---|
| group | not-tmforum-members |
|---|
Image Removed |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Product | |
Recommendation Management API Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omnichannel. | TMF680 | |
match | allSpecification PDFprojects.tmforum.org/wiki/download/attachments/134792885/TMF645_Service_Qualification_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=v2Service Qualification Image Removed |
| Show If |
|---|
special | | Recommendation Management API |
| |
|
|
@authenticated | | match | all |
|---|
| group | not-tmforum-members |
|---|
Image Removed| match | all |
|---|
CTK-Conformance | | Link | https://projects.tmforum.org/wiki/download/attachments/143532433/TMF645B_Service_Qualification_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| 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 |
|---|
|
|
|
Name | Service Qualification @authenticated | match | all| group | not-tmforum-members |
|---|
Image Removed |
Not Yet Available | Not Yet Available | match | all |
|---|
group | tmforum-membersPostman| CTK-Conformance | | Licence | RAND |
|---|
| Link | https:// |
|---|
|
|
|
projects.tmforum.org/wiki/download/attachments/143534323/TMF645-ServiceQualification-v4-Postman.zip?api=v2| 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 |
|---|
| |
|
|
| Name | Service Qualification API |
|---|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image RemovedImage Removed |
20.0 | Not yet available | Not yet available | Not yet available | 21.5.0 |
()Pre-production | | 22-Nov-2021 | Customer | |
Resource Activation |
Service Quality 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.
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 |
TMF657 | match | all |
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https:// |
|---|
|
|
|
github.com/tmforum-apis/TMF657_ServiceQualityManagement| Name | Service Quality Management API |
|---|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
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/TMF702-ResourceActivation-v4.0.0 |
|
|
|
.pdf?api=v2Service Quality | Resource Activation Management API |
| |
|
|
@authenticated | matchImage Removed |
| Show If |
|---|
special | all | | group | not-tmforum-members |
|---|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available match | allPostman| Specification PDF | | Licence | RAND |
|---|
| Link | https:// |
|---|
|
|
|
projects.tmforum.org/wiki/download/attachments/143534323/TMF657-ServiceQualityManagement-v4-Postman.zip?api=v2| Name | Service Quality Management API |
|---|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
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. | | tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF702_Resource_Activation_and_Configuration_API_user_guides_21.5.0.pdf | | Name | Resource Activation Management API |
|---|
| |
|
|
TMF653@authenticatedmatchallgrouptmforum-membersSwaggerApache 2.0github.com/tmforum-apis/TMF653_ServiceTestManagement| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF702_Resource_Activation_v4.0.0_conformance.pdf | | Name | Resource Activation Management API |
|---|
| |
|
|
| Name | Service Test Management API |
|---|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image RemovedImage Removedmatchallgrouptmforum-memberstrackinglink| Type | Specification PDF |
|---|
projects.tmforum.org/wiki/download/attachments/146293787/TMF653_Service_Test_Management_API_User_Guide_v4| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0 |
|
|
|
.pdf?api=v2| /ctk/TMF702-ResourceActivation.zip | | Name |
|---|
|
|
|
Service Test | Resource Activation Management API |
| |
|
| |
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | 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 RemovedImage Removedmatchallgrouptmforum-members | | Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
projects.tmforum.org/wiki/download/attachments/146293791/TMF653B_Service_Test_API_Conformance_Profile_v4.0.0.pdf?api=v2| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/postman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zip | | Name | Resource Activation Management API |
|---|
| |
|
| 21.5.0 | v4.0.0 | 22-Nov-2021 | Resource, Common | |
Resource Function Activation and Configuration API This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function | TMF664 |
| Name | Service Test Management API |
|---|
match | allnot-Image Removedshow-ifspecial@anonymous | Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | | Licence | Apache 2.0 |
|---|
| Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF664-ResourceFunctionActivation- |
|---|
|
|
|
20.5.0
()Pre-production | | .swagger.json | | Name | Resource Function Activation and Configuration API |
|---|
| |
|
|
Stock Management API The Stock Management API provides standardized mechanism for product stock management such as creation, update and retrieval of the representation of a product stock, reserve product stock, check or query product stock or adjust product stock. It also allows the notification of events related to them. | TMF687match | allSwaggerApache 2.0github.com/tmforum-apis/TMF687_StockManagement| 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 |
|---|
|
|
|
Name | Stock Management 20.5.0
(@authenticated | | match | all |
|---|
| group | not-tmforum-members |
|---|
Image Removed |
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 | Resource, Common | |
Sales |
Test Case intent of this API is to provide a consistent/standardized mechanism to manage test case models and related artifacts.It includes the model definition as well as all available operations and is part of the TMF913 Test API Component Suite.
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 |
TMF704| match | all |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2 |
|---|
|
|
|
.0| Link | https://github.com/tmforum-apis/TMF704_TestCase |
|---|
| .0 | | Link | https://tmf-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 | Test Case Managment @authenticated | | match | all |
|---|
groupImage Removed |
| Show If |
|---|
special | not-tmforum-members | Image Removedmatch | all |
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https:// |
|---|
|
|
|
projects.tmforum.org/wiki/download/attachments/146293898/TMF704_Test_Case| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF699_Sales_Management_API_ |
|
|
|
UserGuide0?api=v2Test Case | Show If |
|---|
| special | @authenticated |
|---|
match | allImage Removed |
| group | not-tmforum-members |
|---|
Yet Available Yet Available Yet Available Yet Available 205(0)Pre-production | | 08-06-2022 | MarketingSales | |
Service Usage |
Test Data TMF706Not Yet Available | match | allSpecification PDFprojects.tmforum.org/wiki/download/attachments/146293820/TMF706_Test_Data_Management_API_User_Guide_| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF727-ServiceUsage-v4.0.0. |
|
|
|
pdf?api=v2| swagger.json | | Name | Service Usage Management API |
|---|
| |
|
|
| Name | Test Data Management API |
|---|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image RemovedImage Removed Yet Available Yet Available Yet Available Yet Available 205()PreproductionTest Environment | |
Shipment Management Management API |
TMF705 | Shipment Management | TMF711 |
Not Yet Available | match | all |
|---|
Specification PDF://projects.tmforum.org/wiki/download/attachments/146293812/TMF705_Test_Environment_Management_API_REST_User_Guide_| ://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF711-ShipmentManagement-v4.0.0. |
|
|
|
pdf?api=v2Test Environment | Shipment Management Management API |
| |
|
|
@authenticatedmatchall | | group | not-tmforum-members |
|---|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 (v4.0.0) | Pre-production | Test Execution Management API | TMF708 | Not Yet Available | | 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 | |
match | allSpecification PDF| Swagger | | Licence | Apache 2.0 |
|---|
| Link | https:// |
|---|
|
|
|
projects.tmforum.org/wiki/download/attachments/146293829/TMF708_Test_Execution_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=v2Test Execution | Shipping Order Management API |
| |
|
|
@authenticated | match | allImage Removed |
| Show If |
|---|
special | | group | not-tmforum-members |
|---|
Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0 (v4.0.0) | Pre-production | Test Result Management API | TMF707 | Not Yet Available match | all |
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https:// |
|---|
|
|
|
projects.tmforum.org/wiki/download/attachments/146293824/TMF707_Test_Result| tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF700_Shipping_Order_Management_API_ |
|
|
|
UserGuide..?api=v2 | | Name | Shipping Order Management API |
|---|
| |
|
|
| Name | Test Result Management API |
|---|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image RemovedNot Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 20.5.0(v4.0.0)
Pre-production | Test Scenario Manegement API | TMF709 | Not Yet Available | matchall| group | tmforum-members |
|---|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
Link | https://projects.tmforum.org/wiki/download/attachments/146293833/TMF709_Test_Scenario_Management_API_User_Guide_| CTK-Conformance | | Licence | RAND |
|---|
| Link | https://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=v2Test Scenario | Shipping Order Management API |
| |
|
|
@authenticated | match | allImage Removed |
| Show If |
|---|
special | | group | not-tmforum-members |
|---|
Image Removed Yet Available Yet Available Yet Available Not Yet Available | 20()Pre-production | User Roles & Permissions API A user role is defined as the entity that defines a set of privileges covering various functions and/or manageable assets. When a user is assigned a given role then it is actually allocated all the privileges defined for that role type and the corresponding permissions are created for that user. | | 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 |
TMF672matchall | 2.0| Link | https://github.com/tmforum-apis/TMF672_UserRolesPermissions |
|---|
| 2.0 | | Link | https://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 |
|---|
|
|
|
Name | User Roles & Permissions @authenticated | match | allImage Removed |
| Show If |
|---|
special | | group | not-tmforum-members |
|---|
Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| 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 | |
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 |
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792889/TMF672_User_Role_Permission_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | User Roles & Permissions API |
|---|
|
match | allnot-Image Removed |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF677-UsageConsumption-v4.0.1.swagger.json |
|---|
| Name | Usage Consumption Management |
|---|
|
|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146293796/TMF672B_User_Role_Permission_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
Name | User Roles & Permissions @authenticated | | match | all |
|---|
| group | not-tmforum-members |
|---|
Image Removed |
Not Yet Available | Not Yet Available | | 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 | |
| match | all |
|---|
PostmanRANDprojects.tmforum.org/wiki/download/attachments/143534323/TMF672-UserRolePermission-v4-Postman.zip?api=v2Name | User Roles & Permissions | tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF697-WorkOrder-v4.0.0.swagger.json | | Name | Work Order Management API |
|---|
| |
|
|
@authenticatedmatch20.5.0
(all | | group | not-tmforum-members |
|---|
Image Removed |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | |
)Pre-production | | 22-Nov-2021 | Business Partner | |
