Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Not yet available
Table Filter
sparkNameSparkline
datepatternyy-mm-dd
id1583007004662_405528633
sortReleased TM Forum Open APIs (‍Asc)
isORAND
separatorPoint (.)


Image Removed

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 CollectionReleaseSwagger VersionPublication DateODA DomainNotes

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF666-Account-v4.1.0.swagger.json
NameAccount Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.1.0
10-Jan-2022Business 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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF655TMF925-ChangeTroubleTicket-v4.0.0.swaggerasyncapi.jsonyml
NameChange Management Async Trouble Ticket API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
22.5.0
v4.0.0
10-Jan-2022Common

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF717TMF655-Customer360Change-v4.0.0.swagger.json
NameCustomer360 Change Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
0510-Jan-2022CustomerCommon

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF720TMF717-DigitalIdentityCustomer360-v4.0.0.swagger.json
NameDigital Identity Customer360 Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
2205-NovJan-2021Business Partner, Common2022Customer

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

Entity Inventory Management API

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory.

TMF703


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF703-EntityInventory-v4.0.0.TMF924-dcs-5gslice-sa-swagger.json
NameEntity Inventory Management DCS 5GSlice Service Activation API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21 22.5.0
v4.0.0
22-Nov-2021CommonService

Digital Identity 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.

.

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.

TMF720TMF688


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF688TMF720-EventDigitalIdentity-v4.0.0.swagger.json
NameEvent Digital Identity Management API.

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Business 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@authenticated
grouptmforum-members
Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://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
NameEvent Management API

 

Show If
special@anonymous@authenticated
group
Show If
special@authenticatedtmforum-members


Trackinglink
TypeCTK-ConformanceSwagger
LicenceRANDApache 2.0
Linkhttps://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/TMF703-EntityInventory-v4.0.0.swagger.json
NameEntity Inventory NameEvent Management API

 



Image Removed
Show If
special@anonymous

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-2021Common

Federated Identity Event 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, …).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.

TMF688TMF691


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF691TMF688-FederatedIdentityEvent-v4.0.0.swagger.json
NameFederated Identity Event Management API

 



Show If
special@anonymous



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF691TMF688_FederatedEvent_IdentityManagement_API_user_guides_21.5.0.pdf
NameFederated Identity Event Management API

 



Show If
special@anonymous

Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Common

Geographic Location Management API

Provides the information of a geographic region of the entity (customer, equipment, address).

TMF675



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Show If
special@authenticated
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF675-GeographicLocation-v4.0.0.swagger.jsonconformance/TMF688_Event_Management_API_conformance_21.5.0.pdf
NameEvent NameGeographic Location Management API

 



Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Common

IoT Device Federated ID 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.

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, …).

TMF691TMF908


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF908TMF691-IoTAgentAndDeviceFederatedIdentity-v4.0.0.swagger.json
NameIoT Device Federated ID Management API Component Suite

 



Show If
special@anonymous



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF908TMF691_IoTFederated_DeviceIdentity_Management_API_Component_Suite_user_guides_21.5.0.pdf
NameIoT Device Federated ID Management API Component Suite

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021ResourceCommon

IoT Service Geographic Location 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.

Provides the information of a geographic region of the entity (customer, equipment, address).

TMF675TMF914


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF914TMF675-IotServiceGeographicLocation-v4.0.0.swagger.json
NameIoT Service Geographic Location Management API Component Suite

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Common

Geographic Site Management API

Covers the operations to manage (create, read, delete) sites that can be associated with a customer, account, service delivery or other entities. This API defines a Site as a convenience class that allows easy reference to places important to other entities, where a geographic place is an entity that can answer the question “where?”

TMF674


Show If
special@authenticated
grouptmforum-members
Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://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
NameIoT Service Management API Component Suite

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Product, Common, Resource, Service

Metadata Catalog Management API

Metadata Catalog

TMF725
@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF674-GeographicSite-v5.0.0.oas.yaml
NameGeographic Site Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/swaggeruser_guides/TMF725TMF674-MetadataCatalogGeographicSite-v4v5.0.0.swagger.jsonpdf
NameMetadata Catalog Geographic Site Management API

 



Show If
special@anonymous

Image Removed Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.5.0
v5 v4.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.

TMF92110-Jan-2022Common

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF628TMF921-PerformanceIntent-v4.0.0.swagger.json
NamePerformance Management APIIntent

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21 22.50.0
v4.0.0
2208-Nov-2021Service, Common06-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

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.10.0/swagger/TMF701TMF908-ProcessFlowIoTAgentAndDevice-v4.10.0.swagger.json
NameProcess Flow IoT Agent and Device Management API

 



Show If
special@anonymous



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF701TMF908_ProcessIoT_FlowDevice_Management_API_Component_Suite_user_guides_1921.5.0.1.pdf
NameProcess Flow IoT Agent and Device Management API

 



Show If
special@anonymous

Show If
special@authenticated
Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF701_Process_Flow_Management_API_conformance_19.0.1.pdf
NameProcess Flow Management API

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available
19.0.1
v4.1.0


Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Resource

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF914-IotService-v4.0.0.swagger.json
NameIoT Service Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://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
NameIoT Service Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Product, Common, Resource, Service

Metadata Catalog Management API

Metadata Catalog

TMF725


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF725-MetadataCatalog-v4.0.0.swagger.json
NameMetadata Catalog Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
v4.0.0
10-Jan-2022Common

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF669-PartyRole-v4.1.0.swagger.json
NameParty Role Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.1.0
08-06-2022Business 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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF628-Performance-v4.0.0.swagger.json
NamePerformance Management API

 



Show If
special@anonymous

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-2021Service, 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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF701-ProcessFlow-v4.1.0.swagger.json
NameProcess Flow Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://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
NameProcess Flow Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://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
NameProcess Flow Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available
19.0.1
v4.1.0
22-Nov-2021Common

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://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
NameProduct Catalog Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://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
NameProduct Catalog Management API

 



Show If
special@anonymous

Image Added


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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF637-ProductInventory-v5.0.0.oas.yaml
NameProduct Inventory Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF637-ProductInventory-v5.0.0.pdf
NameProduct Inventory Management API

 



Show If
special@anonymous

Image Added


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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF679-ProductOfferingQualification-v5.0.0.oas.yaml
NameProduct Offering Qualification Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF679-ProductOfferingQualification-v5.0.0.pdf
NameProduct Offering Qualification Management API

 



Show If
special@anonymous

Image Added


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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF622-ProductOrdering-v5.0.0.oas.yaml
NameProduct Ordering Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF622-ProductOrdering-v5.0.0.pdf
NameProduct Ordering Management API

 



Show If
special@anonymous

Image Added


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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF671-Promotion-v4.0.0.swagger.json
NamePromotion Management API

 



Show If
special@anonymous

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-2021Product

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF648-Quote-v5.0.0.oas.yaml
NameQuote Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF648-Quote-v5.0.0.pdf
NameQuote Management API

 



Show If
special@anonymous

Image Added


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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF680-Recommendation-v4.0.0.swagger.json
NameRecommendation Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://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
NameRecommendation Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF680_Recommendation_API_conformance_21.5.0.pdf
NameRecommendation Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Customer

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF702-ResourceActivation-v4.0.0.swagger.json
NameResource Activation Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://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
NameResource Activation Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF702_Resource_Activation_v4.0.0_conformance.pdf
NameResource Activation Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ctk/TMF702-ResourceActivation.zip
NameResource Activation Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ri/TMF702_Resource_activation.zip
NameResource Activation Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://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
NameResource Activation Management API

 



Show If
special@anonymous

Image Added


21.5.0
v4.0.0
22-Nov-2021Resource, 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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json
NameResource Function Activation and Configuration API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF664_Resource_Function_Activation_Management_API_REST_Specification_v4-0-0.pdf
NameResource Function Activation and Configuration API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.0.0
08-06-2022Resource, Common

Sales Management API

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.

TMF699


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF699-Sales-v4.1.0.swagger.json
NameSales Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF699_Sales_Management_API_REST_Specification_v4.1.0.pdf
NameSales Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.1.0
08-06-2022MarketingSales

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF640-Service_Activation_and_Configuration-v5.0.0.oas.yaml
NameService Activation Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-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
NameService Activation Management API

 



Show If
special@anonymous

Image Added


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.

TMF63322-Nov-2021Common

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF671-Promotion-v4.0.0.swagger.json
NamePromotion API

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Product

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
.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF633-Service_Catalog_Management-v5.0.0.oas.yaml
NameService Catalog Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/swagger/TMF680-Recommendation-v4.0.0.swagger.json
NameRecommendation API

 

user_guides/TMF633-Service_Catalog_Management-v5.0.0.pdf
NameService Catalog Management API

 



Show If
special@anonymous

Image Added


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@anonymous

Image Removed

Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://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
NameService Inventory Management NameRecommendation API

 



Show If
special@anonymous

Image Removed Image Added



Show If
special@authenticated
grouptmforum-members@authenticated


Trackinglink
TypeCTK-ConformanceSpecification PDF
LicenceRAND
Linkhttps://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
NameRecommendation Service Inventory Management API

 



Show If
special@anonymous

Image Added Image Removed


Not yet available Not yet available Not yet available Not yet available
21 22.5.0
v4 v5.0.0
Service

Service Ordering Management

22-Nov-2021Customer

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/swagger/TMF702TMF641-ResourceActivationServiceOrdering-v4v5.0.0.swaggeroas.jsonyaml
NameResource Activation and Configuration Service Ordering Management API

 



Show If
special@anonymous



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://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
NameResource Activation and Configuration Service Ordering Management API

 



Show If
special@anonymous


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@authenticated
Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF702_Resource_Activation_v4.0.0_conformance.pdf
NameResource Activation and Configuration API

 

Show If
special@anonymous@authenticated
Image Removed
group
show
tmforum-
ifspecial
members@authenticated


Trackinglink
TypeCTKSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/ctk/TMF702-ResourceActivation.zipswagger/TMF653-Service_Test_Management-v5.0.0.oas.yaml
NameService Test Management NameResource Activation and Configuration API

 



Show If
special@anonymous

Image Removed Image Added



Show If
special@authenticated
grouptmforum-members


 
Trackinglink
TypeRISpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/ri/TMF702_Resource_activation.zip
NameResource Activation and Configuration API
user_guides/TMF653-Service_Test_Management-v5.0.0.pdf
NameService Test Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
21.5.0
v5.0.0
10-Dec-2021Service

Service Usage Management API

TMF727


Image Removed
Show If
special@anonymous@authenticated
group
Show Ifspecial@authenticated
tmforum-members


Trackinglink
Type
Postman
Swagger
Licence
RAND
Apache 2.0
Linkhttps://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
NameService Usage Management
Resource Activation and Configuration
API

 



Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available Not yet available
22.0 21.5.0
v4.0.0
08-06-2022

Shipment Management

22-Nov-2021Resource, Common

Service Test Management API

Service Test Description

Shipment Management

TMF711TMF653


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.2.0/swagger/TMF653-ServiceTest-v4.2.0.swagger.json
NameService Test Management API

 

-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF711-ShipmentManagement-v4.0.0.swagger.json
NameShipment Management Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
v4.0.0
10-Jan-2022Business Partner

Shipping Order Management API

Provides the necessary functionality to create, update and query Shipping Orders. A Shipping Order is a document used by a business to specify what items are to be transferred from a storage location or warehouse to which person and to which new location. A ShippingOrder typically is sent along with a shipment of goods so that the person receiving them can verify that the document correctly reflects the items that they actually received.

TMF700


Show If
special
Show If
special@anonymous

Image Removed

Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.20.0/user_guides/TMF653_Service_Test_Management_API_REST_Specification_v4-2-0.pdfswagger/TMF700-ShippingOrder-v4.0.0.swagger.json
NameShipping Order NameService Test Management API

 



Show If
special@anonymous

Image Removed Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeCTK-ConformanceSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.20.0/conformance/TMF653_Service_Test_v4.2.0_conformanceuser_guides/TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0.pdf
NameService Test Shipping Order Management API

 



Show If
special@anonymous

Image Removed Image Added



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.20.0/ctk/TMF653-ServiceTest.zipconformance/TMF700_Shipping_Order_v4.0.0_conformance.pdf
NameService Test Shipping Order Management API

 



Show If
special@anonymous

Image Removed

Image Added


Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Business 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.

TMF623special@authenticated


Show If
special@authenticated
Trackinglink
TypeRI
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.2.0/ri/TMF653_ServiceTest.zip
NameService Test Management API

 

Show If
special@anonymous@authenticated
Image Removed
group
Show If
tmforum-members


Trackinglink
Type
Postman
Swagger
Licence
RAND
Apache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.
2
0.0/
postman
swagger/
TMF653
TMF623-
ServiceTest
SLA-v4.
2
0.0.
postman_collection
swagger.json
Name
Service Test
SLA Management API

 



show-
if
special@anonymous

Image Removed

if
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.0 21.5.0
v4.20.0
1008-Dec-202106-2022Business 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).

TMF621Service

Shipment Management API

Shipment Management

TMF711


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF711-ShipmentManagement-v4.0.0.swagger.json
NameShipment Management API

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available Not yet available
v4.0.0
10-Jan-2022Business Partner

Shipping Order Management API

Provides the necessary functionality to create, update and query Shipping Orders. A Shipping Order is a document used by a business to specify what items are to be transferred from a storage location or warehouse to which person and to which new location. A ShippingOrder typically is sent along with a shipment of goods so that the person receiving them can verify that the document correctly reflects the items that they actually received.

TMF700
.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF621-Trouble_Ticket-v5.0.0.oas.yaml
NameTrouble Ticket Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/swaggeruser_guides/TMF700TMF621-ShippingOrderTrouble_Ticket-v4v5.0.0.swagger.jsonpdf
NameShipping Order Trouble Ticket Management API

 



Show If
special@anonymous

Image Removed Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
21 22.5.0
v4 v5.0.0
22-Nov-2021Business PartnerCommon

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


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF677-UsageConsumption-v4.0.1.swagger.json
NameUsage Consumption Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Product

Work Order Management API

The Work Order API performs the following operations on a workOrder resource:

TMF697


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF697-WorkOrder-v4.0.0.swagger.json
NameWork Order Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
v4.0.0
22-Nov-2021Business Partner


...