TM Forum Open APIs _____________________________________ | Document Number | Swagger (Apache 2.0 or RAND) | API User Guide / Specification (RAND) | Conformance Profile (RAND) | CTK | Sample Implementation Code | Postman Collection | Release | Swagger Version | Publication Date | ODA Domain | Notes |
---|
Account Management API Provides standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts | TMF666 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF666-Account-v4.1.0.swagger.json |
---|
Name | Account Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.1.0 | 10-Jan-2022 | EngagedPartyBusiness Partner, Customer | |
Async Trouble Ticket API Async API Enabled for Trouble Ticket, Async API conpect supporting the event-based architecture | TMF925 | Change Management API The Change Management API provides the standard integration capabilities between external applications and Change Management Application | TMF655 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF655TMF925-ChangeTroubleTicket-v4.0.0.swaggerasyncapi.jsonyml |
---|
Name | Change Management Async Trouble Ticket API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v4.0.0 10-Jan-2022 | | Common | |
Customer360 Change 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 The Change Management API provides the standard integration capabilities between external applications and Change Management Application | TMF655TMF717 |
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/TMF717TMF655-Customer360Change-v4.0.0.swagger.json |
---|
Name | Customer360 Change Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | | v4.0.0 | 0510-Jan-2022 | CustomerCommon | |
Digital Identity Customer360 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. 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 | TMF717TMF720 |
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/TMF720TMF717-DigitalIdentityCustomer360-v4.0.0.swagger.json |
---|
Name | Digital Identity Customer360 Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 2205-NovJan-20212022 | EngagedParty, Common | Document Management API
TMF667 Document API describes the meta-data of a Document, such as the name, creationDate and lifecycle status. The (typically binary) body of this document (such as a Word.doc, PDF, Video clip, or Image) will be held in the associated Attachment(s) either by Ref or Value. If by value - the binary content is held in the Attachment.content. If by reference, the Attachment.url might point to a (file:) or remote (http:) pointer to the Document media. A Document may be associated with a DocumentSpecification, which will detail the characteristics of that type of Document (an Image may have a width, height and format; a Video may have a length and format). A Document has a collection of RelatedParty's, for roles such as author, reviewer, publisher, and a lifecycle status to take the document through a simple set of production stages.
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://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF924-dcs-5gslice-sa-swagger.json |
---|
Name | DCS 5GSlice Service Activation API |
---|
| |
|
| TMF667
Show If |
---|
special | @authenticated@anonymous |
---|
group | tmforum-members |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF667-Document-v4.0.0.swagger.json |
---|
Name | Document Management API |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v4.0.0 | | Service | |
Digital Identity Management API. Provides the ability to manage a digital identity. This digital identity allows identification of an individual, a resource, or a partyRole (a specific role - or set of roles - for a given individual). A digital identity is associated with credential / authentification method. These credential / authentification methods should be extensible to describe all types of authentification method such as login/password, biometric, token, etc. A contact medium is also associated with digital identity (or directly at credential level) to manage credential recovery UCs. | TMF720 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
|
| Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF667_Document_Management_API_REST_Specification_v4-0-0.pdfswagger/TMF720-DigitalIdentity-v4.0.0.swagger.json |
---|
Name | Digital Identity Management API. | Name | Document Management API |
---|
| |
|
Show If |
---|
| Image Removed | Show If |
---|
| Trackinglink |
---|
Type | CTK-Conformance |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF667_Document_v4.0.0_conformance.pdf |
---|
Name | Document Management API |
---|
| Image Added |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | 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 |
Show If |
---|
special | @anonymous@authenticated |
---|
| Image Removed | Show If |
---|
special | @authenticatedtmforum-members |
---|
|
Trackinglink |
---|
Type | CTKSwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ctkswagger/TMF667TMF703-DocumentEntityInventory-v4.0.0-ctk.swagger.zipjson |
---|
Name | Document Entity Inventory Management API |
---|
| |
|
Show If |
---|
| Image Removed | Show If |
---|
| Trackinglink |
---|
Type | RI |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ri/TMF667_Document-v4.0.0-ri.zip |
---|
Name | Document Management API |
---|
| |
| Not yet available | | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5 22.0.0 | v4.0.0 | 0522-JanNov-20222021 | Common | |
Entity Inventory Event Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory.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. | TMF688TMF703 |
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/TMF703TMF688-EntityInventoryEvent-v4.0.0.swagger.json |
---|
Name | Entity Inventory Event Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Common | Event Management API The Event Management API provides a standardized client interface to the enterprise event management system for creating, managing and receiving service related events to (indicatively) drive automation workflows, notify other service providers for service outages and SLA violations, trigger Trouble Ticket creation, and enable more complex orchestration scenarios between management systems. The Event Management API can also be used to convey business level Events in support of other processes. | TMF688 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF688_Event_Management_API_user_guides_21.5.0.pdf |
---|
Name | Event Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated | group | tmforum-members |
---|
|
Trackinglink |
---|
Type | SwaggerCTK-Conformance |
---|
Licence | Apache 2.0RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swaggerconformance/TMF688-Event-v4.0_Event_Management_API_conformance_21.5.0.swagger.jsonpdf |
---|
Name | Event Management API |
---|
| |
|
Show If |
---|
| Image Removed | Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF688_Event_Management_API_user_guides_21.5.0.pdf |
---|
Name | Event Management API |
---|
| Image Added |
| 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 | @anonymous@authenticated |
---|
| Image Removed | show | ifspecialmembers | @authenticated |
|
Trackinglink |
---|
Type | CTK-ConformanceSwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF688_Event_Management_API_conformance_21.5.0.pdfswagger/TMF691-FederatedIdentity-v4.0.0.swagger.json |
---|
Name | Federated ID | Name | Event Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Common | |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https |
---|
|
|
| Federated Identity API The management of principals of any kind (persons, objects, …) and their access to resources in an open environment which can span across different enterprise boundaries. It relies on authentication, authorization and consent mechanisms to protect privacy with a simple and easy user experience. Different parties can provide identity services (operators, social networks, GSMA, …). | TMF691 | Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF691-FederatedIdentity-v4.0.0.swagger.jsonuser_guides/TMF691_Federated_Identity_API_user_guides_21.5.0.pdf |
---|
Name | Federated Identity ID Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Common | |
Geographic Location Management API Provides the information of a geographic region of the entity (customer, equipment, address). | TMF675 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDFSwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF691_Federated_Identity_API_user_guides_21.5.0.pdfswagger/TMF675-GeographicLocation-v4.0.0.swagger.json |
---|
Name | Geographic Location Management | Name | Federated Identity API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Common | |
Geographic Location Site Management API Provides the information of a geographic region of the entity (customer, equipment, address). | TMF675 | Covers the operations to manage (create, read, delete) sites that can be associated with a customer, account, service delivery or other entities. This API defines a Site as a convenience class that allows easy reference to places important to other entities, where a geographic place is an entity that can answer the question “where?” | TMF674 |
Show If |
---|
| 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/45.0.0/swagger/TMF675TMF674-GeographicLocationGeographicSite-v4v5.0.0.swaggeroas.jsonyaml |
---|
Name | Geographic Location Site Management API |
---|
| |
|
Show If |
---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Common | 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. | |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF674-GeographicSite-v5.0.0.pdf |
---|
Name | Geographic Site Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | Common | |
Intent The Component Suite for Intent Management API defines the set of operations that should be offered to manage intent and intent-driven interactions in a consistent manner. | TMF921 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF921-Intent-v4.0.0.swagger.json |
---|
Name | Intent |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 | v4.0.0 | 08-06-2022 | | |
IoT Agent and Device Management API In addition to including established TM Forum Open APIs, such as alarm management, resource management and activation APIs, the IoT Device Management API Component Suite also includes an IoT Data Access Endpoint API. This API allows for IoT data access using different types of protocols (MQTT IoT, CoAP, etc.). It encapsulates the protocols and allows devices to be easily integrated into solutions that support a host of IoT initiatives, including smart cities, smart factories and other vertical markets. | TMF908 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0.0.swagger.json |
---|
Name | IoT Agent and Device Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF908_IoT_Device_Management_API_Component_Suite_user_guides_21.5.0.pdf |
---|
Name | IoT Agent and Device Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Resource | |
IoT Service Management API The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale. | TMF914 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF914-IotService-v4.0.0.swagger.json |
---|
Name | IoT Service Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF914_IoT_Service_Management_API_Component_Suite_user_guides_21.5.0.pdf |
---|
Name | IoT Service Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Product, Common, Resource, Service | |
Metadata Catalog Management API Metadata Catalog | TMF725 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF725-MetadataCatalog-v4.0.0.swagger.json |
---|
Name | Metadata Catalog Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | | v4.0.0 | 10-Jan-2022 | Common | |
Party Role Management API A standardized mechanism for general party roles and includes operations such as creation, update, retrieval, deletion and notification of events. Notice that for the management of customers there is a specific Customer Management API. Party Role management API manages the following data resources: PartyRole | TMF669 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF669-PartyRole-v4.1.0.swagger.json |
---|
Name | Party Role Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 | v4.1.0 | 08-06-2022 | Business Partner | |
Performance Management API Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance. | TMF628 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF628-Performance-v4.0.0.swagger.json |
---|
Name | Performance Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Service, Common | |
Process Flow Management API The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action: | TMF701 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF701-ProcessFlow-v4.1.0.swagger.json |
---|
Name | Process Flow Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF701_Process_Flow_Management_API_Specification_v4.1.0.pdf |
---|
Name | Process Flow Management API |
---|
| |
|
|
Show If |
---|
|
Trackinglink |
---|
Type | CTK-Conformance |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/conformance/TMF701_Process_Flow_Management_Conformance-v4.1.0.pdf |
---|
Name | Process Flow Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | 19.0.1 | v4.1.0 | 22-Nov-2021 | Common | |
Product Catalog Management API Provides a standardized solution for rapidly adding partners’ products to an existing Catalog. It brings the capability for Service Providers to directly feed partners systems with the technical description of the products they propose to them. | TMF620 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF620-Product_Catalog_Management-v5.0.0.oas.yaml |
---|
Name | Product Catalog Management API |
---|
| |
|
|
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/TMF620-Product_Catalog_Management-v5.0.0.pdf |
---|
Name | Product Catalog Management API |
---|
| |
|
| 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 |
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/TMF637-ProductInventory-v5.0.0.oas.yaml |
---|
Name | Product Inventory 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/TMF637-ProductInventory-v5.0.0.pdf |
---|
Name | Product Inventory Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | Product | |
Product Offering Qualification Management API Product Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility. | TMF679 |
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/TMF679-ProductOfferingQualification-v5.0.0.oas.yaml |
---|
Name | Product Offering Qualification 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/TMF679-ProductOfferingQualification-v5.0.0.pdf |
---|
Name | Product Offering Qualification Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not 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 |
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/TMF622-ProductOrdering-v5.0.0.oas.yaml |
---|
Name | Product Ordering 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/TMF622-ProductOrdering-v5.0.0.pdf |
---|
Name | Product Ordering Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | Customer, Product | |
Promotion Management API Used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit | TMF671 |
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 |
---|
| |
|
| TMF908 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | SwaggerSpecification PDF |
---|
Licence | Apache 2.0RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0user_guides/TMF680_Recommendation_API_user_guides_21.5.0.swagger.jsonpdf |
---|
Name | IoT Device Recommendation Management API Component Suite |
---|
| |
|
|
Show If |
---|
special | @authenticated | group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDFCTK-Conformance |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/userTMF680_guides/TMF908Recommendation_IoTAPI_Device_Management_API_Component_Suite_user_guides_21.5.0.pdf |
---|
Name | IoT Device Management API Component Suite |
---|
| 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 | | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Resource | IoT Service Management API Component Suite The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale. | TMF914 |
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 | SwaggerSpecification PDF |
---|
Licence | Apache 2.0RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF914-IotService-v4.0.0.swagger.jsonuser_guides/TMF702_Resource_Activation_and_Configuration_API_user_guides_21.5.0.pdf |
---|
Name | Resource Activation Management API | Name | IoT Service Management API Component Suite |
---|
| |
|
|
Show If |
---|
special | @authenticated | group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDFCTK-Conformance |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guidesconformance/TMF914TMF702_IoTResource_Service_Management_API_Component_Suite_user_guides_21.5.0Activation_v4.0.0_conformance.pdf |
---|
Name | IoT Service Resource Activation Management API Component Suite |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Product, Common, Resource, Service | Metadata Catalog Management API Metadata Catalog | TMF725 |
Show If |
---|
special | @authenticated | group | tmforum-members |
---|
|
Trackinglink |
---|
Type | SwaggerCTK |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swaggerctk/TMF725TMF702-MetadataCatalog-v4.0.0.swagger.jsonResourceActivation.zip |
---|
Name | Metadata Catalog Resource Activation Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | v4.0.0 | 10-Jan-2022 | Common | Payment Method API This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer. | TMF670 |
Show If |
---|
|
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 |
---|
| |
|
| | group | tmforum-members | Swagger | Apache 2.0RAND | Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ |
---|
|
|
| swagger/TMF670-PaymentMethod-v4.0.0.swagger.jsonpostman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zip | Name | Resource Activation Management |
---|
|
|
| Name | Payment Method | 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 | Image Removed |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDFSwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF670_Payment_Method_API_user_guides_21.5.0.pdfswagger/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json |
---|
Name | Resource Function Activation and Configuration | Name | Payment Method API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | CTK-ConformanceSpecification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF670_Payment_Method_v4.0.0_conformanceuser_guides/TMF664_Resource_Function_Activation_Management_API_REST_Specification_v4-0-0.pdf |
---|
Name | Payment Method Resource Function Activation and Configuration API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 21 22.50.0 | v4.0.0 | 2208-Nov06-20212022 | CustomerResource, Common | |
Performance Sales 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. The Sales Management API provides interfaces for Sales Lead, Sales Opportunity, Sales Quote and the other management capabilities to support the sales activities to build relationship with the prospect customer who could be a person or organization that has an interest in the goods and/or services and possibly become the actual customers with one or more subscriptions. | TMF699TMF628 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.01.0/swagger/TMF628TMF699-PerformanceSales-v4.01.0.swagger.json |
---|
Name | Performance Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Service, Common | Process Flow Management API The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action: | TMF701 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | SwaggerSpecification PDF |
---|
Licence | Apache 2.0RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF701-ProcessFlow-v4.0.0.swagger.json |
---|
Name | Process Flow Management API |
---|
| |
| Show If |
---|
| Image Removed .com/Beta/4.1.0/user_guides/TMF699_Sales_Management_API_REST_Specification_v4.1.0.pdf | Name | Sales Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.0.0 | v4.1.0 | 08-06-2022 | MarketingSales | |
Service 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 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDFSwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/user_guides/TMF701_Process_Flow_Management_API_user_guides_19swagger/TMF640-Service_Activation_and_Configuration-v5.0.0.1oas.pdfyaml |
---|
Name | Process Flow Service Activation Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | CTK-ConformanceSpecification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/conformance/TMF701_Process_Flow_Management_API_conformance_19user_guides/TMF640-Service_Activation_and_Configuration-v5.0.10.pdf |
---|
Name | Process Flow Service Activation Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 19 22.5.0 .1 | v4 v5.0.0 22-Nov-2021 | | Common, Service | |
Service Catalog Management API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | TMF633 | Promotion API Used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit | TMF671 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Swagger |
---|
Licence | Apache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/swagger/TMF671-Promotion-v4TMF633-Service_Catalog_Management-v5.0.0.swagger.json |
---|
Name | Promotion API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v4.0.0 | 22-Nov-2021 | Product | Recommendation API Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel. | TMF680oas.yaml | Name | Service Catalog Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | SwaggerSpecification PDF |
---|
Licence | Apache 2.0RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/swaggeruser_guides/TMF680-Recommendation-v4TMF633-Service_Catalog_Management-v5.0.0.swagger.jsonpdf |
---|
Name | Recommendation Service Catalog Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | Service | |
Service Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory. | TMF638 |
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDFSwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/user_guides/TMF680_Recommendation_API_user_guides_21.5.0.pdfswagger/TMF638-Service_Inventory_Management-v5.0.0.oas.yaml |
---|
Name | Service Inventory Management | Name | Recommendation API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | CTK-ConformanceSpecification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/conformance/TMF680_Recommendation_API_conformance_21.5user_guides/TMF638-Service_Inventory_Management-v5.0.0.pdf |
---|
Name | Recommendation Service Inventory Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 21 22.5.0 | v4 v5.0.0 | 22-Nov-2021 | Customer | | Service | |
Service Ordering Management 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.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. | TMF641TMF702 |
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/45.0.0/swagger/TMF702TMF641-ResourceActivationServiceOrdering-v4v5.0.0.swaggeroas.jsonyaml |
---|
Name | Resource Activation and Configuration Service Ordering Management API |
---|
| |
|
Show If |
---|
| |
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | Specification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/user_guides/TMF702_Resource_Activation_and_Configuration_API_user_guides_21.5TMF641-ServiceOrdering-v5.0.0.pdf |
---|
Name | Resource Activation and Configuration Service Ordering Management API |
---|
| |
|
Show If |
---|
| | 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 and Configuration API |
---|
|
| Not yet available | Not yet available | Not yet available | Not yet available | 22.5.0 | v5.0.0 | | Service | |
Service Test Management API The Service Test API provides a standardized mechanism for placing a service test with all the necessary test parameters. The API consists of a simple set of operations that interact with CRM/Service Management systems in a consistent manner. A service test is a procedure intended to check the quality, performance, or reliability of a service. | TMF653 |
Show If |
---|
special | @anonymous@authenticated |
---|
| Image Removed | Show If |
---|
special | @authenticatedtmforum-members |
---|
|
Trackinglink |
---|
Type | CTKSwagger |
---|
Licence | RANDApache 2.0 |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4/Beta/5.0.0/swagger/TMF653-Service_Test_Management-v5.0.0/ctk/TMF702-ResourceActivation.zip.oas.yaml |
---|
Name | Resource Activation and Configuration Service Test Management API |
---|
| |
|
|
Show If |
---|
special | @authenticated |
---|
group | tmforum-members |
---|
|
Trackinglink |
---|
Type | RISpecification PDF |
---|
Licence | RAND |
---|
Link | https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/ri/TMF702_Resource_activation.zip |
---|
Name | Resource Activation and Configuration API |
---|
| user_guides/TMF653-Service_Test_Management-v5.0.0.pdf | Name | Service Test Management API |
---|
| |
|
| Not yet available | Not yet available | Not yet available | Not yet available | 21.5.0 | v5.0.0 | 10-Dec-2021 | Service | |
Service Usage Management API | TMF727 | | Show If |
---|
special | @authenticated | Postman | RANDApache 2.0 | 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.zipName | swagger/TMF727-ServiceUsage-v4.0.0.swagger.json | Name | Service Usage Management |
---|
|
|
| Resource Activation and Configuration |
---|