Versions Compared

Key

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

...

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




hidehtml-if
special@authenticated
Note
titleTo access the API table links below you will need to be logged in

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

Button Hyperlink
titleLogin
typeprimary
urlhttps://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

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

Button Hyperlink
titleRegister
typeprimary
urlhttps://www.tmforum.org/user-registration/
targettrue

Dialog
idlogin-required
titleLogin Required
Section
Panel
borderStylenone

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

Button Hyperlink
titleLogin
typeprimary
urlhttps://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

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

Button Hyperlink
titleRegister
typeprimary
urlhttps://www.tmforum.org/user-registration/
targettrue

Dialog
idmembers-only
titleFor TM Forum Members
Section
Panel
borderStylenone

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

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

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

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)

API User Guide

(RAND)

Conformance Profile

(RAND)

CTK

Sample Implementation Code

Postman CollectionReleaseLifecycle Status

Alarm Management API

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

TMF642
Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF642_AlarmManagement
NameAlarm Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available 

Not Yet Available  Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957538/TMF642-Alarm-v4.zip?api=v2
NameAlarm Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF642-Alarm-v4-Postman.zip?api=v2
NameAlarm Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

19.5.0

(v4.0.0)

Pre-production

Digital Identity Management API

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

TMF720 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF720_DigitalIdentity
NameDigital Identity Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available 

Not Yet Available 

Not Yet Available 

Not Yet Available 

Not Yet Available 

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

Image Removed

Show If
special@anonymous

Image Removed

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

20.5.0

(v4.0.0)

Pre-production

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

Image Removed

Show If
special@anonymous

Image Removed

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

20.5.0

(v4.0.0)

Pre-production

Event Management API

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

TMF688 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

Image Removed

Show If
special@anonymous

Image Removed

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

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

Image Removed

Show If
special@anonymous

Image Removed

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

Image Removed

Show If
special@anonymous

Image Removed

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

20.0.0

(v4.0.0)

Pre-production

General Test Artifact Management API

This API provides a standardized mechanism for the management of test artifacts that do not fall into the categories managed by TMF704, TMF705, TMF706, TMF707, or TMF709, such as binaries, jars, etc.

TMF710 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF710_GeneralTestArtifact
NameGeneral Test Artifact Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/146293816/TMF710_General_Test_Artifact_Management_API_User_Guide_v4.0.pdf?api=v2
NameGeneral Test Artifact Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

 

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957587/TMF710B_General_Test_Artifact_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameGeneral Test Artifact Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957532/TMF710-GeneralTestArtifact.zip?api=v2
NameGeneral Test Artifact Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

 

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957538/TMF710-GeneralTestArtifact-v4.zip?api=v2
NameGeneral Test Artifact Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957536/TMF710-GeneralTestArtifact-v4-Postman.zip?api=v2
NameGeneral Test Artifact Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

Image Removed

Show If
special@anonymous

Image Removed

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

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/146293800/TMF673B_Geographic_Address_API%20Conformance_Profile_v4.0.0.pdf?api=v2
NameGeographic Address Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

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

Image Removed

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

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

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
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
NameIot Agent and Device API Suite

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

19.0.0

(v4.0.0)

Pre-production

IoT Service Management API Component Suite

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

TMF914 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF914_IoTServiceComponentSuite
NameIoT Service Management API Suite

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/143531023/TMF914_IOT_Service_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameIoT Service Management API Suite

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

20.5.0

(v4.0.0)

Pre-production

Payment Methods API

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

TMF670 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF670_PaymentMethods
NamePayment Methods API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.0

(v4.0.0)

Pre-producion

Performance Management API

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

TMF628 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF628_Performance
NamePerformance Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

20.5.0

(v4.0.0)

Pre-producion

Promotion API

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

TMF671 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF671_Promotion
NamePromotion API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

21.0.0

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

TMF680 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF680_Recommendation
NameRecommendation API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

 

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

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/146293804/TMF680B_Recommendation_Conformance_Profile_v4.0.0.pdf?api=v2
NameRecommendation API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available 

20.5.0

(v4.0.0)

Pre-production

Resource Activation and Configuration API

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

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

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

 

Show If
special@authenticated
matchall
grouptmforum-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 and Configuration API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available  Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957536/TMF702-ResourceActivation-v4-Postman.zip?api=v2
NameResource Activation and Configuration API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

21.0.0

(v4.0.0)

Pre-production

Resource Catalog Management API

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

TMF634 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF634_ResourceCatalog
NameResource Catalog API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/154174131/TMF634B_Resource_Catalog_v4.1.0_conformance.pdf?api=v2
NameResource Catalog API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available Not Yet Available  Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF634-ResourceCatalog-v4-Postman.zip?api=v2
NameResource Catalog API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

19.5.0

(v4.1.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
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
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134776992/TMF664_Resource_Function_Activation_and_Configuration_API_User_Guide_v4.0.0.pdf?api=v2
NameResource Function Activation and Configuration API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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.

TMF652 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF652_ResourceOrderManagement
NameResource Order Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF696_RiskManagement
NameRisk Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957559/TMF696B_Risk_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameRisk Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available  Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957538/TMF696-RiskManagement-v4.zip?api=v2
NameRisk Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available 20.5.0Pre-production

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
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF633_ServiceCatalog
NameService Catalog Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/154174093/TMF633_Service_Catalog_Management_API_User_Guide_v4-0-0.pdf?api=v2
NameService Catalog Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957543/TMF633B_Service_Catalog_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameService Catalog Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF633-ServiceCatalog-v4.0.0.zip?api=v2
NameService Catalog Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available Not Yet Available 

20.5.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
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF641_ServiceOrder
NameService Ordering Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957547/TMF641_Service_Ordering_Management_API_User_Guide_v4.1.0.pdf?api=v2
NameService Ordering Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/170885313/TMF641B_Service_Ordering_API_Conformance_Profile_v4.1.0.pdf?api=v2
NameService Ordering Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

21.0.0

(4.1.0)

Pre-production

Service Problem Management

The SPM API is used to manage service problems. Service problems are generated based on the information declared by a partner or the event information notified from infrastructure providers. The event information includes alarm information, performance anomaly information, trouble ticket information, SLA violation, maintenance information, and prediction information.

TMF656 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF656_ServiceProblemManagement
NameService Problem Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

21.0.0

(v4.0.0)

Pre-production

Service Quality Management API

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

TMF657

 

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF657_ServiceQualityManagement
NameService Quality Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameService Quality Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957551/TMF657_Service_Quality_Management_Conformance_Profile_4.0.0.pdf?api=v2
NameService Quality Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available  Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957538/TMF657-ServiceQualityManagement-v4.zip?api=v2
NameService Quality Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF657-ServiceQualityManagement-v4-Postman.zip?api=v2
NameService Quality Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

19.5.0

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

TMF653 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF653_ServiceTestManagement
NameService Test Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/146293787/TMF653_Service_Test_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameService Test Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/146293791/TMF653B_Service_Test_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameService Test Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available 

21.0.0

(v4.1.0)

Pre-production

Shipping Order Management API

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

TMF700 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF700_ShippingOrder
NameShipping Order Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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

21.0.0

(v4.0.0)

Pre-production

Stock Management API

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

TMF687 Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF687_StockManagement
NameStock Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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


Hide If
special@authenticated


Note
titleTo access the API table links below you will need to be logged in

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

Button Hyperlink
titleLogin
typeprimary
urlhttps://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

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

Button Hyperlink
titleRegister
typeprimary
urlhttps://www.tmforum.org/user-registration/
targettrue




Dialog
idlogin-required
titleLogin Required


Section


Panel
borderStylenone

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

Button Hyperlink
titleLogin
typeprimary
urlhttps://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

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

Button Hyperlink
titleRegister
typeprimary
urlhttps://www.tmforum.org/user-registration/
targettrue




Dialog
idmembers-only
titleFor TM Forum Members


Section


Panel
borderStylenone

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

Button Hyperlink
titleBrowse Released APIs
typeprimary
urlhttps://projects.tmforum.org/wiki/

download

display/

attachments/154174144/TMF687_Stock_Management_API_User_Guide_v4-0-0.pdf?api=v2
NameStock Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/154174157/TMF687B_Stock_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameStock Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous
Image Removed

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

_____________________________________

Document Number

Swagger

(Apache 2.0 or RAND)

API User Guide / Specification

(RAND)

Conformance Profile

(RAND)

CTK

Sample Implementation Code

Postman CollectionReleaseSwagger VersionPublication DateODA DomainNotes

Account Management API

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

TMF666


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
CTK
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957532/TMF687-Stock.zip?api=v2NameStock
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF666-Account-v4.1.0.swagger.json
NameAccount Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If
special@anonymous
Image Removed
@anonymous

Image Added


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@authenticated
matchallRI
grouptmforum-members


Trackinglink
TypeSwagger
Type
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF687-Stock-v4.zip?api=v2NameStock
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF655-Change-v4.0.0.swagger.json
NameChange Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-membersImage Removed
@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
@anonymousImage Removedspecial
Show If
@authenticated
matchall
grouptmforum-members


Trackinglink
Type
Postman
Swagger
Licence
RAND
Apache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957536/TMF687-Stock-v4-Postman.zip?api=v2NameStock
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 API

 



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

Image Removed

Show If
special@anonymous

Image Removed

21.0.0

(v4.0.0

Pre-Production

Test Case Management API

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

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

TMF704


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


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/TMF704_TestCaseNameTest Case Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous
Image Removed
Beta/4.0.0/swagger/TMF720-DigitalIdentity-v4.0.0.swagger.json
NameDigital Identity Management API.

 



Show If
special
@authenticated
@anonymous
match
allgrouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/146293898/TMF704_Test_Case_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameTest Case Management API

 


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
matchall
group
not-
tmforum-members

Image Removed

Show If
special@anonymous
Image Removed


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

 



Show If
special
@authenticated 
@anonymous
matchallgrouptmforum-members Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957563/TMF704B_Test_Case_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameTest Case Management API
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 (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
group
not-
tmforum-members
Image Removed


Trackinglink
show-if
Type
special
Swagger
@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
TrackinglinkTypeCTK
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957532/TMF704-TestCase.zip?api=v2NameTest Case Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

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 API

 



Show If
special@anonymous
Image Removed

 



Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
RI
Specification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF704-TestCase-v4.zip?api=v2NameTest Case Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

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 Removed


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
Postman
CTK-Conformance
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957536/TMF704-TestCase-v4-Postman.zip?api=v2NameTest Case
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

 



Show If
special
@authenticated
@anonymous
match

Image Removed

Show If
special@anonymous

Image Removed

21.0
allgroupnot-tmforum-members


Not yet available Not yet available Not yet available
21.5.0
(
v4.0.0
)TMF706
Pre-production

Test Data Management API

This API provides a standardized mechanism for the management of test data artifacts used for test case parameterization. These include Test Data Schemas and Test Data Instances.

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


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/
tmforum-apis/TMF706_TestDataNameTest Data
Beta/4.0.0/swagger/TMF691-FederatedIdentity-v4.0.0.swagger.json
NameFederated ID Management API

 



Show If
special
@authenticatedmatchall

Image Removed

Show Ifspecial
groupnot-tmforum-members
@anonymous
Image Removed


Show If
special@authenticated
match
all
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/146293820/TMF706_Test_Data_Management_API_User_Guide_v4.0.0.pdf?api=v2NameTest Data
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@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous
Image Removed
if
special@anonymous

Image Added


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

Geographic Location Management API

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

TMF675


Show If
special@authenticated
match
all
grouptmforum-members


Trackinglink
Type
CTK-Conformance
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957571/TMF706B_Test_Data_API_Conformance_Profile_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF675-GeographicLocation-v4.0.0.
pdf?api=v2
swagger.json
Name
Test Data
Geographic Location Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If
special@anonymous
Image Removed
@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@authenticated
match
all
grouptmforum-members


Trackinglink
Type
CTK
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957532/TMF706-TestData.zip?api=v2NameTest Data Management API
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF921-Intent-v4.0.0.swagger.json
NameIntent

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

 

@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

IoT Agent and Device Management API

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

TMF908


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
RI
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF706-TestData-v4.zip?api=v2NameTest Data Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
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

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
PostmanLicenceRANDLinkhttps://projects.tmforum.org/wiki/download/attachments/162957536/TMF706-TestData-v4-Postman.zip?api=v2NameTest Data Management API 
Specification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF908_IoT_Device_Management_API_Component_Suite_user_guides_21.5.0.pdf
NameIoT Agent and Device Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-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
match
all
group
not-
tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

21.0.0

(v4.0.0)

Pre-production

Test Environment Management API

This API provides a standardized mechanism for the management of test artifacts related to test environment specification. These include Abstract Test Environments, Concrete Environment Metamodels used to map abstract environments to concrete test resources, Environment Provisioning Artifacts, and Test Resource APIs exposed to test cases.

TMF705


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

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
Type
Swagger
Specification PDF
Licence
Apache 2.0
RAND
Linkhttps://
github.com/tmforum-apis/TMF705_TestEnvironmentNameTest Environment Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed 
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF914_IoT_Service_Management_API_Component_Suite_user_guides_21.5.0.pdf
NameIoT Service Management API

 



Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/146293812/TMF705_Test_Environment_Management_API_REST_User_Guide_v4.0.0.pdf?api=v2
NameTest Environment Management API
Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Product, Common, Resource, Service

Metadata Catalog Management API

Metadata Catalog

TMF725


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

Image Removed

Show If
special@anonymous
Image Removed


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

 



Show If
special
@authenticated Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
@anonymous
matchallgrouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/162957567/TMF705B_Test_Environment_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameTest Environment Management API

 

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

Image Removed

Show Ifspecial
@authenticated
matchall
grouptmforum-members


Trackinglink
Type
CTK
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957532/TMF705-TestEnvironment.zip?api=v2NameTest Environment
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF669-PartyRole-v4.1.0.swagger.json
NameParty Role Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

 
@anonymous

Image Added


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

Performance Management API

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

TMF628


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
RI
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF705-TestEnvironment-v4.zip?api=v2NameTest Environment
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF628-Performance-v4.0.0.swagger.json
NamePerformance Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

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


Trackinglink
Type
Postman
Swagger
Licence
RAND
Apache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957536/TMF705-TestEnvironment-v4-Postman.zip?api=v2NameTest Environment
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
@authenticatedmatchall
@anonymous

Image Added



Show If
special@authenticated
group
not-
tmforum-members


Trackinglink

Image Removed

Show If
special@anonymous

Image Removed

21.0.0

(v4.0.0)

Pre-production

Test Execution Management API

This API provides a standardized mechanism for test case, test suite, and non-functional test model execution. This also includes allocation and provisioning of test environments for test execution.

TMF708
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
@authenticated
@anonymous
match
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/TMF708_TestExecutionNameTest Execution
/Beta/4.1.0/conformance/TMF701_Process_Flow_Management_Conformance-v4.1.0.pdf
NameProcess Flow Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If
special@anonymous
Image Removed
@anonymous

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


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
Specification PDF
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/146293829/TMF708_Test_Execution_Management_API_User_Guide_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF671-Promotion-v4.0.0.
pdf?api=v2
swagger.json
Name
Test Execution
Promotion Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If
special@anonymous
Image Removed
@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

Recommendation Management API

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

TMF680


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
CTK-Conformance
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957579/TMF708B_Test_Execution_API_Conformance_Profile_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF680-Recommendation-v4.0.0.
pdf?api=v2
swagger.json
Name
Test Execution
Recommendation Management API

 



Show If
special
@authenticatedmatch

Image Removed

Show Ifspecial
allgroupnot-tmforum-members
@anonymous
Image Removed
Not Yet Available 



Show If
special
@authenticatedmatch
all
@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
Licence
RI
RAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF708-TestExecution-v4.zip?api=v2NameTest Execution

Image Removed

Show Ifspecial
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
@authenticatedmatchallgroupnot-tmforum-members
@anonymous
Image Removed


show-
ifspecial@authenticatedmatchallgrouptmforum-members
if
special@authenticated


Trackinglink
Type
Postman
CTK-Conformance
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957536/TMF708-TestExecution-v4-Postman.zip?api=v2NameTest Execution
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF680_Recommendation_API_conformance_21.5.0.pdf
NameRecommendation Management API

 



Show If
special
@authenticated
@anonymous
match

Image Removed

Show If
special@anonymous
Image Removed
allgroupnot-tmforum-members


Not yet available Not yet available Not yet available
21.
0
5.0
(
v4.0.0
)Test Result
Pre-productionTMF707
22-Nov-2021Customer

Resource Activation Management API

This API provides a standardized mechanism for the management of test results. These include Test Case Results, Test Suite Results, and Non-functional Test Results.

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


Trackinglink
TypeSwagger
LicenceApache 2
.0Linkhttps://github.com/tmforum-apis/TMF707_TestResultNameTest Result

Image Removed

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

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members
@anonymous
Image Removed


Show If
special@authenticated
match
all
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/146293824/TMF707_Test_Result_Management_API_User_Guide_v4.0.0.pdf?api=v2NameTest Result Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF702_Resource_Activation_and_Configuration_API_user_guides_21.5.0.pdf
NameResource Activation Management API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated
matchallgrouptmforum-members


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957575/TMF707B_Test_Result_API_Conformance_Profile
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF702_Resource_Activation_v4.0.0_conformance.pdf
?api=v2
Name
Test Result
Resource Activation Management API

 

Show Ifspecial@authenticatedmatchallgroupnot-tmforum-members

Image Removed



Show If
special@anonymous

Image Modified



Show If
special@authenticated
matchallgroup
tmforum-members


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957532/TMF707-TestResult.zip?api=v2NameTest Result Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

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

 



Show If
special@anonymous
Image Removed

 



Show If
special@authenticated
matchallgroup
tmforum-members


Trackinglink
TypeRI
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF707-TestResult-v4.zip?api=v2NameTest Result Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ri/TMF702_Resource_activation.zip
NameResource Activation Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
matchallgrouptmforum-members


Trackinglink
TypePostman
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957536/TMF707-TestResult-v4-Postman.zip?api=v2NameTest Result Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/postman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zip
NameResource Activation Management API

 



Show If
special@anonymous

Image Modified


21.
0
5.0
(
v4.0.0
)Test Scenario Management
Pre-production
22-Nov-2021Resource, Common

Resource Function Activation and Configuration API

This API

provides a standardized mechanism for the management of test scenarios. Test scenarios provide a full specification of required test elements, e. g. Test Case T parameterized with test data instance D running on abstract test environment E provisioned with a set of provisioning artifacts P.TMF709

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

TMF664


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com
/tmforum-apis/TMF709_TestScenarioNameTest Scenario Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
/Beta/4.0.0/swagger/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json
NameResource Function Activation and Configuration 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/146293833/TMF709_Test_Scenario_Management_API_User_Guide_v4.0.0.pdf?api=v2NameTest Scenario Management API

 

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

 



Show If
special@anonymous

Image Added


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

Sales Management API

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

TMF699


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


Trackinglink
show-if
Type
special
Swagger
@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
TrackinglinkTypeCTK-Conformance
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957583/TMF709B_Test_Scenario_API_Conformance_Profile_v4.0.0.pdf?api=v2NameTest Scenario Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

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

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
CTK
Specification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957532/TMF709-TestScenario.zip?api=v2NameTest Scenario

Image Removed

Show If
special@anonymous
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF699_Sales_Management_API_REST_Specification_v4.1.0.pdf
NameSales Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members
@anonymous

Image Added


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

Service Usage Management API

TMF727


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
RI
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF709-TestScenario-v4.zip?api=v2NameTest Scenario
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
@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If
special@anonymous
Image Removed
@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
match
allNameTest Scenario
grouptmforum-members


Trackinglink
Type
PostmanLicenceRANDLinkhttps://projects.tmforum.org/wiki/download/attachments/162957536/TMF709-TestScenario-v4-Postman.zip?api=v2
Swagger
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
@authenticated
@anonymous
match

Image Removed

Show If
special@anonymous

Image Removed

21
allgroupnot-tmforum-members


Not yet available Not yet available Not yet available Not yet available Not yet available
v4.0.0

(v4.0.0)

Pre-productionUsage Consumption TMF677
10-Jan-2022Business Partner

Shipping Order 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.

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

TMF700


Show If
special@authenticated
matchall
grouptmforum-members


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

 



Show If
special
@authenticated
@anonymous

Image Added



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


Trackinglink
Show If
special@anonymous

Image Removed

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

21.0.0

(v4.0.0)

Pre-production

User Roles & Permissions API

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

TMF672
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
@authenticated
@anonymous
match
all



Show If
group
special
tmforum-members
@authenticated


Trackinglink
Type
Swagger
CTK-Conformance
Licence
Apache 2.0
RAND
Linkhttps://
github.com/tmforum-apis/TMF672_UserRolesPermissionsNameUser Roles & Permissions
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
@authenticatedmatchallgroupnot-tmforum-members

Image Removed

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-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
match
all
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/TMF623-SLA-v4.0.0.
pdf?api=v2
swagger.json
Name
User Roles & Permissions
SLA Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members

Image Removed

Show If
special@anonymous
Image Removed
@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

Usage Consumption Management API

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

TMF677


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
Type
CTK-Conformance
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/146293796/TMF672B_User_Role_Permission_Conformance_Profile_v4.0.0.pdf?api=v2NameUser Roles & Permissions API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
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 Removed
Not yet available Not yet available Not yet available Not
Yet Available Not Yet Available 
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
grouptmforum-members


Trackinglink
Type
Postman
Swagger
Licence
RAND
Apache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/143534323/TMF672-UserRolePermission-v4-Postman.zip?api=v2NameUser Roles & Permissions
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF697-WorkOrder-v4.0.0.swagger.json
NameWork Order Management API

 



Show If
special
@authenticated
@anonymous
match

Image Removed

Show If
special@anonymous

Image Removed

20.5.0

(
allgroupnot-tmforum-members


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

 

 

 







HTML
<script type="text/javascript">
function>function trackclick(url,type,api,email){
	woopra.track("click", {
    	 
 var myForm = MktoForms2.allForms()[0];
 myForm.addHiddenFields({
 //These are the values which will be submitted to Marketo
 "document type": type,
    	title: api,
		 "strategic program": "Open API Program",
		 program: "API Project",
		 topic: "API",
		 app: "Confluence",
		 permalink: url
		
	}
,,
 Email: email
 });
 myForm.submit();
 
redirect(url)
);
//	alert("will redirect to " + url);
}
function redirect(url){
	 window.open(url);
}
</script>