Page History

...

Please note that Comments are no longer permitted on this page. If you have any questions regarding the content of the Open API Table please post them as discussion topics on the Open API Community Forum .

hidehtml-if

special	@authenticated

Note

title	To access the API table links below you will need to be logged in

To login with your TM Forum account please click on the Login button below

Button Hyperlink

title	Login
type	primary
url	https://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

Don't have an account? You can register by clicking here:

Button Hyperlink

title	Register
type	primary
url	https://www.tmforum.org/user-registration/
target	true

Dialog

id	login-required
title	Login Required

Section

Panel

borderStyle	none

To access the API documentation you need to be logged in to your TM Forum account

Button Hyperlink

title	Login
type	primary
url	https://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

Don't have an account? You can register by clicking here:

Button Hyperlink

title	Register
type	primary
url	https://www.tmforum.org/user-registration/
target	true

Dialog

id	members-only
title	For TM Forum Members

Section

Panel

borderStyle	none

Image Removed Thank you for your interest in this Early Adopter API.
We're sorry but the documentation is available to members only.
As a non-member, you are welcome to browse our Released TM Forum Open API documentation

Button Hyperlink

title	Browse Released APIs
type	primary
url	https://projects.tmforum.org/wiki/display/API/Open+API+Table#OpenAPITable-ReleasedTMForumOpenAPIs

Button Hyperlink

title	Find out more about Membership
type	standard
url	https://www.tmforum.org/membership/benefits/
target	true

TM Forum Open APIs

Pre-Production (Beta) Versions

Table Filter

sparkName	Sparkline
datepattern	yy-mm-dd
id	1583007004662_405528633
sort	Released TM Forum Open APIs (‍Asc)
isOR	AND
separator	Point (.)

TM Forum Open APIs

Pre-Production

_____________________________________

Document Number

Swagger

(Apache 2.0)

API User Guide

(RAND)

Conformance Profile

(RAND)

CTK

Reference Implementation Code

Postman Collection

Release

Lifecycle Status

Alarm Management API

The Alarm Management API applies lessons that were learned in previous generations of similar APIs that were implemented in the Telecommunication industry, starting from ITU recommendations,, TM Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment initiative between 3GPP and TM Forum interfaces, and the more recent ETSI work on requirements for NFV interfaces.

TMF642

Show If

special

@authenticated

match

all

bobswift

<style>.widget_list {
 margin: 0;
 padding: 0;
}
.widget_list li{
 margin: 0 0 20px;
 padding: 0;
 list-style:none;
}
.widget_list li a{
 display:block;
 color: #000 !important;
 font-weight: 600;
 padding: 10px;
 border:1px solid #ccc;
 background-color:#f6f6f6;
 padding: 25px 25px 25px 80px;
 position:relative;
}
.widget_list li a:hover {
 color: #133595 !important;
 text-decoration: none;
}
.widget_list li a img {
 max-width: 100% !important;
 height: auto !important;
}
.widget_list li a .confluence-embedded-file-wrapper {
 position: absolute;
 width: 50px !important;
 display: block !important;
 left: 10px;
 top: 50%;
 transform: translateY(-50%);
}</style><script src="//app-ab16.marketo.com/js/forms2/js/forms2.min.js"></script><form id="mktoForm_2355" style="display:none"></form><script>MktoForms2.loadForm("//app-ab16.marketo.com", "021-WLD-815", 2355);</script>

Hide If

special	@authenticated

Note

title	To access the API table links below you will need to be logged in

To login with your TM Forum account please click on the Login button below

Button Hyperlink

title	Login
type	primary
url	https://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

Don't have an account? You can register by clicking here:

Button Hyperlink

title	Register
type	primary
url	https://www.tmforum.org/user-registration/
target	true

Dialog

id	login-required
title	Login Required

Section

Panel

borderStyle	none

To access the API documentation you need to be logged in to your TM Forum account

Button Hyperlink

title	Login
type	primary
url	https://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

Don't have an account? You can register by clicking here:

Button Hyperlink

title	Register
type	primary
url	https://www.tmforum.org/user-registration/
target	true

Dialog

id	members-only
title	For TM Forum Members

Section

Panel

borderStyle	none

Image AddedThank you for your interest in this Early Adopter API.
We're sorry but the documentation is available to members only.
As a non-member, you are welcome to browse ourReleased TM Forum Open API documentation

Button Hyperlink

title	Browse Released APIs
type	primary
url	https://projects.tmforum.org/wiki/display/API/Open+API+Table#OpenAPITable-ReleasedTMForumOpenAPIs

Button Hyperlink

title	Find out more about Membership
type	standard
url	https://www.tmforum.org/membership/benefits/
target	true

TM Forum Open APIs

Early Adoption (Beta) Versions

Alarm

Table Filter

sparkName	Sparkline
datepattern	yy-mm-dd
id	1583007004662_405528633
sort	Released TM Forum Open APIs (‍Asc)
isOR	AND
separator	Point (.)

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

special	@anonymous

Image Added

Not yet available

21.5.0

v4.1.0

10-Jan-2022

Business Partner, Customer

Change Management API

The Change Management API provides the standard integration capabilities between external applications and Change Management Application

TMF655

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/TMF655-Change-v4.0.0.swagger.json
Name	Change Management API

Show If

special	@anonymous

Image Added

Not yet available

v4.0.0

10-Jan-2022

Common

Customer360 Management API

An API to give a consolidated Customer overview. This is a view-only API, based on the various underlying involved TM Forum Open APIs. This API provides references where one can find detailed information for: Account, Agreement, Appointment, CustomerBill, InteractionItem, LoyaltyBalance, ProductOrder, ProductValue, Promotion, Quote, ServiceProblem, TroubleTicket, UsageSpecification

TMF717

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/TMF717-Customer360-v4.0.0.swagger.json
Name	Customer360 Management API

Show If

special	@anonymous

Image Added

Not yet available

21.5.0

v4.0.0

05-Jan-2022

Customer

Digital Identity Management API.

Provides the ability to manage a digital identity. This digital identity allows identification of an individual, a resource, or a partyRole (a specific role - or set of roles - for a given individual). A digital identity is associated with credential / authentification method. These credential / authentification methods should be extensible to describe all types of authentification method such as login/password, biometric, token, etc. A contact medium is also associated with digital identity (or directly at credential level) to manage credential recovery UCs.

TMF720

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF720-DigitalIdentity-v4.0.0.swagger.json
Name	Digital Identity Management API.

Show If

special	@anonymous

Image Added

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	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF703-EntityInventory-v4.0.0.swagger.json
Name	Entity Inventory Management API

Show If

special	@anonymous

Image Added

Not yet available

21.5.0

v4.0.0

22-Nov-2021

Common

Event Management API

The Event Management API provides a standardized client interface to the enterprise event management system for creating, managing and receiving service related events to (indicatively) drive automation workflows, notify other service providers for service outages and SLA violations, trigger Trouble Ticket creation, and enable more complex orchestration scenarios between management systems. The Event Management API can also be used to convey business level Events in support of other processes.

TMF688

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF688-Event-v4.0.0.swagger.json
Name	Event Management API

Show If

special	@anonymous

Image Added

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

Image Added

Show If

special	@authenticated

Trackinglink

Type	CTK-Conformance
Licence	RAND
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF688_Event_Management_API_conformance_21.5.0.pdf
Name	Event Management API

Show If

special	@anonymous

Image Added

Not yet available

21.5.0

v4.0.0

22-Nov-2021

Common

Federated ID Management API

The management of principals of any kind (persons, objects, …) and their access to resources in an open environment which can span across different enterprise boundaries. It relies on authentication, authorization and consent mechanisms to protect privacy with a simple and easy user experience. Different parties can provide identity services (operators, social networks, GSMA, …).

TMF691

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF691-FederatedIdentity-v4.0.0.swagger.json
Name	Federated ID Management API

Show If

special	@anonymous

Image Added

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF691_Federated_Identity_API_user_guides_21.5.0.pdf
Name	Federated ID Management API

Show If

special	@anonymous

Image Added

Not yet available

21.5.0

v4.0.0

22-Nov-2021

Common

Geographic Location Management API

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

TMF675

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https:/

/github.com/tmforum-apis/TMF642_AlarmManagement

Name

/tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF675-GeographicLocation-v4.0.0.swagger.json
Name	Geographic Location Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Image Removed

	@anonymous

Image Added

Not yet available

21.5.0

v4.0.0

22-Nov-2021

Common

Intent

The Component Suite for Intent Management API defines the set of operations that should be offered to manage intent and intent-driven interactions in a consistent manner.

TMF921

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type

Specification PDF

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/134776981/TMF642_Alarm_Management_API_User_Guide_

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF921-Intent-v4.0.0.

pdf?api=v2

swagger.json
Name

Alarm Management API

Intent

Show If

special

@authenticated

@anonymous

matchNot Yet Available Not Yet Available Not Yet Available Not Yet Available

19.5.0

(

Image Added

allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not yet available

22.0.0

v4.0.0

)

Pre

08-06-

production

Communication API

Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users.

TMF681

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

match

all

group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/

tmforum-apis/TMF681_CommunicationNameCommunication

Beta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0.0.swagger.json
Name	IoT Agent and Device Management API

Show If

special

@authenticatedmatchall

	@anonymous

Image Added

Show If

group
special	@authenticated

not-TMF678

tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available

19.5.0

(v4.0.0)

Pre-production

Customer Bill Management API

This API allows operations to find and retrieve one or several customer bills (also called invoices) produced for a customer also allows operations to find and retrieve the details of applied customer billing rates presented on a customer bill.

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

Show If

special

@authenticated

@anonymous

match

Image Added

allgrouptmforum-members Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://github.com/tmforum-apis/TMF678_CustomerBill
Name	Customer Bill Management API

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

matchall

group

not-tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available

19.5.0

(v4.0.0)

Pre-production

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.

TMF688matchall

	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

@anonymous

Image Added

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type

Swagger

Specification PDF
Licence

Apache 2.0

RAND
Linkhttps://

github.com/tmforum-apis/TMF688-EventNameEvent management

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

Show If

special

@authenticatedmatchallgroupnot-tmforum-members19

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available

@anonymous

Image Added

Not yet available

21.5.0

(

v4.0.0

)Pre-production

Geographic Location Management API

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

TMF675

22-Nov-2021

Product, Common, Resource, Service

Metadata Catalog Management API

Metadata Catalog

TMF725

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https:/

/github.com/tmforum-apis/TMF675_GeographicLocationNameGeographic Location

/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

Show If

special

@authenticatedmatchall

19.5.0

(

groupnot-tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available

@anonymous

Image Added

Not yet available

v4.0.0

)

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

Pre-production

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

matchall

group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/

tmforum-apis/TMF674_GeographicSiteNameGeographic Site

Beta/4.1.0/swagger/TMF669-PartyRole-v4.1.0.swagger.json
Name	Party Role Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

	@anonymous

Image Added

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

matchall

group	tmforum-members

Trackinglink

Type

Specification PDFLinkhttps://projects.tmforum.org/wiki/download/attachments/134776996/TMF674_Geographic_Site_Management_API_User_Guide_

Swagger
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.

pdf?api=v2

swagger.json
Name

Geographic Site

Performance Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 19

Image Added

Not yet available

21.5.0

(

v4.0.0

)TMF683

Pre-production

Party Interaction Management API

A User Interaction captures information about past interactions in order to re-use it in future ones. This allows agents to serve users better by knowing the steps they went through. It also allows customers to see better the actions they have performed and how they interacted with us.

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

match

all

group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2

.0Linkhttps://github.com/tmforum-apis/TMF683_PartyInteractionNameParty Interaction

.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

@authenticatedmatchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

@anonymous

Image Added

Show If

special

@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available

19.5.0

(4.0.0)

Pre-production

Payment Management API

The Payments API provides the standardized client interface to Payment Systems for notifying about performed payments or refunds. Examples of Payment API originators (clients) include Web servers, mobile app servers, Contact center dashboards or retail store systems.

TMF676

@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

special

@authenticated

@anonymous

match

Image Added

all

Show If

group

special

tmforum-members

@authenticated

Trackinglink

Type

Swagger

CTK-Conformance
Licence

Apache 2.0Linkhttps://github.com/tmforum-apis/TMF676_PaymentManagementNamePayment

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

Show If

special

@authenticated Show Ifspecial

matchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available

19.5.0

(4.0.0)

Pre-production

Prepay Balance Management API

REST API for Balance Management. It includes the model definition as well as all available operations for prepay balance management. Prepaid subscribers pay fees before using services. Therefore, the subscribers must have sufficient balances. Operators can provide multiple recharge channels for subscribers. Subscribers can pass credit between different subscriptions, therefore transferring the balance from one account to another.

TMF654

Image Added

Not yet available

19.0.1

v4.1.0

22-Nov-2021

Common

Promotion Management API

Used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit

TMF671

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/

tmforum-apis/TMF654_PrepayBalanceManagementNamePrepay Balance Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Open API Table - Pre-production (Beta)

Beta/4.0.0/swagger/TMF671-Promotion-v4.0.0.swagger.json
Name	Promotion Management API

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Image Added

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

20

21.

0

5.0

(4

v4.0.0

)

Privacy Management API

The Privacy management API provides a standardized mechanism for privacy profile types, privacy profiles and privacy agreements such as creation, update, retrieval, deletion and notification of events.

TMF644

Pre-production

22-Nov-2021

Product

Recommendation Management API

Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omnichannel.

TMF680

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Licence
Type	Swagger

RANDLinkhttps://projects.tmforum.org/wiki/download/attachments/123090132/TMF644_Privacy-4

Apache 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

?version=1&modificationDate=1573117743866&api=v2

Name

Privacy

Recommendation Management API

Show If

special	@anonymous

Image Removed

Image Added

Show If

special

@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available

19.5.0

(4.0.0)

Pre-production

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

@authenticated
group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF680_Recommendation_API_user_guides_21.5.0.pdf
Name	Recommendation Management API

Show If

special

@authenticated

@anonymous

match

Image Added

all

Show If

group

special

tmforum-members

@authenticated

Trackinglink

Type

Swagger

CTK-Conformance
Licence

Apache 2.0

RAND
Linkhttps://

github.com/tmforum-apis

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF680_Recommendation_API_conformance_21.5.0.pdf
Name	Recommendation Management API

Show If

special

@authenticatedmatchallgroup

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Show If

special	@authenticated
match	all
group	tmforum-members

Trackinglink

Type	Specification PDF
Link	https://projects.tmforum.org/wiki/download/attachments/134777000/TMF680_Recommendation_Management_API_User_Guide_v4.0.0.pdf?api=v2
Name	Recommendation API

not-tmforum-members

Open API Table - Pre-production (Beta)

@anonymous

Image Added

Not yet available

21.5.0

v4.0.0

22-Nov-2021

Customer

Resource Activation Management API

The Resource Activation and Configuration API can be used to query resource instances to acquire the resource activation states and attributes, and it can be used to create/update, configure and activate the resource instances.

TMF702

Show If

special	@authenticated

match

all

group

not-

19.5.0

(

tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available

 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

)Pre-production

Resource Activation and Configuration API

The Resource Activation and Configuration API can be used to query resource instances to acquire the resource activation states and attributes, and it can be used to create/update, configure and activate the resource instances.

TMF702matchall

.swagger.json
Name	Resource Activation Management API

Show If

special

@authenticated

@anonymous

Image Added

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type

Swagger

Specification PDF
Licence

Apache 2.0

RAND
Linkhttps://

github.com/tmforum-apis/TMF702-ResourceActivationConfiguration

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 

& Configuration

Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available

19.5.0

(v4.0.0)

Pre-production

Resource Catalog Management API

The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering process.

TMF634

	@anonymous

Image Added

Show If

special	@authenticated

Trackinglink

Type	CTK-Conformance
Licence	RAND
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF702_Resource_Activation_v4.0.0_conformance.pdf
Name	Resource Activation Management API

Show If

special

@authenticated

@anonymous

match

Image Added

all

Show If

group

special

tmforum-members

@authenticated

Trackinglink

Type

Swagger

CTK
Licence

Apache 2.0

RAND
Linkhttps://

github

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/

tmforum-apis/TMF634_ResourceCatalog

Beta/4.0.0/ctk/TMF702-ResourceActivation.zip
NameResource 

Catalog API

Activation Management API

Show If

special	@anonymous

Image Added

Show If

special	@authenticated

matchallgroupnot-tmforum-membersOpen API Table - Pre-production (Beta)

Trackinglink

Type	RI
Licence	RAND
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ri/TMF702_Resource_activation.zip
Name	Resource Activation Management API

Show If

special	@anonymous

Image Removed

Image Added

Show If

special	@authenticated

matchallgrouptmforum-members

Trackinglink

Type

Specification PDF

Postman
LicenceRAND
Linkhttps://

projects.tmforum.org/wiki/download/attachments/134776967/TMF634_Resource_Catalog_Management_API_User_Guide_v4.0.0.pdf?api=v2NameResource Catalog API

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/postman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zip
Name	Resource Activation Management API

Show If

special	@anonymous

Image Added

21.5.0

v4.0.0

22-Nov-2021

Resource, Common

Resource Function Activation and Configuration API

This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function

TMF664

Show If

special	@authenticated

matchall

group

not-TMF664

tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available

19.5.0

(v4.0.0)

Pre-production

Resource Function Activation and Configuration API

This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json
Name	Resource Function Activation and Configuration API

Show If

special

@authenticatedmatchall

	@anonymous

Image Added

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type

Swagger

Specification PDF
Licence

Apache 2.0

RAND
Linkhttps://

github.com/tmforum-apis/TMF664_ResourceFunctionActivationConfiguration

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF664_Resource_Function_Activation_Management_API_REST_Specification_v4-0-0.pdf
Name	Resource Function Activation and Configuration API

Show If

special

@authenticatedmatchallgroup

not-tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Show If

special	@authenticated
match	all
group	tmforum-members

Trackinglink

Type	Specification PDF
Link	https://projects.tmforum.org/wiki/download/attachments/134776992/TMF664_Resource_Function_Activation_and_Configuration_API_User_Guide_v4.0.0.pdf?api=v2
Name	Resource Function Activation and Configuration API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Open API Table - Pre-production (Beta)

@anonymous

Image Added

Not yet available

22.0.0

v4.0.0

08-06-2022

Resource, 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

@anonymous

group

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available

19.5.0

(v4.0.0)

Pre-production

Resource Inventory Management API

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

TMF639

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/TMF699-Sales-v4.1.0.swagger.json
Name	Sales Management API

Show If

special	@anonymous

Image Added

Show If

special	@authenticated

match

all

group	tmforum-members

Trackinglink

Type

Swagger

Specification PDF
Licence

Apache 2.0

RAND
Linkhttps:/

/github.com/tmforum-apis/TMF639_ResourceInventoryNameResource Inventory

/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
Name	Sales Management API

Show If

special

@authenticatedmatch Show Ifspecial

allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

@anonymous

Image Removed

Image Added

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available Not Yet Available

yet available

Not

Yet Available

yet available

19

22.

5

0.0

(

v4.

0

1.0

)

Pre

08-06-

production

Resource Ordering Management API

The REST API for Resource Order Management. It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Resource Orders (including filtering). A Resource Order API provides a standard mechanism for placing a Resource Order with all necessary order parameters.

TMF652

2022

MarketingSales

Service Usage Management API

TMF727

Show If

special	@authenticated

matchall


group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com

/tmforum-apis/TMF652_ResourceOrderManagementNameResource Order Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Open API Table - Pre-production (Beta)

/Beta/4.0.0/swagger/TMF727-ServiceUsage-v4.0.0.swagger.json
Name	Service Usage Management API

Show If

special	@anonymous

Image Removed

Image Added

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

19

22.

5

0.0

(

v4

.0.0)Pre-production

Service Activation and Configuration API

The REST API for Service Activation and Configuration allows the user to retrieve, create, update, delete services and retrieve the monitor resource used to monitor the execution of asynchronous requests on a specific resource. .

TMF640

.0.0

08-06-2022

Shipment Management Management API

Shipment Management

TMF711

Show If

special	@authenticated

matchall


group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github.com/tmforum-apis/TMF640_ActivationConfigurationNameService Activation & Configuration API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Open API Table - Pre-production (Beta)

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF711-ShipmentManagement-v4.0.0.swagger.json
Name	Shipment Management Management API

Show If

special	@anonymous

Image Removed

Image Added

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

20.0.0

(

yet available

v4.0.0

)

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://github.com/tmforum-apis/TMF638_ServiceInventory
Name	Service Inventory Management API

Pre-production

Service Inventory Management API

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

TMF638 Show If

special	@authenticated
match	all
group	tmforum-members

10-Jan-2022

Business Partner

Shipping Order Management API

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

TMF700

Show If

special	@authenticated

matchall

group

not-

tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available

20.0.0

(v4.0.0)

Pre-production

Service Ordering Management API

The REST API for Service Order Management provides a standardized mechanism for placing a service order with all of the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications.

TMF641matchall

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/TMF700-ShippingOrder-v4.0.0.swagger.json
Name	Shipping Order Management API

Show If

special

@authenticated

@anonymous

Image Added

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type

Swagger

Specification PDF
Licence

Apache 2.0Linkhttps://github.com/tmforum-apis/TMF641_ServiceOrder/tree/masterNameService Ordering Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Open API Table - Pre-production (Beta)

	RAND
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0.pdf
Name	Shipping Order Management API

Show If

special	@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available

20.0.0

(

Image Added

Show If

special	@authenticated

Trackinglink

Type	CTK-Conformance
Licence	RAND
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF700_Shipping_Order_v4.0.0

)Pre-production

Service Quality Management API

Through this API, any Enterprise is able to access a Service Quality Management application and extract Service Level Specifications and associated Service Level Objectives (SLO) and their thresholds.

TMF657

_conformance.pdf
Name	Shipping Order Management API

Show If

special

@authenticated

@anonymous

match

Image Added

allgrouptmforum-members Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://github.com/tmforum-apis/TMF657_ServiceQualityManagement
Name	Service Quality Management API

Not yet available

21.5.0

v4.0.0

22-Nov-2021

Business Partner

SLA Management API

Provides a standardized interface for Service Level Agreement (SLA) life-cycle Management (SLA Negotiation, SLA configuration SLA Activation/enforcement, SLA Operations, SLA violation / consequence handling, SLA reporting) between a Customer and a Service Provider which provides offers (product with attached SLA in its catalogue) the customer can discover, browse, trigger and order.

TMF623

Show If

special	@authenticated

matchall

group

not-

tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Show If

special	@authenticated
match	all
group	tmforum-members

TrackinglinkTypeSpecification PDFLinkhttps://projects.tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_API_User_Guide_

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/TMF623-SLA-v4.0.0.

pdf?api=v2

swagger.json
Name

Service Quality Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Open API Table - Pre-production (Beta)

19.5.0

(

SLA Management API

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available

Image Added

Not yet available

22.0.0

v4.0.0

)Service Test

Pre-production

08-06-2022	Business Partner
Usage Consumption Management API

TMF653

The Service Test API provides a standardized mechanism for placing a service test with all of the necessary test parameters. The API consists of a simple set of operations that interact with CRM/Service Management systems in a consistent manner. A service test is a procedure intended to check the quality, performance, or reliability of a service.

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

matchall


group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com

/tmforum-apis/TMF653_ServiceTestManagementNameService Test Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Open API Table - Pre-production (Beta)

/Beta/4.0.0/swagger/TMF677-UsageConsumption-v4.0.1.swagger.json
Name	Usage Consumption Management API

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Image Added

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

20

21.

0

5.0

(

v4.0.0

)Pre-production

User Roles & Permissions API

A user role is defined as the entity that defines a set of privileges covering various functions and/or manageable assets. When a user is assigned a given role then it is actually allocated all the privileges defined for that role type and the corresponding permissions are created for that user.

TMF672

22-Nov-2021

Product

Work Order Management API

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

TMF697

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Licence
Type	Swagger

Apache 2.0Linkhttps://github.com/tmforum-apis/TMF672_UserRolesPermissionsNameUser Roles & Permissions

	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF697-WorkOrder-v4.0.0.swagger.json
Name	Work Order Management API

Show If

special

@authenticatedNot Yet Available Not Yet Available

19.5.0

(

matchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

Show If

special	@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available

@anonymous

Image Added

Not yet available

v4.0.0

)

Pre-production

Space shortcuts

Page tree

Versions Compared

Old Version 13

New Version 136

Key

TM Forum Open APIs

Pre-Production (Beta) Versions

TM Forum Open APIs

Early Adoption (Beta) Versions