TM Forum Ecosystem API Portal

Space shortcuts

Page tree

Versions Compared

Old Version 24

changes.mady.by.user Alan Pope

Saved on

compared with

New Version 136

changes.mady.by.user Catalyst Submission Bot

Saved on

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.com/tmforum-apis/TMF642_AlarmManagement
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF666-Account-v4.1.0.swagger.json
NameAccount
NameAlarm
Management API

 



Show If
special
@authenticated
@anonymous
match

Image Added

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

Change Management API

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

TMF655
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/TMF655-Change-v4.0.0
.pdf?api=v2
.swagger.json
Name
Alarm
Change Management API

 



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

Image Added


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

Open API Table - Pre-production (Beta)

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

19.5.0

(v4.0.0)

Pre-production

Communication API

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

TMF681 Show If
special@authenticated
matchall
grouptmforum-members
tmforum-members


Trackinglink
Type
TrackinglinkType
Swagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF681_Communication
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF717-Customer360-v4.0.0.swagger.json
NameCustomer360 Management
NameCommunication
API

 



Show If
special
@authenticated
@anonymous
match

Image Added

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

 

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 Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

Customer Bill Management API

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

TMF678 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF678_CustomerBill
NameCustomer Bill 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)

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792897/TMF678_Customer_Bill_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameCustomer Bill 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 Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

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 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF662_EntityCatalog
NameEntity Catalog 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 Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

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
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF703_EntityInventory
NameEntity Inventory 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 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 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF688-Event
NameEvent 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 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
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF691_FederatedIdentity
NameFederated Identity 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)

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792909/TMF691_Federated_ID_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameFederated Identity 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 Not Yet Available Not Yet Available Not Yet Available 

20.0.0

(v4.0.0)

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.

TMF673 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF673_GeographicAddress
NameGeographic Address 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)

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792893/TMF673_Geographic_Address_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameGeographic Address 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 Not Yet Available Not Yet Available Not Yet Available 

20.0.0

(v4.0.0)

Pre-production

Geographic Location Management API

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

TMF675 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF675_GeographicLocation
NameGeographic Location 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 Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

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
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF674_GeographicSite
NameGeographic Site 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)

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134776996/TMF674_Geographic_Site_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameGeographic Site 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 Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

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.

TMF908 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF908_IoTAgentAndDeviceComponentSuite
Name IoT Agent and Device Management Component Suite

 

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


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

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
Trackinglink
TypeSpecification PDF
Linkhttps://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=v2
Name IoT Agent and Device Management Component Suite

 

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 Not Yet Available Not Yet Available Not Yet Available 

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

TMF683


Show If
special@authenticated
matchallNameParty Interaction Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Open API Table - Pre-production (Beta)

grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Link
https://github.com/tmforum-apis/TMF683_PartyInteraction
https://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.

 



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/134792905/TMF683_Party_Interaction_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameParty Interaction Management API

 

Image Added


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

Entity Inventory Management API

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

TMF703


Show If
special@authenticated
match
all
group
not-
tmforum-members


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

 

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 

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
21
19
.5.0
(4
v4.0.0
)

Pre-production

22-Nov-2021Common

Event

Payment

Management API

The

Payments

Event Management API provides

the

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

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
TMF676 


Show If
special@authenticated
matchall
grouptmforum-members


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


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
TMF654

 



Show If
special
@authenticated
@anonymous
match

Image Added

all



Show If
group
special
tmforum-members
@authenticated


Trackinglink
Type
Swagger
CTK-Conformance
Licence
Apache 2.0
RAND
Linkhttps://
github.com/tmforum-apis/TMF654_PrepayBalanceManagement
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 API

 

NamePrepay Balance 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)

Image Added


Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available
21.5
Not Yet Available Not Yet Available 20.0
.0
(4
v4.0.0
)

Pre-production

22-Nov-2021Common

Federated ID

Privacy

Management API

The

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

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
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/TMF691-FederatedIdentity-v4.0.0.swagger.json
?version=1&modificationDate=1573117743866&api=v2
Name
Privacy
Federated ID Management API

 



Show If
special@anonymous

Image Removed

Show If
special@anonymous

Open API Table - Pre-production (Beta)

 

Image Added



Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
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.0.0/user_guides/TMF691_Federated_Identity_API_user_guides_21.5.0.pdf
NameFederated ID Management API

 

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

Image Added


Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available
19
21.5.0
(4
v4.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.

22-Nov-2021Common

Geographic Location Management API

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

TMF675
TMF680


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF680_Recommendation
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF675-GeographicLocation-v4.0.0.swagger.json
NameGeographic Location Management
NameRecommendation
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-2021Common

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@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/134777000/TMF680_Recommendation_Management_API_User_Guide_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF921-Intent-v4.0.0
.pdf?api=v2
.swagger.json
Name
Recommendation API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
Intent

 

Open API Table - Pre-production (Beta)



Show If
special@anonymous

Open API Table - Pre-production (Beta)

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

19.5.0

(v4.0.0)

Pre-production

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

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

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
TMF702


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF702-ResourceActivationConfigurationNameResource Activation & Configuration API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0.0.swagger.json
NameIoT Agent and Device Management API

 

Open API Table - Pre-production (Beta) 



Show If
special@anonymous

Open API Table - Pre-production (Beta)

Image Added



Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792913/TMF702_Resource_Activation
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF908_IoT_Device_Management_API_Component_
User
Suite_user_
Guide
guides_
v4
21.
0
5.0.pdf
?api=v2
Name
Resource Activation & Configuration
IoT Agent and Device Management API

 



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

Image Added


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

IoT Service Management API

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

TMF914


Show If
special@authenticated
@anonymous
group

Open API Table - Pre-production (Beta)

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

19.5.0

(v4.0.0)

Pre-production
tmforum-members


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

 



Show If
special@anonymous

Image Added

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



Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
Swagger
Specification PDF
Licence
Apache 2.0
RAND
Link
https://github.com/tmforum-apis/TMF634_ResourceCatalog
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
NameIoT Service Management
NameResource Catalog
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
21.5.0
v4.0.0
22-Nov-2021Product, Common, Resource, Service

Metadata Catalog Management API

Metadata Catalog

TMF725
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/134776967/TMF634_Resource_Catalog_Management_API_User_Guide_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF725-MetadataCatalog-v4.0.0
.pdf?api=v2
.swagger.json
Name
Resource
Metadata Catalog Management API

 

Show Ifspecial@authenticatedmatchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)



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

Image Added


Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 

19.5.0

(
yet available Not
Yet Available 
yet available Not yet available
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

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
TMF664


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/TMF664_ResourceFunctionActivationConfigurationNameResource Function Activation and Configuration
Beta/4.1.0/swagger/TMF669-PartyRole-v4.1.0.swagger.json
NameParty Role 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 Not yet available Not yet available
22.0.0
v4.1.0
08-06-2022Business Partner

Performance Management API

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

TMF628
Show If
special@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/134776992/TMF664_Resource_Function_Activation_and_Configuration_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
Resource Function Activation and Configuration
Performance 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 

19.5.0

(v4.0.0)

Pre-production
@anonymous

Image Added


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

Process Flow Management API

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

TMF701


Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added

Resource Inventory Management API

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

TMF639



Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
Swagger
Specification PDF
Licence
Apache 2.0
RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/
github.com/tmforum-apis/TMF639_ResourceInventory
4.1.0/user_guides/TMF701_Process_Flow_Management_API_Specification_v4.1.0.pdf
NameProcess Flow Management API

 

NameResource Inventory API

 

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



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated
match


Trackinglink
alltmforum
Type
group
CTK-
members
Conformance
Trackinglink
LicenceRAND
TypeSpecification PDF
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/
projects
4.
tmforum
1.
org
0/
wiki/download/attachments/134792865/TMF639_Resource_Inventory_Management_API_User_Guide_v4.0
conformance/TMF701_Process_Flow_Management_Conformance-v4.1.0.pdf
?api=v2
Name
Resource Inventory
Process Flow 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 Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Pre-production

Resource Ordering Management API

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

Image Added


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

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
TMF652


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0Linkhttps://github.com/tmforum-apis/TMF652_ResourceOrderManagementNameResource Order Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF671-Promotion-v4.0.0.swagger.json
NamePromotion Management API

 

Open API Table - Pre-production (Beta)



Show If
special@anonymous
Image Removed

Image Added


Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available
19
21.5.0
(
v4.0.0
)
Pre-production
22-Nov-2021Product

Recommendation

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.

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
TMF696


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/TMF696_RiskManagement
/Beta/4.0.0/swagger/TMF680-Recommendation-v4.0.0.swagger.json
NameRecommendation Management API

 



Show If
special@anonymous

Image Added

NameRisk Management API 



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/4.0.0/user_guides/TMF680_Recommendation_API_user_guides_21.5.0.pdf
NameRecommendation Management API

 

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

Image Added

all



Show If
group
special
tmforum-members
@authenticated


Trackinglink
Type
Swagger
CTK-Conformance
Licence
Apache 2.0
RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/
github
4.0.
com
0/
tmforum-apis/TMF640_ActivationConfigurationNameService Activation & Configuration
conformance/TMF680_Recommendation_API_conformance_21.5.0.pdf
NameRecommendation Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)

Show If
special@anonymous

Image Removed

@anonymous

Image Added


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

Resource Activation Management API

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

TMF702


Show If
special@authenticated
match
all
grouptmforum-members


Trackinglink
Type
Swagger
LicenceApache 2.0
Specification PDF
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792872/TMF640_Service_Activation_Management_API_User_Guide_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF702-ResourceActivation-v4.0.0.
pdf?api=v2
swagger.json
Name
Service
Resource Activation
& Configuration
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/4.0.0/user_guides/TMF702_Resource_Activation_and_Configuration_API_user_guides_21.5.0.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

Image Added

all



Show If
group
special
tmforum-members
@authenticated


Trackinglink
Type
Swagger
CTK-Conformance
Licence
Apache 2.0
RAND
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com
/tmforum-apis/TMF633_ServiceCatalog
/Beta/4.0.0/conformance/TMF702_Resource_Activation_v4.0.0_conformance.pdf
NameResource Activation
NameService Catalog
Management API

 



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

Image Added



Show If
special
@anonymous
@authenticated
Image Removed


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

20.5.0

(v4.0.0)

Pre-production

Service Inventory Management API

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

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

 

TMF638



Show If
special
@authenticated
@anonymous
match

Image Added

all



Show If
group
special
tmforum-members
@authenticated


Trackinglink
Type
Swagger
RI
Licence
Apache 2.0
RAND
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com
/tmforum-apis/TMF638_ServiceInventory
/Beta/4.0.0/ri/TMF702_Resource_activation.zip
NameResource Activation Management API

 

NameService Inventory Management API

 

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



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated
match


Trackinglink
all
Type
group
Postman
tmforum-members
Licence
trackinglink
RAND
TypeSpecification PDF
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792858/TMF638_Service_Inventory_Management_API_User_Guide_v4.0.0.pdf?api=v2
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/postman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zip
NameResource Activation Management API

 

NameService Inventory 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 Not Yet Available Not Yet Available Not Yet Available 

Image Added


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

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
TMF641


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/TMF641_ServiceOrder/tree/master
Beta/4.0.0/swagger/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json
NameResource Function Activation and Configuration API

 

NameService Ordering Management API

 

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



Show If
special@anonymous
Image Removed

Image Added



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.0.0/user_guides/TMF664_Resource_Function_Activation_Management_API_
User
REST_
Guide
Specification_v4
.
-0
.0.pdf?api=v2
-0.pdf
NameResource Function Activation and Configuration API

 

NameService Ordering 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)

Image Added


Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available
20
22.0.0
(
v4.0.0
)
Pre-production
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

Service Qualification API

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

TMF645


Show If
special@authenticated
matchallNameService Qualification API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Open API Table - Pre-production (Beta)

grouptmforum-members


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

 



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/
projects
4.
tmforum
1.
org
0/
wiki/download/attachments/134792885/TMF645_Service_Qualification
user_guides/TMF699_Sales_Management_API_
User
REST_
Guide
Specification_v4.
0
1.0.pdf
?api=v2
Name
Service Qualification
Sales 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)

Image Added


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

Service

Quality TMF657

 

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

TMF727


Show If
special@authenticated
matchall
grouptmforum-members


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

 



Show If
special
@authenticated
@anonymous
match

Image Added

allgroupnot-tmforum-members

Open API Table - Pre-production (Beta)


 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@anonymous
Open API Table - Pre-production (Beta)


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
Swagger
LicenceApache 2.0
Specification PDF
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_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/TMF711-ShipmentManagement-v4.0.0.swagger.json
NameShipment Management Management API

 

NameService Quality 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)

Image Added


Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 

19.5.0

(
yet available Not
Yet Available 
yet available Not yet available
v4.0.0
)
Pre-production

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.

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
TMF653


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF653_ServiceTestManagementNameService Test 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 Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

20.0.0

(v4.0.0)

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

 

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

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/TMF704_TestCaseNameTest Case Managment API
/Beta/4.0.0/user_guides/TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0.pdf
NameShipping Order 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)

Image Added



Show If
special@authenticated
match


Trackinglink
alltmforum
Type
group
CTK-
members
Conformance
trackinglink
Licence
Type
RAND
Specification PDF
Linkhttps://
projects.tmforum.org/wiki/download/attachments/141167930/TMF704_Test_Case_Management_API_User_Guide_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF700_Shipping_Order_v4.0.0_conformance.pdf
?api=v2
Name
Test Case Managment
Shipping Order Management API

 

Show Ifspecial@authenticatedmatchallgroupnot-tmforum-members

Open API Table - Pre-production (Beta)



Show If
special@anonymous

Open API Table - Pre-production (Beta)

 

Image Added


Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available Not Yet Available 
yet available
21
20
.5.0
(
v4.0.0
)
Pre-production
22-Nov-2021Business Partner

SLA

Usage

Management API

Provides a 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.

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
TMF635


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2
.0Linkhttps://github.com/tmforum-apis/TMF635_UsageManagementNameUsage Management API
.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@authenticated
matchall
groupnot-tmforum-members
Open API Table - Pre-production (Beta)



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

Image Added


Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available
20
22.
5
0.0
(
v4.0.0
)
Pre-production
08-06-2022Business Partner

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.0
Linkhttps://
github.com/tmforum-apis/TMF672_UserRolesPermissionsNameUser Roles & Permissions API
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF677-UsageConsumption-v4.0.1.swagger.json
NameUsage Consumption Management API

 



Show If
special@anonymous

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

Open API Table - Pre-production (Beta)

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


Show If
special@authenticated
match
all
grouptmforum-members
Trackinglink


Trackinglink
TypeSwagger
LicenceApache 2.0
TypeSpecification PDF
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134792889/TMF672_User_Role_Permission_Management_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/TMF697-WorkOrder-v4.0.0.swagger.json
NameWork Order Management API

 

NameUser Roles & Permissions 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)

Image Added


Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 
yet available Not
Yet Available 

19.5.0

(
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