Versions Compared

Key

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

...

Dialog
idmembers-only
titleFor TM Forum Members


Section


Panel
borderStylenone

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 ourReleased TM Forum Open API documentation

Button Hyperlink
titleBrowse Released APIs
typeprimary
urlhttps://projects.tmforum.org/wiki/display/API/Open+API+Table#OpenAPITable-ReleasedTMForumOpenAPIs
Button Hyperlink
titleFind out more about Membership
typestandard
urlhttps://www.tmforum.org/membership/benefits/
targettrue



TM Forum Open APIs

...

Early Adoption (Beta) Versions


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


TM Forum Open APIs

Pre-Production

_____________________________________

Document Number

Swagger

(Apache 2.0 or RAND)

API User Guide / Specification

(RAND)

Conformance Profile

(RAND)

CTK
Reference

Sample Implementation Code

Postman CollectionRelease
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.

Swagger VersionPublication DateODA DomainNotes

Account Management API

Provides standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts

TMF666
TMF642


Show If
special@authenticated
matchall
grouptmforum-members


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

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.1.0
10-Jan-2022Business Partner, Customer

Async Trouble Ticket API

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

TMF925
Show If
special@anonymous
Image Removed


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
Swagger
LicenceApache 2.0
Specification PDF
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/TMF925-TroubleTicket-v4.0.0
.pdf?api=v2
.asyncapi.yml
Name
Alarm Management
Async Trouble Ticket API

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-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 Not yet available Not yet available Not yet available Not yet available
22
19
.5.0
(
v4.0.0
)
Pre-production
Common

Change Management API

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

TMF655

Communication API

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

TMF681


Show If
special@authenticated
match
all
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com
/tmforum-apis/TMF681_Communication
/Beta/4.0.0/swagger/TMF655-Change-v4.0.0.swagger.json
Name
Communication
Change Management API

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

Show If
special@anonymous

Open API Table - Pre-production (Beta)

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792901/TMF681_Communication_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameCommunication API

 


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

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


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF717-Customer360-

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.

TMF678 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF678_CustomerBill
NameCustomer Bill Management API

 

.swagger.json
NameCustomer360 Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
05-Jan-2022Customer

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
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
matchall
grouptmforum-members
TrackinglinkTypeSpecification PDFLinkhttps://projects.tmforum.org/wiki/download/attachments/134792897/TMF678_Customer_Bill_Management_API_User_Guide_v4.0.0.pdf?api=v2


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF924-dcs-5gslice-sa-swagger.json
NameDCS 5GSlice Service Activation
NameCustomer Bill Management
API

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-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 Not yet available Not yet available Not yet available Not yet available
22
19
.5.0
(
v4.0.0
)
Pre-production
Service

Digital Identity

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.

.

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
TMF662


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF662_EntityCatalog
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF720-DigitalIdentity-v4.0.0.swagger.json
NameDigital Identity Management API.
NameEntity Catalog Management API

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-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 

20.5.0

(v4.0.0)


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Business Partner, Common
Pre-production

Entity Inventory Management API

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

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

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

TMF703


Show If
special@authenticated
match
group
allgroup
tmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF703_EntityInventory
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF703-EntityInventory-v4.0.0.swagger.json
NameEntity Inventory Management API

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-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 

20.5.0

(v4.0.0)

Pre-production


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

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 

for creating, managing and receiving service related events to (indicatively)

  drive  automation

 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

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


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF688-Event-v4.0.0.swagger.json
NameEvent
management
Management API

 



Show If
special
@authenticated
@anonymous
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 Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

Federated Identity API

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

TMF691 Show If
special@authenticated
matchall
grouptmforum-members
@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF688_Event_Management_API_conformance_21.5.0.pdf
NameEvent Management
TrackinglinkTypeSwaggerLicenceApache 2.0Linkhttps://github.com/tmforum-apis/TMF691_FederatedIdentityNameFederated Identity
API

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

Show If
special@anonymous

Open API Table - Pre-production (Beta)

Show If


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

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
special@authenticatedmatchall
grouptmforum-members


Trackinglink
Type
Swagger
LicenceApache 2.0
Specification PDF
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792909/TMF691_Federated_ID_Management_API_User_Guide_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF691-FederatedIdentity-v4.0.0
.pdf?api=v2
.swagger.json
NameFederated
Identity
ID Management API

 



Show If
special
@authenticated
@anonymous

Image Added



Show If
special@authenticated
matchall
group
not-

20.0.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
TypeSpecification PDF
LicenceRAND
Linkhttps://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
NameFederated ID Management API

 



Show If
special@anonymous

Image Added


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

Geographic

Address

Location Management API

Provides

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

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

TMF675
TMF673


Show If
special@authenticated
matchall
grouptmforum
grouptmforum
-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/
tmforum-apis/TMF673_GeographicAddress
Beta/4.0.0/swagger/TMF675-GeographicLocation-v4.0.0.swagger.json
NameGeographic
Address
Location Management API

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)


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

Geographic Site Management API

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

TMF674
Show If
special@anonymous
Open API Table - Pre-production (Beta)


Show If
special@authenticated
match
all
grouptmforum-members


Trackinglink
Type
Swagger
LicenceApache 2.0
Specification PDF
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792893/TMF673_Geographic_Address_Management_API_User_Guide_v4
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF674-GeographicSite-v5.0.0
.pdf?api=v2
.oas.yaml
NameGeographic
Address
Site Management API

 



Show If
special
@authenticated
@anonymous

Image Added



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 

20.0.0

(v4.0.0)

Pre-production


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

 

Geographic Location Management API

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

TMF675



Show If
special
@authenticated
@anonymous
matchall
Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Common

Intent

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

TMF921


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/
tmforum-apis/TMF675_GeographicLocation
Beta/4.0.0/swagger/TMF921-Intent-v4.0.0.swagger.json
NameIntent
NameGeographic Location Management API

 



Show If
special
@authenticatedmatch

19.5.0

(
allgroupnot-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 Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.0.0
)
Pre
08-06-
productionGeographic Site
2022

IoT Agent and Device 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?”

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
TMF674


Show If
special@authenticated
match
all
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com
/tmforum-apis/TMF674_GeographicSite
/Beta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0.0.swagger.json
NameIoT Agent and Device
NameGeographic Site
Management API

 



Show If
special
@authenticated
@anonymous
matchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)


show-
show-
if
special
@anonymousspecial

Open API Table - Pre-production (Beta)

Show If
@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134776996/TMF674_Geographic_Site
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
user_
Guide
guides_
v4
21.
0
5.0.pdf
?api=v2
Name
Geographic Site
IoT Agent and Device Management API

 



Show If
special
@authenticatedmatch
allgroupnot-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 
@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
21
19
.5.0
(
v4.0.0
)
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-2021Resource

IoT Service Management API

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

TMF914
TMF683


Show If
special@authenticated
matchall
grouptmforum-members


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

 



Show If
special
@authenticatedmatch
allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

@anonymous

Image Added

Show If
special@anonymous
Open API Table - Pre-production (Beta)



Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792905/TMF683_Party_Interaction
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
user_
Guide
guides_
v4
21.
0
5.0.pdf
?api=v2
Name
Party Interaction
IoT Service 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 
@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
21
19
.5.0
(4
v4.0.0
)
Pre
22-Nov-
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
2021Product, Common, Resource, Service

Metadata Catalog Management API

Metadata Catalog

TMF725
 


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com
/tmforum-apis/TMF676_PaymentManagement
/Beta/4.0.0/swagger/TMF725-MetadataCatalog-v4.0.0.swagger.json
NameMetadata Catalog
NamePayment
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

(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

 

@anonymous

Image Added


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

Party Role Management API

A standardized mechanism for general party roles and includes operations such as creation, update, retrieval, deletion and notification of events. Notice that for the management of customers there is a specific Customer Management API.
Party Role management API manages the following data resources: PartyRole

TMF669


Show If
special@authenticated
matchall
grouptmforum-members


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

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-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 


Not yet available Not yet available Not yet available Not yet available Not yet available
22
20
.0.0
(4
v4.
0
1.0
)

Pre-production

08-06-2022Business Partner

Performance

Privacy

Management API

The Privacy management API provides

Provides a standardized mechanism for

privacy profile types, privacy profiles and privacy agreements

performance management such as the creation, partial or full update

, retrieval, deletion and notification of events.

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
TMF644


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
Licence
RAND
Apache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/123090132/TMF644_Privacy-4
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF628-Performance-v4.0.0.swagger.json
?version=1&modificationDate=1573117743866&api=v2
Name
Privacy
Performance Management API

 



Show If
special@anonymous

Image Added

Image Removed

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
21.5.0
v4.0.0
22-Nov-2021Service, Common

Process Flow Management API

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

TMF701
 


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
Specification PDF
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792881/TMF644_Privacy_Management_API_User_Guide_v4.0.0.pdf?api=v2
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF701-ProcessFlow-v4.1.0.swagger.json
NameProcess Flow
NamePrivacy
Management API

 



Show If
special
@authenticated
@anonymous
matchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)


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

(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 Show If
special@authenticated
matchall
grouptmforum-members
tmforum-members


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
TrackinglinkTypeSwaggerLicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF680_Recommendation
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/conformance/TMF701_Process_Flow_Management_Conformance-v4.1.0.pdf
NameProcess Flow Management
NameRecommendation
API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-membersOpen API Table - Pre-production (Beta)
@anonymous

Image Added


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

Product Catalog Management API

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

TMF620


Show If
special@authenticated
@anonymous
group

Open API Table - Pre-production (Beta)

 

Show If
special@authenticated
matchall
grouptmforum-members
TrackinglinkTypeSpecification PDF
tmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134777000/TMF680_Recommendation_Management_API_User_Guide_v4
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF620-Product_Catalog_Management-v5.0.0
.pdf?api=v2
.oas.yaml
Name
Recommendation
Product Catalog Management API

 



Show If
special
@authenticated
@anonymous

Image Added



Show If
special@authenticated
matchall
group
not-
tmforum-members


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

 

Open API Table - Pre-production (Beta)



Show If
special@anonymous
Open API Table - Pre-production (Beta)
Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available
19
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.

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
TMF702


Show If
special@authenticated
match
all
grouptmforum-members


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

 



Show If
special
@authenticated
@anonymous

Image Added



Show If
special@authenticated
matchall
group
not-
tmforum-members

Open API Table - Pre-production (Beta)


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF637-ProductInventory-v5.0.0.pdf
NameProduct Inventory Management API
Show If
special@anonymous
Open API Table - Pre-production (Beta)

 



Show If
special
@authenticated
@anonymous
match
allgrouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792913/TMF702_Resource_Activation_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameResource Activation & Configuration API

 


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Product

Product Offering Qualification Management API

Product Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility.

TMF679


Show If
special@authenticated
matchall
group
not-

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


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
match
all
grouptmforum-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/TMF634_ResourceCatalog
/Beta/5.0.0/user_guides/TMF679-ProductOfferingQualification-v5.0.0.pdf
NameProduct Offering Qualification Management
NameResource Catalog
API

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134776967/TMF634_Resource_Catalog_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameResource Catalog API

 


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Product

Product Ordering Management API

Provides a standardized mechanism for placing a product order with all the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order negotiation systems in a consistent manner. A product order is created based on a product offering that is defined in a catalog. The product offering identifies the product or set of products that are available to a customer and includes characteristics such as pricing, product options and market.

TMF622


Show If
special@authenticated
matchall
group
not-
tmforum-members


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

 

Open API Table - Pre-production (Beta)



Show If
special@anonymous

Image Added

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

TMF664



Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Customer, Product

Promotion Management API

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

TMF671
Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF664_ResourceFunctionActivationConfiguration
NameResource Function Activation and Configuration API
 


Show If
special@authenticated
matchall
group
not-tmforum
tmforum-members

Open API Table - Pre-production (Beta)

Show If
special@anonymous

Open API Table - Pre-production (Beta)

Show If
special@authenticated
matchall
grouptmforum-members
TrackinglinkTypeSpecification PDF


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134776992/TMF664_Resource_Function_Activation_and_Configuration_API_User_Guide_v4.0.0.pdf?api=v2
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF671-Promotion-v4.0.0.swagger.json
NamePromotion Management
NameResource Function Activation and Configuration
API

 



Show If
special
@authenticated
@anonymous
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 Not Yet Available 
Not yet available Not yet available Not yet available Not yet available Not yet available
21
19
.5.0
(
v4.0.0
)
Pre-production
22-Nov-2021Product

Quote

Resource Inventory

Management API

The

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

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
TMF639


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Open API Table - Pre-production (Beta)

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com
/tmforum-apis/TMF639_ResourceInventoryNameResource Inventory API
/Beta/5.0.0/swagger/TMF648-Quote-v5.0.0.oas.yaml
NameQuote Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792865/TMF639_Resource_Inventory_Management_API_User_Guide_v4.0.0.pdf?api=v2
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF648-Quote-v5.0.0.pdf
NameQuote Management
NameResource Inventory
API

 



Show If
special
@authenticated
matchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22
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
v5.0.0
)
Pre-production
Customer

Recommendation

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.

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
TMF652


Show If
special@authenticated
match
all
grouptmforum-members


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

 



Show If
special
@authenticated
@anonymous

Image Added



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 

19.5.0

(v4.0.0)

Pre-production

Risk 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 Show If
special@authenticated
matchall
grouptmforum-members


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


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

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

@anonymous

Image Added


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

Resource Activation Management API

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

TMF702
Show If
special@anonymous

Image Removed

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


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/
tmforum-apis/TMF640_ActivationConfiguration
Beta/4.0.0/swagger/TMF702-ResourceActivation-v4.0.0.swagger.json
Name
Service
Resource Activation
& Configuration
Management API

 



Show If
special
@authenticated
@anonymous
matchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)


show-
show-
if
special
@anonymousImage Removedspecial
Show If
@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792872/TMF640_Service_Activation_Management_API_User_Guide_v4.0.0.pdf?api=v2NameService Activation & Configuration
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF702_Resource_Activation_and_Configuration_API_user_guides_21.5.0.pdf
NameResource Activation Management API

 



Show If
special
@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 
@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF702_Resource_Activation_

20.0.0

(
v4.0.0
)Pre-production
_conformance.pdf
NameResource Activation Management API

 

Service Catalog API

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

TMF633



Show If
special
@authenticated
@anonymous
match
all



Show If
group
special
tmforum-members
@authenticated


Trackinglink
Type
Swagger
CTK
Licence
Apache 2.0
RAND
Linkhttps://
github.com/tmforum-apis/TMF633_ServiceCatalog
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ctk/TMF702-ResourceActivation.zip
NameResource Activation
NameService Catalog
Management API

 



Show If
special
@authenticated
@anonymous
matchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)


show-
show-
if
special
@anonymous
@authenticated
Image Removed

Service Inventory Management API

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

TMF638


Trackinglink
Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

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

 



Show If
special
@authenticated
@anonymous
match
all



Show If
group
special
tmforum-members
@authenticated


Trackinglink
Type
Swagger
Postman
Licence
Apache 2.0
RAND
Linkhttps://
github.com/tmforum-apis/TMF638_ServiceInventory
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/postman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zip
NameResource Activation
NameService Inventory
Management API

 



Show If
special
@authenticated
@anonymous
matchallgroupnot-tmforum-membersOpen API Table - Pre-production (Beta)
21.5.0
v4.0.0
22-Nov-2021Resource, Common

Resource Function Activation and Configuration API

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

TMF664


Show If
special
@anonymous
@authenticated

Image Removed

Show Ifspecial@authenticatedmatchallgroup
group
tmforum-members


Trackinglink
Type
Swagger
LicenceApache 2.0
Specification PDF
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792858/TMF638_Service_Inventory_Management_API_User_Guide_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF664-ResourceFunctionActivation-v4.0.0
.pdf?api=v2
.swagger.json
Name
Service Inventory Management
Resource Function Activation and Configuration API

 



Show If
special
@authenticated
@anonymous
match
all



Show If
special@authenticated
group
not-
tmforum-members

Open API Table - Pre-production (Beta)


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

 

Show If
special@anonymous

Open API Table - Pre-production (Beta)

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.

TMF641



Show If
special
@authenticated
@anonymous
match
allgrouptmforum-members Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF641_ServiceOrder/tree/master
NameService Ordering Management API


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

Sales Management API

The Sales Management API provides interfaces for Sales Lead, Sales Opportunity, Sales Quote and the other management capabilities to support the sales activities to build relationship with the prospect customer who could be a person or organization that has an interest in the goods and/or services and possibly become the actual customers with one or more subscriptions.

TMF699
 


Show If
special@authenticated
matchall
group
not-tmforum
tmforum-members


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

 

Open API Table - Pre-production (Beta)



Show If
special@anonymous
Image Removed


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792876/TMF641_Service_Ordering
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
Service Ordering
Sales Management API

 



Show If
special
@authenticatedmatchall
groupnot-tmforum-members

Open API Table - Pre-production (Beta)

@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22
Show If
special@anonymous

Open API Table - Pre-production (Beta)

Not Yet Available Not Yet Available Not Yet Available Not Yet Available 20
.0.0
(
v4.
0
1.0
)
Pre-production
08-06-2022MarketingSales

Service

Qualification

Activation Management API

Service Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location.

The REST API for Activation and Configuration allows the user to retrieve, create, update, delete services and retrieve the monitor resource used to monitor the execution of asynchronous requests on a specific resource. Although all the examples given in the API specification are relative to Services, the same API can be used to Activate and Configure Services or Resources.

TMF640
TMF645


Show If
special@authenticated
matchall
grouptmforum
grouptmforum
-members


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

 

Show Ifspecial@authenticatedmatchallgroup

not-tmforum-members

Open API Table - Pre-production (Beta)



Show If
special@anonymous
Image Removed


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSpecification PDF
Link
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792885/TMF645_Service_Qualification_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
NameService
Qualification
Activation Management API

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5
Show If
special@anonymous

Open API Table - Pre-production (Beta)

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

20.0.0

(v4
.0.0
)
Common, Service
Pre-production

Service

Quality

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

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

TMF633
TMF657 


Show If
special@authenticated
matchall
grouptmforum
grouptmforum
-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/
tmforum-apis/TMF657_ServiceQualityManagement
Beta/5.0.0/swagger/TMF633-Service_Catalog_Management-v5.0.0.oas.yaml
NameService
Quality
Catalog Management API

 



Show If
special
@authenticated
@anonymous

Image Added



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


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF633-Service_Catalog_Management-v5
TrackinglinkTypeSpecification PDFLinkhttps://projects.tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_API_User_Guide_v4
.0.0.pdf
?api=v2
NameService
Quality
Catalog Management API

 



Show If
special
@authenticated
@anonymous
match
allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)


Not yet available Not yet available Not yet available Not yet available
22
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
v5.0.0
)
Pre-production
Service

Service

Test

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

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

TMF638


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF653_ServiceTestManagement
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF638-Service_Inventory_Management-v5.0.0.oas.yaml
NameService
Test
Inventory Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-membersOpen API Table - Pre-production (Beta)
@anonymous

Image Added



Show If
special@authenticated
@anonymous
group

Open API Table - Pre-production (Beta)

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

20.0.0

(v4.0.0)

Pre-production
tmforum-members


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

 

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



Show If
special
@authenticated
@anonymous
match
allgrouptmforum-members Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF704_TestCase
NameTest Case Managment API


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

Service Ordering Management API

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

TMF641
 


Show If
special@authenticated
matchall
group
not-
tmforum-members

Open API Table - Pre-production (Beta)


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

 

Show If
special@anonymous
Open API Table - Pre-production (Beta)



Show If
special
@authenticated
@anonymous

Image Added



Show If
special@authenticated
matchallNameTest Case Managment API

 

grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/141167930/TMF704_Test_Case_Management_API_User_Guide_v4.0.0.pdf?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 Ordering Management API

 



Show If
special@anonymous

Image Added


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

Service Test Management API

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

TMF653


Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added


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

Service Usage Management API

TMF727


Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.0.0
08-06-2022

Shipment Management Management API

Shipment Management

TMF711


Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added


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

Shipping Order Management API

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

TMF700


Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0.pdf
NameShipping Order Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


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

 



Show If
special@anonymous

Image Added


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

SLA Management API

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

TMF623


Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.0.0
08-06-2022Business Partner

Trouble Ticket Management API

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

TMF621


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 

20.5.0

(v4.0.0)

Pre-production

Usage Management API

Provides standardized mechanism for usage management such as creation, update, retrieval, import and export of a collection of usages. The API manages both rated and non-rated usage. For example, it allows a service provider to 1) retrieve usage generated by a partner service platform in order to rate it and 2) to provide rated usage to a partner for consumption follow up purposes.


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

 

TMF635



Show If
special
@authenticated
@anonymous

Image Added



Show If
special@authenticated
matchall
grouptmforum-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/TMF635_UsageManagementNameUsage Management API

 

/Beta/5.0.0/user_guides/TMF621-Trouble_Ticket-v5.0.0.pdf
NameTrouble Ticket Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
Open API Table - Pre-production (Beta)



Show If
special@anonymous
Open API Table - Pre-production (Beta)
Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available Not Yet Available 
yet available
22
20
.5.0
(v4
v5.0.0
)
Pre-production
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

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


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2
.0Linkhttps://github.com/tmforum-apis/TMF672_UserRolesPermissions
.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF677-UsageConsumption-v4.0.1.swagger.json
NameUsage Consumption Management
NameUser Roles & Permissions
API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

@anonymous

Image Added


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

Work Order Management API

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

TMF697
Show If
special@anonymous
Open API Table - Pre-production (Beta)


Show If
special@authenticated
matchall
grouptmforum-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/TMF697-WorkOrder-v4.0.0
.pdf?api=v2
.swagger.json
Name
User Roles & Permissions
Work Order Management API

 



Show If
special
@authenticatedmatchallgroup

19.5.0

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

Image Added


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


 Note: Reference/Sample implementation is not an architecture direction but a sample in a sandbox