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 .

...

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

...

id	login-required
title	Login Required

...

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

...

id	members-only
title	For TM Forum Members

...

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

Early Adoption (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

Sample Implementation Code

Postman Collection

Release

Lifecycle Status

Alarm Management API

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

TMF642

Show If

special

@authenticated

match

all

Html-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

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

Async Trouble Ticket API

Async API Enabled for Trouble Ticket, Async API conpect supporting the event-based architecture

TMF925

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/TMF925-TroubleTicket-v4.0.0.asyncapi.yml
Name	Async Trouble Ticket API

Show If

special	@anonymous

Image Added

Not yet available

22.5.0

v4.0.0

Common

Change Management API

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

TMF655

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

DCS 5GSlice Service Activation API

Domain Context Specialization of TMF640 for 5G Service Slice, Swagger of Contract is strongly bound to the GSMA Service Definition

TMF924

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF924-dcs-5gslice-sa-swagger.json
Name	DCS 5GSlice Service Activation API

Show If

special	@anonymous

Image Added

Not yet available

22.5.0

v4.0.0

Service

Digital Identity Management API.

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

TMF720

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
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

Dunning Case Management

No description available yet

TMF728

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/TMF728-DunningCase-v4.0.0.swagger.json
Name	Dunning Case Management

Show If

special	@anonymous

Image Added

Not yet available

22.5.0

v4.0.0

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

Image Added

Not yet available

21.5.0

v4.0.0

22-Nov-2021

Common

Geographic Site Management API

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

TMF674

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF674-GeographicSite-v5.0.0.oas.yaml
Name	Geographic Site 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/5.0.0/user_guides/TMF674-GeographicSite-v5.0.0.pdf
Name	Geographic Site Management API

Show If

special	@anonymous

Image Added

Not yet available

22.5.0

v5.0.0

Common

Intent

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

TMF921

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF921-Intent-v4.0.2.swagger.json
Name	Intent

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/TMF921_Intent_Management_API_REST_Specification_v4-0-0v3.pdf
Name	Intent

Show If

special	@anonymous

Image Added

Not yet available

22.0.0

v4.0.0

08-06-2022

IoT Agent and Device Management API

In addition to including established TM Forum Open APIs, such as alarm management, resource management and activation APIs, the IoT Device Management API Component Suite also includes an IoT Data Access Endpoint API. This API allows for IoT data access using different types of protocols (MQTT IoT, CoAP, etc.). It encapsulates the protocols and allows devices to be easily integrated into solutions that support a host of IoT initiatives, including smart cities, smart factories and other vertical markets.

TMF908

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0.0.swagger.json
Name	IoT Agent and Device Management API

Show If

special	@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/TMF908_IoT_Device_Management_API_Component_Suite_user_guides_21.5.0.pdf
Name	IoT Agent and Device Management API

Show If

special	@anonymous

Image Added

Not yet available

21.5.0

v4.0.0

22-Nov-2021

Resource

IoT Service Management API

The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale.

TMF914

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github.com/tmforum-apis/TMF642_AlarmManagement

Name

Alarm Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

Show If

special	@authenticated
match	all
group	tmforum-members

TrackinglinkTypeSpecification PDFLinkhttps://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/TMF914-IotService-v4.0.0

.pdf?api=v2

.swagger.json
Name

Alarm

IoT Service Management API

Show If

special

@authenticatedmatch

allgroupnot-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

Not Yet Available

Not Yet Available Not Yet Available

@anonymous

Image Added

Show If

special	@authenticated

match

all

group	tmforum-members

Trackinglink

Type

PostmanLicenceRANDLinkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF642-Alarm-v4-Postman.zip?api=v2NameAlarm

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

Show If

special

@authenticated

@anonymous

match

Image Removed

Show If

special	@anonymous

Image Removed

19

Image Added

allgroupnot-tmforum-members

Not yet available

21.5.0

(

v4.0.0

)

Entity Catalog Management API

The entity catalog is intended to provide any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. The API provides management of the entity specifications and their associations thru CRUD operations.

TMF662

Pre-production

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

LicenceApache 2.0Linkhttps://github.com/tmforum-apis/TMF662_EntityCatalogNameEntity

Image Removed

Show Ifspecial


Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF725-MetadataCatalog-v4.0.0.swagger.json
Name	Metadata Catalog Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

@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.5.0

(

yet available

v4.0.0

)

Pre-productionEntity Inventory

10-Jan-2022

Common

Network as a Service Management API

The

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

The Entity Inventory API can be used to query the Entity and Association instances.

The Entity Inventory API can be called by an order management system to create new Entity/Association instances or update existing Entity/Association instances in the Entity Inventory.

TMF703

API Component Suite supports of a set of Operational Domains exposing and managing “Network” Services. These services are referred to as Network as a Service (NaaS) and include all services offered from a service provider including connectivity, end points, media services, etc.

TMF909

Show If

special	@authenticated

matchall


group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github.com/tmforum-apis/TMF703_EntityInventoryNameEntity Inventory Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

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

20.5.0

(v4.0.0)

Pre-production

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

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.2.0/swagger/TMF909-NetworkasaService-v4.2.0.swagger.json
Name	Network as a Service Management 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/TMF688-EventNameEvent management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.2.0/user_guides/TMF909_Network_as_a_Service_Management_API_REST_Specification_v4-2-0.pdf
Name	Network as a Service 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 Not Yet Available 19

yet available

18.5.

0

1

(

v4.

0

2.0

)Pre-production

Federated Identity API

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

TMF691

Common, Product, Service

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

LicenceApache 2.0Linkhttps://github.com/tmforum-apis/TMF691_FederatedIdentityNameFederated Identity


Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF669-PartyRole-v4.1.0.swagger.json
Name	Party Role Management API

Show If

special

@authenticated

Image Removed

Show Ifspecial

matchallgroupnot-tmforum-members

@anonymous

Image Removed

Image Added

Show If

special	@authenticated

matchall


group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://

projects.tmforum.org/wiki/download/attachments/134792909/TMF691_Federated_ID

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF669_Party_Role_Management_API_

User

REST_

Guide

Specification_v4.

0

1.0.pdf

?api=v2

Name

Federated Identity

Party Role Management API

Show If

special

@authenticatedmatchallgroup

Image Removed

Show Ifspecial

not-tmforum-members

@anonymous

Image Removed

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

20.0.0

(v4.0.0)

Pre-productionGeneral Test Artifact Management APITMF710Not Yet Available

Image Added

Show If

special	@authenticated

match

Trackinglink

all

Type

grouptmforum

CTK-

members

Conformance

trackinglink

Licence

Type

RAND

Specification PDF

Link	https://

projects.tmforum.org/wiki/download/attachments/146293816/TMF710_General_Test_Artifact_Management_API_User_Guide_v4.0.pdf?api=v2NameGeneral Test Artifact Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/conformance/TMF669_Party_Role_v4.1.0_conformance.pdf
Name	Party Role Management API

Show If

special	@anonymous

Image Removed

Image Added

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available Not Yet Available 20.5

yet available

22.0.0

(

v4.

0

1.0

)TMF673

Pre-production

Geographic Address Management API

Provides a standardized client interface to an Address management system. It allows looking for worldwide addresses. It can also be used to validate geographic address data, to be sure that it corresponds to a real geographic address. Finally, it can be used to look for a geographic address by: searching an area as a start (city, town ...), then zooming on the streets of this area, and finally listing all the street segments (numbers) in a street.

08-06-2022

Business Partner

Payment Method Management API

This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer.

TMF670

Show If

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/TMF673_GeographicAddressNameGeographic Address

Beta/4.1.0/swagger/TMF670-PaymentMethod-v4.1.0.swagger.json
Name	Payment Method Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

	@anonymous

Image Added

Not yet available

21.5.0

v4.1.0

22-Nov-2021

Customer

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 PDF

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/134792893/TMF673_Geographic_Address_Management_API_User_Guide_

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 Address

Performance Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

@anonymous

Image Added

Not yet available

21.5.0

v4.0.0

22-Nov-2021

Service, Common

Process Flow Management API

The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:

TMF701

Show If

special	@authenticated

matchall


group	tmforum-members

Trackinglink

Type

CTK-Conformance

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/146293800/TMF673B_Geographic_Address_API%20Conformance_Profile_v4.0.0.pdf?api=v2NameGeographic Address

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

@authenticatedmatchall

	@anonymous

Image Added

Show If

group
special	@authenticated

not-

tmforum-members

Image Removed

Geographic Location Management API

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

TMF675

Trackinglink

Show If

special	@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available

20.5.0

(v4.0.0)

Pre-production

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/TMF675_GeographicLocationNameGeographic Location

	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

Image Removed

Show Ifspecial

matchallgroupnot-tmforum-members

@anonymous

Image Removed

Image Added

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available Not Yet Available Not Yet Available

yet available

19.

5

0.

0

1

(

v4.

0

1.0

)TMF908

Pre-production

IoT Device Management API Component Suite

In addition to including established TM Forum Open APIs, such as alarm management, resource management and activation APIs, the IoT Device Management API Component Suite also includes an IoT Data Access Endpoint API. This API allows for IoT data access using different types of protocols (MQTT IoT, CoAP, etc.). It encapsulates the protocols and allows devices to be easily integrated into solutions that support a host of IoT initiatives, including smart cities, smart factories and other vertical markets.

22-Nov-2021

Common

Product Catalog Management API

Provides a standardized solution for rapidly adding partners’ products to an existing Catalog. It brings the capability for Service Providers to directly feed partners systems with the technical description of the products they propose to them.

TMF620

Show If

special	@authenticated

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/TMF908_IoTAgentAndDeviceComponentSuiteNameIot Agent and Device API Suite

Beta/5.0.0/swagger/TMF620-Product_Catalog_Management-v5.0.0.oas.yaml
Name	Product Catalog Management API

Show If

special

@authenticated

Image Removed

Show Ifspecial

matchallgroupnot-tmforum-members

@anonymous

Image Removed

Image Added

Show If

special	@authenticated

match

all

group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://

projects.tmforum.org/wiki/download/attachments/123085401/TMF908_IoT_Agent_and_Device_Component_Suite_REST_Specification_v1.0.1.pdf?version=1&modificationDate=1592864314038&api=v2NameIot Agent and Device API Suite

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF620-Product_Catalog_Management-v5.0.0.pdf
Name	Product Catalog Management API

Show If

special	@anonymous

Image Added

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

matchall

group

not-

tmforum-members

Image Removed

IoT Service Management API Component Suite

The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale.

TMF914

Trackinglink

Show If

special	@anonymous

Image Removed

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

19.0.0

(v4.0.0)

Pre-production

Type	Swagger
Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF637-ProductInventory-v5.0.0.oas.yaml
Name	Product Inventory Management API

Show If

special

@authenticatedmatchall

	@anonymous

Image Added

Show If

special	@authenticated
group	tmforum-members

Trackinglink

Type

Swagger

Specification PDF
Licence

Apache 2.0

RAND
Linkhttps://

github

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

/tmforum-apis/TMF914_IoTServiceComponentSuiteNameIoT Service Management API Suite

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

/Beta/5.0.0/user_guides/TMF637-ProductInventory-v5.0.0.pdf
Name	Product Inventory Management API

Show If

special

@authenticated

@anonymous

match

Image Added

allgrouptmforum-members Trackinglink

Type	Specification PDF
Link	https://projects.tmforum.org/wiki/download/attachments/143531023/TMF914_IOT_Service_Management_API_User_Guide_v4.0.0.pdf?api=v2
Name	IoT Service Management API Suite

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

matchall

group

not-

tmforum-members

Image Removed

Trackinglink

show-if

Type

special

Swagger

@anonymous

Image Removed

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

20.5.0

(v4.0.0)

Performance Management API

Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance.

TMF628

Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF679-ProductOfferingQualification-v5.0.0.oas.yaml
Name	Product Offering Qualification Management API

Show If

special	@anonymous

Image Added

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type

SwaggerLicenceApache 2.0Linkhttps://github.com/tmforum-apis/TMF628_PerformanceNamePerformance

Image Removed

Show Ifspecial

	Specification PDF
Licence	RAND
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF679-ProductOfferingQualification-v5.0.0.pdf
Name	Product Offering Qualification Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

@anonymous

Image Removed

Image Added

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available Not Yet Available 20

yet available

22.5.0

(v4

v5.0.0

)

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

Pre-producion

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

matchall


group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github.com/tmforum-apis/TMF680_RecommendationNameRecommendation API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

Show If

special	@authenticated
match	all
group	tmforum-members

TrackinglinkTypeSpecification PDFLinkhttps://projects.tmforum.org/wiki/download/attachments/134777000/TMF680_Recommendation_Management_API_User_Guide_v4.0.0.pdf?api=v2NameRecommendation

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF622-ProductOrdering-v5.0.0.oas.yaml
Name	Product Ordering Management API

Show If

special

@authenticated

Image Removed

@anonymous

matchallgroupnot-tmforum-members

Image Added

Show If

special

@anonymous

@authenticated

Image Removed

group

show

tmforum-

if

members

Trackinglink

special

Type

@authenticated

Specification PDF

match

Licence

all

RAND

grouptmforum-members TrackinglinkTypeCTK-ConformanceLinkhttps://projects.tmforum.org/wiki/download/attachments/146293804/TMF680B_Recommendation_Conformance_Profile_v4

Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF622-ProductOrdering-v5.0.0.pdf

?api=v2

Name

Recommendation

Product Ordering Management API

Show If

special

@authenticated

Image Removed

Show If

special	@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available 20

@anonymous

matchallgroupnot-tmforum-members

Image Added

Not yet available

22.5.0

(v4

v5.0.0

)Pre-production

Resource Activation and Configuration API

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

TMF702

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

matchall


group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github.com/tmforum-apis/TMF702-ResourceActivationConfigurationNameResource Activation & Configuration API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

Show If

special	@authenticated
match	all
group	tmforum-members

TrackinglinkTypeSpecification PDFLinkhttps://projects.tmforum.org/wiki/download/attachments/134792913/TMF702_Resource_Activation_Management_API_User_Guide_

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

pdf?api=v2

swagger.json
Name

Resource Activation & Configuration

Promotion Management API

Show If

special

@authenticated

Image Removed

Show If

special	@anonymous

Image Removed

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

@anonymous

matchallgroupnot-tmforum-members

Image Added

Not yet available

21.5.0

(

v4.0.0

)

Pre-productionResource Catalog

22-Nov-2021

Product

Quote 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

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

matchall

group	tmforum-members

Trackinglink

Type	Swagger

LicenceApache 2.0Linkhttps://github.com/tmforum-apis/TMF634_ResourceCatalogNameResource Catalog

Image Removed

Show Ifspecial


Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF648-Quote-v5.0.0.oas.yaml
Name	Quote Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

@anonymous

Image Removed

Image Added

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://

projects.tmforum.org/wiki/download/attachments/154174119/TMF634_Resource_Catalog_Management_API_User_Guide_v4.1.0.pdf?api=v2NameResource Catalog

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF648-Quote-v5.0.0.pdf
Name	Quote Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

	@anonymous

Image Added

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

matchall


group	tmforum-members

Trackinglink

Type

CTK-Conformance

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/154174131/TMF634B_Resource_Catalog_v4.1.0_conformance.pdf?api=v2NameResource Catalog matchall

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

Show If

special

@authenticated

@anonymous

Image Added

Show If

group
special	@authenticated

not-

tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

Not Yet Available Not Yet Available

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

Postman

CTK-Conformance
LicenceRAND
Linkhttps://

projects.tmforum.org/wiki/download/attachments/143534323/TMF634-ResourceCatalog-v4-Postman.zip?api=v2NameResource Catalog API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

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

Image Removed

19

Image Added

Not yet available

21.5.0

(

v4.

1

0.0

)

Pre-production

22-Nov-2021

Customer

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

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https://

github.com/tmforum-apis/TMF664_ResourceFunctionActivationConfigurationNameResource Function Activation and Configuration API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json
Name	Resource Function Activation and Configuration API

Show If

special	@anonymous

Image Removed

Image Added

Show If

special	@authenticated

match

all

group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://

projects.tmforum.org/wiki/download/attachments/134776992/

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF664_Resource_Function_Activation_

and_Configuration

Management_API_

User

REST_

Guide

Specification_v4

.

-0

.

-0.pdf

?api=v2


Name	Resource Function Activation and Configuration API

Show If

special

@authenticated

Image Removed

Show Ifspecial

matchallgroupnot-tmforum-members

@anonymous

Image Modified

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

08-06-

production

2022

Resource

Ordering

, Common

Sales Management API

The

REST

Sales Management 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

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

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/TMF652_ResourceOrderManagement Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

Beta/4.1.0/swagger/TMF699-Sales-v4.1.0.swagger.json
Name

Resource Order Management API

Sales Management API

Show If

special	@anonymous

Image Removed

Image Added

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://

projects.tmforum.org/wiki/download/attachments/143532439/TMF652_Resource_Order_

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF699_Sales_Management_API_

User

REST_

Guide

Specification_v4.

0

1.0.pdf

?api=v2

Name

Resource Order

Image Removed

Show Ifspecial

Sales Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

@anonymous

Image Modified

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

1.0

)

Pre-productionRisk

08-06-2022

MarketingSales

Service Activation Management API

The

Risk Management API allows the retrieval of Risk Assessments during interaction with PartyRoles (individualsor organizations) typically engaged in an Order process from ProviderPartyRole. The Risk Assessment request is usually issued by the ProviderPartyRole (e.g. Service Provider). The resources used to retrieve these assessment are Task resources, as per the Open API guidelines for tasks.TMF696

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

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/TMF696_RiskManagementNameRisk Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

/Beta/5.0.0/swagger/TMF640-Service_Activation_and_Configuration-v5.0.0.oas.yaml
Name	Service Activation Management API

Show If

special	@anonymous

Image Removed

Image Added

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://

projects.tmforum.org/wiki/download/attachments/146293808/TMF696_Risk_Management_API_User_Guide_v4

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

?api=v2 Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

Name

Risk Management API

Service Activation Management API

Show If

special	@anonymous

Image Modified

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

20

22.5.0

Pre-production

v5.0.0

Common, Service

Service Catalog Management API

The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.

TMF633

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

/Beta/5.0.0/swagger/TMF633-Service_

ServiceCatalogNameService

Catalog_Management

API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

-v5.0.0.oas.yaml
Name	Service Catalog Management API

Show If

special	@anonymous

Image Removed

Image Added

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://

projects.tmforum.org/wiki/download/attachments/154174093/TMF633_

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF633-Service_Catalog_Management

_API_User_Guide_v4-0-

-v5.0.0.pdf

?api=v2


Name	Service Catalog Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

Not Yet Available

@anonymous

Image Added

Not yet available

22.5.0

v5.0.0

Service

Service Inventory Management API

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

TMF638

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type

CTK

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/143532500/TMF633-ServiceCatalog-v4

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF638-Service_Inventory_Management-v5.0.0.

zip?api=v2

oas.yaml
NameService 

Catalog

Inventory Management API

Show Ifspecial@authenticatedmatchallgroup

Image Removed

not-tmforum-members

 Show If
special

@anonymous

Image Removed

Not Yet Available Not Yet Available

20.5.0

(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

	@anonymous

Image Added

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type

Swagger

Specification PDF
Licence

Apache 2.0

RAND
Linkhttps://

github

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

/tmforum-apis/TMF657_ServiceQualityManagement

/Beta/5.0.0/user_guides/TMF638-Service_Inventory_Management-v5.0.0.pdf
NameService 

Quality

Image Removed

Show If

special	@anonymous

Image Removed

Inventory Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

@anonymous

Image Added

Not yet available

22.5.0

v5.0.0

Service

Service Ordering Management API

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

TMF641

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type

Specification PDF

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_API_User_Guide_v4

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF641-ServiceOrdering-v5.0.0.

pdf?api=v2

oas.yaml
NameService 

Quality

Ordering Management API

Show Ifspecial@authenticatedmatchall

Image Removed

groupnot-tmforum-members

 Show If
special@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available

Image Added

Show If

special	@authenticated

match

all

group	tmforum-members

Trackinglink

Type

Postman

Specification PDF
LicenceRAND
Linkhttps://

projects.tmforum.org/wiki/download/attachments/143534323/TMF657-ServiceQualityManagement-v4-Postman.zip?api=v2

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF641-ServiceOrdering-v5.0.0.pdf
NameService 

Quality

Ordering Management API

Show If

special

@authenticated

@anonymous

match

Image Removed

Show If

special	@anonymous

Image Removed

19

Image Added

allgroupnot-tmforum-members

Not yet available

22.5.0

(v4

v5.0.0

)

Pre-production

	Service
Service Test Management API

The Service Test API provides a standardized mechanism for placing a service test with all

of

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

TMF653

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type	Swagger
Licence	Apache 2.0
Link	https:/

/github.com/tmforum-apis/TMF653_ServiceTestManagement

/tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF653-Service_Test_Management-v5.0.0.oas.yaml
Name	Service Test Management API

Show Ifspecial@authenticatedmatchallgroup

Image Removed

not-tmforum-members

 Show If
special@anonymous

Image Removed

Image Added

Show If

special	@authenticated

match

all

group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://

projects.tmforum.org/wiki/download/attachments/146293787/TMF653_Service_Test_Management_API_User_Guide_v4

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF653-Service_Test_Management-v5.0.0.pdf

?api=v2


Name	Service Test Management API

Show Ifspecial@authenticatedmatchallgroup

Image Removed

not-tmforum-members

Trackinglink

Type	CTK-Conformance
Link	https://projects.tmforum.org/wiki/download/attachments/146293791/TMF653B_Service_Test_API_Conformance_Profile_v4.0.0.pdf?api=v2
Name	Service Test Management API

Show If

special	@anonymous

Image Modified

Show If

special	@authenticated
match	all
group	tmforum-members

Not yet available

21.5.0

v5.0.0

10-Dec-2021

Service

Service Usage Management API

No description available yet

TMF727

Show If

special	@authenticated

matchall

group

not-

tmforum-members

Image Removed

Trackinglink

show-if

Type

special

Swagger

@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available

20.5.0

(v4.0.0)

Pre-production

Stock Management API

The Stock Management API provides standardized mechanism for product stock management such as creation, update and retrieval of the representation of a product stock, reserve product stock, check or query product stock or adjust product stock. It also allows the notification of events related to them.

TMF687

Licence	Apache 2.0
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF727-ServiceUsage-v4.0.0.swagger.json
Name	Service Usage Management API

Show If

special	@anonymous

Image Added

Show If

special	@authenticated

matchall


group	tmforum-members

Trackinglink

Type

SwaggerLicenceApache 2.0Linkhttps://github.com/tmforum-apis/TMF687_StockManagementNameStock

Image Removed

Show If

special	@anonymous

Image Removed

Specification PDF
Licence	RAND
Link	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF727_Service_Usage_Management_API_REST_Specification_v4-0-0.pdf
Name	Service Usage Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

@anonymous

Image Added

Not yet available

22.0.0

v4.0.0

08-06-2022

Shipment Management Management API

Shipment Management

TMF711

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type

Specification PDF

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/154174144/TMF687_Stock_Management_API_User_Guide_v4-0-0.pdf?api=v2NameStock

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

@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

@anonymous

Image Added

Not yet available

v4.0.0

10-Jan-2022

Business Partner

Shipping Order Management API

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

TMF700

Show If

special	@authenticated

matchall


group	tmforum-members

Trackinglink

Type

CTK-Conformance

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available

20.5.0

(v4.0.0

Pre-Production

Test Case Management API

The intent of this API is to provide a consistent/standardized mechanism to manage test case models and related artifacts.

It includes the model definition as well as all available operations and is part of the TMF913 Test API Component Suite.

TMF704

Swagger

Linkhttps://projects.tmforum.org/wiki/download/attachments/154174157/TMF687B_Stock_API_Conformance_Profile_v4.0.0.pdf?api=v2NameStock Management APImatchall

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

RAND
Linkhttps://

github

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

/tmforum-apis/TMF704_TestCaseNameTest Case Managment API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

/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

Image Added

Show If

special	@authenticated

match

Trackinglink

all

Type

grouptmforum

CTK-

membersTypeSpecification PDF

Conformance

Trackinglink

LicenceRAND
Linkhttps://

projects.tmforum.org/wiki/download/attachments/146293898/TMF704_Test_Case_Management_API_User_Guide_v4.0.0.pdf?api=v2NameTest Case Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF700_Shipping_Order_v4.0.0_conformance.pdf
Name	Shipping Order 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

20.5.0

(v4.0.0)

Pre-productionTest Data Management APITMF706Not Yet Available

yet available

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

Trackinglink

Type

Specification PDF

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/146293820/TMF706_Test_Data_Management_API_User_Guide_

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

pdf?api=v2

swagger.json
Name

Test Data

SLA Management API

Show If

special

@authenticated

Image Removed

Show If

special	@anonymous

Image Removed

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

20.5.0

(

@anonymous

matchallgroupnot-tmforum-members

Image Added

Not yet available

22.0.0

v4.0.0

)

Pre-productionTest Environment Management APITMF705Not Yet Available

08-06-2022

Business Partner

Stock Management

No description available yet

TMF687

Show If

special

@authenticatedmatch

all

@authenticated
group	tmforum-members

Trackinglink

Type

Specification PDF

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/146293812/TMF705_Test_Environment_Management_API_REST_User_Guide_v4.0.0.pdf?api=v2NameTest Environment Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF687-Stock-v4.1.0.swagger.json
Name	Stock Management

Show If

special	@anonymous

Image Added

Image Removed

Not yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available Not Yet Available

yet available

20.5.0

(v4.0.0)

Pre-productionTest Execution Management APITMF708

22.5.2

v4.1.0

16-11-2022

Common

Trouble Ticket Management API

Provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets among partners as a result of an issue or problem identified by a customer or another system. Examples of Trouble Ticket API clients include CRM applications, network management or fault management systems, or other trouble ticket management systems (e.g. B2B).

TMF621

Show If

special	@authenticated

match

all

group	tmforum-members

Trackinglink

Type

Specification PDF

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/146293829/TMF708_Test_Execution_Management_API_User_Guide_v4.0.0.pdf?api=v2NameTest Execution Management API

Show If

special	@authenticated
match	all
group	not-tmforum-members

Image Removed

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF621-TroubleTicket-v4.1.0.swagger.json
Name	Trouble Ticket Management API

Show If

special	@anonymous

Image Removed

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

20.5.0

(v4.0.0)

Pre-productionTest Result Management APITMF707Not Yet Available

Image Added

Show If

special	@authenticated

matchall


group	tmforum-members

Trackinglink

Type	Specification PDF
Licence	RAND
Link	https://

projects.tmforum.org/wiki/download/attachments/146293824/TMF707_Test_Result_Management_API_User_Guide_v4

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF621-Trouble_Ticket-v5.0.0.pdf

?api=v2

Name

Test Result

Image Removed

Show Ifspecial

Trouble Ticket Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

@anonymous

Image Modified

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

Not

Yet Available

yet available

20

22.5.

0

(v4.0.0)

Pre-productionTest Scenario Manegement APITMF709Not Yet Available

0

v4.1.0

Common

Usage Consumption Management API

This API provides the real-time value within buckets (SMS, Voice, Data, TV for example) that a customer consumes with each of their devices, related to subscribed communication products without having to wait for the bill cycle. A usage report retrieves the data related to these balances.

TMF677

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type

Specification PDF

Swagger
LicenceApache 2.0
Linkhttps

://projects.tmforum.org/wiki/download/attachments/146293833/TMF709_Test_Scenario_Management_API_User_Guide_v4.0.0.pdf?api=v2NameTest Scenario

://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF677-UsageConsumption-v4.0.1.swagger.json
Name	Usage Consumption Management API

Show If

special

@authenticated

Image Removed

Show If

special	@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 20

@anonymous

matchallgroupnot-tmforum-members

Image Added

Not yet available

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

Warranty Management

No description available yet

TMF715

Show If

special	@authenticated

matchall


group	tmforum-members

Trackinglink

Link
Type	Swagger
Licence	Apache 2.0

https://github.com/tmforum-apis/TMF672_UserRolesPermissionsNameUser Roles & Permissions API

	https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF715-WarrantyManagement-v4.0.0.swagger.json
Name	Warranty Management

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

	@anonymous

Image Added

Not yet available

22.5.0

v4.0.0

Common

Work Management

No description available yet

TMF713

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type

Specification PDF

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/134792889/TMF672_User_Role_Permission_Management_API_User_Guide_

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

pdf?api=v2

swagger.json
Name

User Roles & Permissions API

Image Removed

Show If

special	@anonymous

Image Removed

Work Management

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

@anonymous

Image Added

Not yet available

22.5.0

v4.0.0

Common

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

Type

CTK-Conformance

Swagger
LicenceApache 2.0
Linkhttps://

projects.tmforum.org/wiki/download/attachments/146293796/TMF672B_User_Role_Permission_Conformance_Profile_

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

.pdf?api=v2

.swagger.json
Name

User Roles & Permissions

Work Order Management API

Show If

special

@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If

special	@anonymous

Image Removed

Not Yet Available Not Yet Available

	@anonymous

Image Added

Not yet available

v4.0.0

22-Nov-2021

Business Partner

Work Qualification Management

No description available yet

TMF714

Show If

special	@authenticated

matchall

group	tmforum-members

Trackinglink

Type

Postman

Swagger
Licence

RAND

Apache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/

projects

4.

tmforum

0.

org

0/

wiki/download/attachments/143534323/TMF672-UserRolePermission-v4-Postman.zip?api=v2NameUser Roles & Permissions API

swagger/TMF714-WorkQualification-v4.0.0.swagger.json
Name	Work Qualification Management

Show If

special

@authenticated

@anonymous

match

Image Removed

Show If

special	@anonymous

Image Removed

20

Image Added

allgroupnot-tmforum-members

Not yet available

22.5.0

(

v4.0.0

)

Pre-production

Common

Space shortcuts

Page tree

Versions Compared

Old Version 55

New Version 155

Key

TM Forum Open APIs

Early Adoption (Beta) Versions

TM Forum Open APIs

Early Adoption (Beta) Versions