Pre-Production
_____________________________________ | Document Number | Swagger (Apache 2.0 or RAND) | API User Guide / Specification (RAND) | Conformance Profile (RAND) | CTK | Sample Implementation Code | Postman Collection | Release | Swagger Version |
---|
Lifecycle Status | Digital Identity TMF720 | Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
| Publication Date | ODA Domain | Notes |
---|
Account 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.standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts | TMF666 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF720_DigitalIdentityBeta/4.1.0/swagger/TMF666-Account-v4.1.0.swagger.json | Name |
---|
|
|
|
Digital Identity Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image RemovedImage Removed Yet Available Yet Available Yet Available Yet Available Yet Available40Pre-production | 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 |
Entity Catalog Management API The 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. | TMF662matchall | |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF662_EntityCatalogBeta/4.0.0/swagger/TMF925-TroubleTicket-v4.0.0.asyncapi.yml | Name | Async Trouble Ticket API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v4.0.0 | | Common | |
Change Management API The Change Management API provides the standard integration capabilities between external applications and Change Management Application | TMF655 |
Name | Entity Catalog Management API |
---|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
Show If |
---|
|
Image Removedmatch | allSpecification PDFSwagger | Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/172125892/TMF662_Entity_Catalog_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=v2Entity Catalog @authenticatedmatchall | group | not-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 |
Image Removed |
Show If |
---|
|
Image Removedmatch | allCTK-Conformance | Swagger | Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/176325446/TMF662B_Entity_Catalog_Conformance_Profile_tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF717-Customer360-v4.0.0. |
|
|
|
pdf?api=v2Entity Catalog Customer360 Management API |
|
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
Image Removed Yet Available Yet Availableyet available | Not yet available | Not yet available | Not yet available |
Not Yet Available4Pre-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. | TMF703 | Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
05-Jan-2022 | Customer | |
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 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubName | Entity Inventory Management 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/TMF703_EntityInventory/Beta/4.0.0/swagger/TMF924-dcs-5gslice-sa-swagger.json | Name | DCS 5GSlice Service Activation API |
---|
| |
|
|
Image Removed Yet Available Yet Available Yet Available Yet Available Yet Available214Pre-production | Event 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 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 |
TMF688matchall | |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF688-Eventtmf-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 | Event management 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 Removedmatch | all |
Specification PDFprojects.tmforum.org/wiki/download/attachments/162957555/TMF688_Event_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=v2Event Entity Inventory Management API |
| |
|
|
@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.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 | |
special | @authenticated |
---|
match | allCTK-Conformance | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/172125911/TMF688B_Event_API_Conformance_Profile_tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF688-Event-v4.0.0 |
|
|
|
.pdf?api=v2.swagger.json | Name | Event Management API |
---|
| |
|
|
@authenticated | match | allnot-Image RemovedNot Yet Available | Not Yet Available | Not Yet Available | 21.5.0 | 4.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 |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
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 |
---|
|
|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF691_FederatedIdentityBeta/4.0.0/conformance/TMF688_Event_Management_API_conformance_21.5.0.pdf | Name | Event Management API |
---|
| |
|
|
Name | Federated Identity API |
---|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image RemovedImage Removed |
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
| 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 |
---|
|
|
|
Type | Specification PDFprojects.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/TMF691-FederatedIdentity-v4.0.0 |
|
|
|
.pdf?api=v2.swagger.json | Name | Federated |
---|
|
|
|
Identity @authenticated | match | allnot-Image RemovedNot Yet Available | Not Yet Available | Not Yet Available | 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 |
Not Yet Available4Preproduction Address Location 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.the information of a geographic region of the entity (customer, equipment, address). | TMF675 |
TMF673matchall | |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF673_GeographicAddresstmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF675-GeographicLocation-v4.0.0.swagger.json | Name | Geographic |
---|
|
|
|
Address @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 | |
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 |
Image Removed |
Show If |
---|
|
Image Removedmatch | allSpecification PDFprojects.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/swagger/TMF674-GeographicSite-v5.0.0. |
|
|
|
pdf?api=v2 Address Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
Image Removedmatch | allCTK-Conformance | Specification PDF | Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/146293800/TMF673B_Geographic_Address_API%20Conformance_Profile_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF674-GeographicSite-v5.0.0.pdf |
|
|
|
?api=v2 Address Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
Image Removed Yet Available Yet Available Yet Availableyet available | Not yet available | 22 |
214Pre-production | | 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 |
Geographic Location Management API Provides the information of a geographic region of the entity (customer, equipment, address). | TMF675match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubName | Geographic Location Management 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/TMF675_GeographicLocation/Beta/4.0.0/swagger/TMF921-Intent-v4.0.0.swagger.json | Name | Intent |
---|
| |
|
|
Image Removed Yet Available Yet Available Yet Available Yet Available Yet Available2154Preproduction2022 | | |
IoT Agent and Device Management API |
Component SuiteIn 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 | |
match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF908_IoTAgentAndDeviceComponentSuiteName | Iot Agent and Device API Suite |
---|
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 |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image RemovedImage Removedmatch | all |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/123085401/tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF908_IoT_ |
|
|
|
AgentandDeviceRESTSpecificationv1.1?version=1&modificationDate=1592864314038&api=v2Iot Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
IoT Agent and Device Management API |
|
|
|
Suite Yet Available Yet Available Yet Available Yet Available4Pre-production22-Nov-2021 | Resource | |
IoT Service Management API |
Component SuiteThe 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 | |
match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF914_IoTServiceComponentSuitetmf-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 |
---|
|
|
|
Suite Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
Image Removedmatch | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/143531023/TMF914_IOTtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF914_IoT_Service_Management_API_ |
|
|
|
User_Guide_v4.0Component_Suite_user_guides_21.5.0.pdf |
|
|
|
?api=v2 | Name | IoT Service Management API |
---|
|
|
|
Suite Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed Yet Available Yet Available Yet Available Yet Available4Pre-production | 22-Nov-2021 | Product, Common, Resource, Service | |
Metadata Catalog Management API Metadata Catalog | TMF725 | |
Payment Method API This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer. | TMF670 | show-match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF670_PaymentMethodsBeta/4.0.0/swagger/TMF725-MetadataCatalog-v4.0.0.swagger.json | Name | Metadata Catalog Management API |
---|
| |
|
|
Name | Payment Methods API@authenticatedmatchall | group | not-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 |
Image Removed |
Show If |
---|
|
Image Removedmatch | allSpecification PDFLink | Name | Payment Methods API |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/176327026/TMF670_Payment_Method_Management_API_User_Guide_v4.0.0.pdf?api=v2tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF669-PartyRole-v4.1.0.swagger.json | Name | Party Role Management API |
---|
| |
|
|
@authenticatedmatchall | group | not-tmforum-members |
---|
Image Removed |
| 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 |
Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 21.5.0 | 4.0.0 | Pre-production | |
Performance Management API Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance. | TMF628 | |
match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com |
|
|
|
/tmforum-apis/Beta/4.0.0/swagger/TMF628 |
|
|
|
_Performance-Performance-v4.0.0.swagger.json | Name | Performance Management API |
---|
| |
|
|
@authenticatedmatch | 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 |
Not Yet Available4Pre-productionTMF701 | Show If |
---|
|
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: |
- A ProcessFlow will describe an orchestration of TaskFlow
- In event-based architecture the processFlow are triggered as consequence of event
- TaskFlow could be completed automatically (rules, event triggered, process delegation) or requiring manual action
- Operations on taskFlow allow to update taskFlow
TMF701 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF701_ProcessFlowtmf-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 |
---|
| |
|
|
Image Removed |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/128869433tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF701_Process_Flow_Management_API_ |
|
|
|
REST_R19.1?version=1&modificationDate=1585949431000&api=v2 | Name | Process Flow Management API |
---|
| |
|
|
Show If |
---|
|
Trackinglink |
---|
Type | CTK-Conformance |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/128869433/TMF701Btmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/conformance/TMF701_Process_Flow_Management_Conformance |
|
|
|
_Profile_R19.1?version=1&modificationDate=1585949500000&api=v2 | Name | Process Flow Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | 19.0.1 |
(0)Pre-production | Promotion API Used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit | TMF671 | Show If |
---|
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 | |
special | @authenticated |
---|
match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF671_PromotionBeta/5.0.0/swagger/TMF620-Product_Catalog_Management-v5.0.0.oas.yaml | Name | Product Catalog Management API |
---|
| |
|
|
Name | Promotion API@authenticated | match | allnot-Image RemovedNot Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 21.5.0 | 4.0.0 | 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. | TMF680 | Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF620-Product_Catalog_Management-v5.0.0.pdf |
---|
Name | Product Catalog Management API |
---|
| |
|
|
@authenticatedmatchall | group | tmforum-members |
---|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://github.com/tmforum-apis/TMF680_Recommendation |
---|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | Product | |
Product Inventory Management API 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 |
Name | Recommendation APImatch | all |
not-Image Removedshow-if |
Image Removed |
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/5.0.0/swagger/TMF637-ProductInventory-v5.0.0.oas.yaml |
---|
Name | Product Inventory Management API |
---|
| |
|
|
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@authenticated | match | allnot-Image Removed Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | CTK-Conformance |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/146293804/TMF680B_Recommendation_Conformance_Profile_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF637-ProductInventory-v5.0.0.pdf |
|
|
|
?api=v2Recommendation Product Inventory Management 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 | 22 |
214 v5.0.0 | | Product | |
Product Offering Qualification Management API Product Offering Qualification API is one of Pre- |
productionResource 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.
| Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility. | TMF679 |
TMF702match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com |
|
|
|
/tmforum-apis/TMF702-ResourceActivationConfigurationName | Resource Activation and Configuration API/Beta/5.0.0/swagger/TMF679-ProductOfferingQualification-v5.0.0.oas.yaml | Name | Product Offering Qualification Management API |
---|
| |
|
|
@authenticated | match | allnot-Image Removed |
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
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/TMF679-ProductOfferingQualification-v5.0.0.pdf |
|
|
|
?api=v2Resource Activation and Configuration Product Offering Qualification Management API |
|
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
Yet Available Yet Available Yet Available Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
yet available | 22.5.0 | v5.0.0 | | Product | |
Product Ordering Management API Provides 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 |
Type | Postman |
---|
Licence | RAND |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/162957536/TMF702-ResourceActivation-v4-Postman.zip?api=v2 |
---|
Name | Resource Activation and Configuration APImatch | all |
not-Image Removed |
21.5.0 | 4.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 |
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/TMF622-ProductOrdering-v5.0.0.oas.yaml |
---|
Name | Product Ordering Management API |
---|
| |
|
|
TMF664match | all |
SwaggerApache 2.0github 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_ResourceFunctionActivationConfigurationName | Resource Function Activation and Configuration API |
---|
/Beta/5.0.0/user_guides/TMF622-ProductOrdering-v5.0.0.pdf | Name | Product Ordering Management API |
---|
| |
|
|
Image Removed |
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | tmforum-members |
---|
|
| 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 |
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/TMF671-Promotion-v4.0.0.swagger.json |
---|
Name | Promotion Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Product | |
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 |
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/TMF648-Quote-v5.0.0.oas.yaml |
---|
Name | Quote 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/TMF648-Quote-v5.0.0.pdf |
---|
Name | Quote Management API |
---|
| |
|
| 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 |
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/TMF680-Recommendation-v4.0.0.swagger.json |
---|
Name | Recommendation 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/TMF680_Recommendation_API_user_guides_21.5.0.pdf |
---|
Name | Recommendation 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/TMF680_Recommendation_API_conformance_21.5.0.pdf |
---|
Name | Recommendation Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Customer | |
Resource Activation Management API The Resource Activation and Configuration API can be used to query resource instances to acquire the resource activation states and attributes, and it can be used to create/update, configure and activate the resource instances. | TMF702 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF702-ResourceActivation-v4.0.0.swagger.json |
---|
Name | Resource Activation 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/TMF702_Resource_Activation_and_Configuration_API_user_guides_21.5.0.pdf |
---|
Name | Resource Activation 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/TMF702_Resource_Activation_v4.0.0_conformance.pdf |
---|
Name | Resource Activation Management API |
---|
| |
|
|
Show If |
---|
|
Trackinglink |
---|
Type | CTK |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ctk/TMF702-ResourceActivation.zip |
---|
Name | Resource Activation Management API |
---|
| |
|
|
Show If |
---|
|
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 |
---|
| |
|
|
Show If |
---|
|
Trackinglink |
---|
Type | Postman |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/postman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zip |
---|
Name | Resource Activation Management API |
---|
| |
|
| 21.5.0 | v4.0.0 | 22-Nov-2021 | Resource, Common | |
Resource Function Activation and Configuration API This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function | TMF664 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.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 |
---|
| |
|
|
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 |
---|
|
|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/134776992/TMF664_Resource_Function_Activation_ |
|
|
|
and_ConfigurationUserGuide..?api=v2 | Name | Resource Function Activation and Configuration API |
---|
|
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
Yet Available Yet Available Yet Available Yet Available2154Pre-production | 08-06-2022 | Resource, Common | |
Sales |
Risk Risk allows the retrieval of Risk Assessments during interaction with PartyRoles (individualsor organizations) typically engaged in an Order process from ProviderPartyRole. The Risk Assessment request is usually issued by the ProviderPartyRole (e.g. Service Provider). The resources used to retrieve these assessment are Task resources, as per the Open API guidelines for tasks.provides 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 |
TMF696match | all |
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com |
|
|
|
/tmforum-apis/TMF696_RiskManagementName | Risk Management API |
---|
/Beta/4.1.0/swagger/TMF699-Sales-v4.1.0.swagger.json | Name | Sales Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image RemovedImage Removedmatch | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/146293808/TMF696_Risktmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF699_Sales_Management_API_ |
|
|
|
UserGuide0?api=v2Risk @authenticated | match | all |
---|
group | not-tmforum-members |
---|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 | v4.1.0 | 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 |
Image Removed |
Show If |
---|
|
Image Removedmatchall | CTK-ConformanceSwagger | Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/162957559/TMF696B_Risk_Management_API_Conformance_Profile_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF640-Service_Activation_and_Configuration-v5.0.0 |
|
|
|
.pdf?api=v2.oas.yaml | Name | Service Activation Management API |
---|
| |
|
|
Name | Risk Management API |
---|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image RemovedImage Removedmatchall | CTKSpecification PDF | Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/162957532/TMF696-RiskManagement_?api=v2tmf-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 | Name | Service Activation Management API |
---|
| |
|
|
Name | Risk 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 | 22.5.0 | v5.0.0 | | Common, Service | |
Service Catalog Management API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | TMF633 |
Image Removedmatch | allRI | Link | https://projects.tmforum.org/wiki/download/attachments/162957538/TMF696-RiskManagement-v4.zip?api=v2 |
---|
Name | Risk Management API |
---|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
| Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://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 |
---|
| |
|
|
Image Removedmatchall | PostmanRAND | Link | https://projects.tmforum.org/wiki/download/attachments/162957536/TMF696-RiskManagement-v4.0.0-Postman.zip?api=v2 |
---|
Name | Risk Management API |
---|
| RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF633-Service_Catalog_Management-v5.0.0.pdf |
---|
Name | Service Catalog Management API |
---|
| |
|
|
@authenticatedmatchall | group | not-tmforum-members |
---|
| Not yet available | Not yet available | Not yet available | Not yet available | 22 |
Image Removed |
214Pre-production Problem Inventory Management API The |
SPM used to manage service problems. Service problems are generated based on the information declared by a partner or the event information notified from infrastructure providers. The event information includes alarm information, performance anomaly information, trouble ticket information, SLA violation, maintenance information, and prediction information.to provide a consistent/standardized mechanism to query and manipulate the Service inventory. | TMF638 |
TMF656match | allApache 2.0 | Link | https://github.com/tmforum-apis/TMF656_ServiceProblemManagement |
---|
Name | Service Problem Management API |
---|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
| Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF638-Service_Inventory_Management-v5.0.0.oas.yaml |
---|
Name | Service Inventory Management API |
---|
| |
|
|
Image Removedmatch | all |
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/172125882/TMF656_Service_Problem_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=v2 Problem Show If |
---|
special | @authenticated |
---|
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 | 22.5.0 | v5.0.0 | | 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 |
Trackinglink |
---|
Type | CTK-Conformance |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/172125888/TMF656B_Service_Problem_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
---|
Name | Service Problem Management APImatch | allnot-tmforum-members | Image Removed |
Not Yet Available | Not Yet Available | Not Yet Available | 21.5.0 | 4.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/TMF641-ServiceOrdering-v5.0.0.oas.yaml |
---|
Name | Service Ordering Management API |
---|
| |
|
|
Service Quality Management API Through this API, any Enterprise is able to access a Service Quality Management application and extract Service Level Specifications and associated Service Level Objectives (SLO) and their thresholds. | TMF657@authenticated | match | allSwaggerApache 2.0githubtmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/ |
|
|
|
tmforum-apis/TMF657_ServiceQualityManagementBeta/5.0.0/user_guides/TMF641-ServiceOrdering-v5.0.0.pdf | Name | Service |
---|
|
|
|
Quality @authenticated | match | all |
---|
group | not-tmforum-members |
---|
Image Removed |
| 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 | all |
Specification PDFprojects.tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_API_User_Guide_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF653-Service_Test_Management-v5.0.0 |
|
|
|
.pdf?api=v2 Quality Management API Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image RemovedImage Removedmatchall | CTK-Conformance | Specification PDF |
---|
Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/162957551/TMF657_Service_Quality_Management_Conformance_Profile_4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF653-Service_Test_Management-v5.0.0.pdf |
|
|
|
?api=v2 Quality @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 | v5.0.0 | 10-Dec-2021 | Service | |
Service Usage Management API | TMF727 | |
match | allRIprojects.tmforum.org/wiki/download/attachments/162957538/TMF657-ServiceQualityManagement-v4.zip?api=v2tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF727-ServiceUsage-v4.0.0.swagger.json | Name | Service |
---|
|
|
|
Quality @authenticated | match | all |
---|
group | not-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 | | |
Shipment Management Management API Shipment Management | TMF711 |
Image Removed |
Show If |
---|
|
Image Removedmatch | allPostmanRAND | Link | https://projects.tmforum.org/wiki/download/attachments/143534323/TMF657-ServiceQualityManagement-v4-Postman.zip?api=v2 |
---|
Apache 2.0 | Link | https://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 |
---|
| |
|
|
Name | Service Quality Management API@authenticatedmatchall | group | not-tmforum-members |
---|
Image Removed |
21.5.0 | 4.0.0 | | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | | v4.0.0 | 10-Jan-2022 | Business Partner |
Pre-production | |
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 | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF700_ShippingOrdertmf-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 |
---|
| |
|
|
@authenticated | match | allnot-Image RemovedNot Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 21.5.0 | 4.0.0 | Pre-production | Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0.pdf |
---|
Name | Shipping Order Management API |
---|
| |
|
|
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@authenticatedmatchallgrouptmforum-membersSwagger | Licence | Apache 2.0 |
---|
Link | https://github.com/tmforum-apis/TMF677_UsageConsumption |
---|
Name | Usage Consumption API |
---|
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 |
---|
Name | Shipping Order Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image RemovedImage Removed Yet Available Yet Availableyet available | Not yet available |
Not Yet Available | Not Yet Available | Not Yet Available4Pre-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 |
TMF672match | all |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF672_UserRolesPermissionsName | User Roles & Permissions API |
---|
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 |
---|
| 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 | |
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 |
Image Removed |
Show If |
---|
|
Image Removedmatch | allSpecification PDFprojects.tmforum.org/wiki/download/attachments/134792889/TMF672_User_Role_Permission_Management_API_User_Guide_v4tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF621-Trouble_Ticket-v5.0.0. |
|
|
|
pdf?api=v2User Roles & Permissions API | Trouble Ticket Management API |
| |
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image RemovedImage Removedmatch | all |
CTK-ConformanceSpecification PDF | Licence | RAND |
---|
Link | https:// |
---|
|
|
|
projects.tmforum.org/wiki/download/attachments/146293796/TMF672B_User_Role_Permission_Conformance_Profile_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=v2User Roles & Permissions API | Trouble Ticket Management API |
| |
|
|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image RemovedImage Removed |
Not Yet Available | Not Yet Available | | Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | Common | |
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 | |
match | all |
PostmanRANDprojects.tmforum.org/wiki/download/attachments/143534323/TMF672-UserRolePermission-v4-Postman.zip?api=v2tmf-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 |
---|
| |
|
|
Name | User Roles & Permissions API |
---|
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image RemovedImage Removed | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 |
4Pre-production22-Nov-2021 | Product | |
Work Order Management API The Work Order API performs the following operations on a workOrder resource: |
Retrieval of a workOrder or a collection of workOrder depending on filter criteriaPartial update of a workOrder (including updating rules)Creation of a workOrder (including default values and creation rules)Deletion of a workOrder (for administration purposes)Notification of events on a workOrder.@authenticated | matchall@authenticated | group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https:// |
---|
|
|
|
github.com/tmforum-apis/TMF697_Work_Ordertmf-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 |
---|
| |
|
|
@authenticatedmatchall | group | not-tmforum-members |
---|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | | v4.0.0 | 22-Nov-2021 | Business Partner |
Image Removed |
Show If |
---|
|
Image Removed