Page tree

Versions Compared

Key

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

...

Early Adoption (Beta) Versions

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


TMF642
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

Sample Implementation Code

Postman CollectionReleaseSwagger Version
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.

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


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF642_AlarmManagementName Alarm Management API
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
@authenticated
@anonymous
match
allgroup not-tmforum-members

Image Removed

Show If
special @anonymous
Image Removed


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


Trackinglink
Type
Specification PDF
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134776981/TMF642_Alarm_Management_API_User_Guide_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF655-Change-v4.0.0
.pdf?api=v2
.swagger.json
Name
Alarm Image Removed
Change Management API
Show If
special @authenticated
match all
group not-tmforum-members

 



Show If
special@anonymous
Image Removed
Not
Yet Available
yet available Not
Yet Available Show Ifspecial @authenticatedmatch all
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
grouptmforum-members


Trackinglink
Type
RI
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF642-Alarm-v4.zip?api=v2Name Alarm Management API
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
@authenticated
@anonymous
matchName Alarm Management API
allgroup not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
TrackinglinkType PostmanLicence RANDLink https://projects.tmforum.org/wiki/download/attachments/143534323/TMF642-Alarm-v4-Postman.zip?api=v2


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
match all
group
not-
tmforum-members
Image Removed


Trackinglink
show-if
Type
special
Swagger
@anonymous

Image Removed

19.5 TMF720
LicenceApache 2.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.

Linkhttps://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
@authenticated
@anonymous
matchName Digital Identity Management API
allgroup tmforum-members TrackinglinkType SwaggerLicence Apache 2.0Link https://github.com/tmforum-apis/TMF720_DigitalIdentity


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


Trackinglink
show-if
Type
special
Swagger
@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
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
match
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous
Image Removed
allgroup tmforum-members Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF662_EntityCatalog
Name Entity Catalog 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
match all
grouptmforum-members


Trackinglink
Type
Specification PDF
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/172125892/TMF662_Entity_Catalog_Management_API_User_Guide_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF688-Event-v4.0.0
.pdf?api=v2
.swagger.json
Name
Entity Catalog Image Removed
Event Management API
Show If
special @authenticated
match all
group not-tmforum-members

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
Type
CTK-Conformance
Specification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/176325446/TMF662B_Entity_Catalog_Conformance_Profile_v4.0.0.pdf?api=v2Name Entity Catalog Management APIImage 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
@authenticatedmatch allgroup not-tmforum-members
@anonymous

Image Added



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

Image Removed

Show If
special @anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Postman
Licence RAND
Link https://projects.tmforum.org/wiki/download/attachments/162957536/TMF702-ResourceActivation-v4-Postman.zip?api=v2
Name Resource Activation and Configuration API
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

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 Ifspecial @authenticatedmatch all


Trackinglink
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
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF703_EntityInventory
Name Entity Inventory Management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

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

20.5.0

(v4.0.0)

Pre-production

Event Management API

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

TMF688 Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF688-Event
Name Event management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Specification PDF
Link https://projects.tmforum.org/wiki/download/attachments/162957555/TMF688_Event_Management_API_User_Guide_v4.0.0.pdf?api=v2
Name Event Management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type CTK-Conformance
Link https://projects.tmforum.org/wiki/download/attachments/172125911/TMF688B_Event_API_Conformance_Profile_v4.0.0.pdf?api=v2
Name Event Management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available

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
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF691_FederatedIdentity
Name Federated Identity API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Specification PDF
Link https://projects.tmforum.org/wiki/download/attachments/134792909/TMF691_Federated_ID_Management_API_User_Guide_v4.0.0.pdf?api=v2
Name Federated Identity API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

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

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
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF673_GeographicAddress
Name Geographic Address Management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Specification PDF
Link https://projects.tmforum.org/wiki/download/attachments/134792893/TMF673_Geographic_Address_Management_API_User_Guide_v4.0.0.pdf?api=v2
Name Geographic Address Management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type CTK-Conformance
Link https://projects.tmforum.org/wiki/download/attachments/146293800/TMF673B_Geographic_Address_API%20Conformance_Profile_v4.0.0.pdf?api=v2
Name Geographic Address Management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available

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
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF675_GeographicLocation
Name Geographic Location Management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

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

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
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF908_IoTAgentAndDeviceComponentSuite
Name Iot Agent and Device API Suite
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Specification PDF
Link https://projects.tmforum.org/wiki/download/attachments/123085401/TMF908_IoT_Agent_and_Device_Component_Suite_REST_Specification_v1.0.1.pdf?version=1&modificationDate=1592864314038&api=v2
Name Iot Agent and Device API Suite
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

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

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
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF914_IoTServiceComponentSuite
Name IoT Service Management API Suite
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Specification PDF
Link https://projects.tmforum.org/wiki/download/attachments/143531023/TMF914_IOT_Service_Management_API_User_Guide_v4.0.0.pdf?api=v2
Name IoT Service Management API Suite
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

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

20.5.0

(v4.0.0)

Pre-production

Payment Method API

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

TMF670 Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF670_PaymentMethods
Name Payment Methods API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Specification PDF
Link https://projects.tmforum.org/wiki/download/attachments/176327026/TMF670_Payment_Method_Management_API_User_Guide_v4.0.0.pdf?api=v2
Name Payment Methods API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

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

21.0.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
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF628_Performance
Name Performance Management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

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

20.5.0

(v4.0.0)

Pre-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
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF671_Promotion
Name Promotion API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

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

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
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF680_Recommendation
Name Recommendation API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Specification PDF
Link https://projects.tmforum.org/wiki/download/attachments/134777000/TMF680_Recommendation_Management_API_User_Guide_v4.0.0.pdf?api=v2
Name Recommendation API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type CTK-Conformance
Link https://projects.tmforum.org/wiki/download/attachments/146293804/TMF680B_Recommendation_Conformance_Profile_v4.0.0.pdf?api=v2
Name Recommendation API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available

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
match all
group tmforum-members
Trackinglink
Type Swagger
Licence Apache 2.0
Link https://github.com/tmforum-apis/TMF702-ResourceActivationConfiguration
Name Resource Activation and Configuration API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type Specification PDF
Link https://projects.tmforum.org/wiki/download/attachments/134792913/TMF702_Resource_Activation_Management_API_User_Guide_v4.0.0.pdf?api=v2
Name Resource Activation and Configuration API
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF688_Event_Management_API_conformance_21.5.0.pdf
NameEvent Management API

 



Show If
special@anonymous

Image Added


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

Federated ID Management API

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

TMF691


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF634_ResourceCatalogName Resource Catalog API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF691-FederatedIdentity-v4.0.0.swagger.json
NameFederated ID Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/154174119/TMF634_Resource_Catalog_Management_API_User_Guide_v4.1.0.pdf?api=v2Name Resource Catalog API
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
@authenticatedmatch allgroup not-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
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/154174131/TMF634B_Resource_Catalog_v4.1.0_conformance.pdf?api=v2Name Resource Catalog API
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 API

 



Show If
special
@authenticatedmatch allgroup not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Not Yet Available Not Yet Available
@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
Postman
Swagger
Licence
RAND
Apache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/143534323/TMF634-ResourceCatalog-v4-Postman.zip?api=v2Name Resource Catalog 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
@authenticated
@anonymous
match

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

Image Removed

Show If
special @anonymous

Image Removed

19.5.0

(v4.1.0)

Pre-production


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


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF664_ResourceFunctionActivationConfigurationName Resource Function Activation and Configuration API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0.0.swagger.json
NameIoT Agent and Device Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134776992/TMF664_Resource_Function_Activation_and_Configuration_API_User_Guide_v4.0.0.pdf?api=v2Name Resource Function Activation and Configuration API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/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 Modified


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
) TMF696
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.

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


Trackinglink
TypeSwagger
Licence
Apache 2.0Link https://github.com/tmforum-apis/TMF696_RiskManagementName Risk Management API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
Apache 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 Removed


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
TypeSpecification PDF
Link https://projects.tmforum.org/wiki/download/attachments/146293808/TMF696_Risk_Management_API_User_Guide_v4.0.0.pdf?api=v2Name Risk Management API
LicenceRAND
Linkhttps://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
@authenticatedmatch allgroup not-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
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
grouptmforum-members


Trackinglink
Type
CTK-Conformance
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957559/TMF696B_Risk_Management_API_Conformance_Profile_
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
Risk
Metadata Catalog Management API

 



Show If
special
@authenticatedmatch allgroup not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Not Yet Available
@anonymous

Image Added


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

Party Role Management API

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

TMF669


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
Type
RI
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF696-RiskManagement-v4.zip?api=v2Name Risk Management API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF669-PartyRole-v4.1.0.swagger.json
NameParty Role Management API

 



Show If
special@anonymous

Image Removed

Not Yet Available 20.5.0 Pre-production

Service Catalog API

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

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


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF633_ServiceCatalogName Service Catalog Management API
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
@authenticatedmatch allgroup not-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
match all
grouptmforum-members


Trackinglink
Type
Specification PDF
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/154174093/TMF633_Service_Catalog_Management_API_User_Guide_v4-0-0.pdf?api=v2Name Service Catalog Management API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF701-ProcessFlow-v4.1.0.swagger.json
NameProcess Flow Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
Type CTK-Conformance
Link https://projects.tmforum.org/wiki/download/attachments/162957543/TMF633B_Service_Catalog_API_Conformance_Profile_v4.0.0.pdf?api=v2
Name Service Catalog Management API
Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF701_Process_Flow_Management_API_Specification_v4.1.0.pdf
NameProcess Flow Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
match


Trackinglink
all tmforum
Type
group
CTK-
members
Conformance
trackinglink CTK
Licence
Type
RAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/143532500/TMF633-ServiceCatalog-v4.0.0.zip?api=v2Name Service Catalog Management API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/conformance/TMF701_Process_Flow_Management_Conformance-v4.1.0.pdf
NameProcess Flow Management API

 



Show If
special@anonymous

Image Added

Image Removed


Not yet available Not
Yet Available
yet available Not
Yet Available
yet available
20
19.
5
0.
0
1
(
v4.
0
1.0
) TMF641
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-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
match all
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/
tmforum-apis/TMF641_ServiceOrderName Service Ordering Management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous
Image Removed
Beta/4.0.0/swagger/TMF671-Promotion-v4.0.0.swagger.json
NamePromotion Management API

 



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

Image Removed

Show If
special @anonymous
Image Removed
allgroup tmforum-members Trackinglink
Type Specification PDF
Link https://projects.tmforum.org/wiki/download/attachments/162957547/TMF641_Service_Ordering_Management_API_User_Guide_v4.1.0.pdf?api=v2
Name Service Ordering 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-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
match all
grouptmforum-members


Trackinglink
Type
CTK-Conformance
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/170885313/TMF641B_Service_Ordering_API_Conformance_Profile_v4.1.0.pdf?api=v2Name Service Ordering Management API
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF680-Recommendation-v4.0.0.swagger.json
NameRecommendation Management API

 



Show If
special
@authenticatedmatch all
@anonymous

Image Added



Show If
special@authenticated
group
not-
tmforum-members


Trackinglink

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
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
@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/TMF656_ServiceProblemManagementName Service Problem Management API
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
@authenticatedmatch allgroup not-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-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
Specification PDF
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/172125882/TMF656_Service_Problem_Management_API_User_Guide_v4.0.0.pdf?api=v2Name Service Problem Management API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF702-ResourceActivation-v4.0.0.swagger.json
NameResource Activation Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
Type
CTK-Conformance
Specification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/172125888/TMF656B_Service_Problem_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2Name Service Problem Management APIImage 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
@authenticatedmatch allgroup not-tmforum-members
@anonymous

Image Added



Show If
special@authenticated


Trackinglink
@anonymous
Type

Image Removed

Not Yet Available Not Yet Available Not Yet Available

21.0.0

(
CTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF702_Resource_Activation_v4.0.0
) Pre-production

Service Quality Management API

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

TMF657
_conformance.pdf
NameResource Activation Management API

 



Show If
special
@authenticated
@anonymous
match
all



Show If
group
special
tmforum-members
@authenticated


Trackinglink
Type
Swagger
CTK
Licence
Apache 2.0
RAND
Linkhttps://
github.com/tmforum-apis/TMF657_ServiceQualityManagementName Service Quality Management API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ctk/TMF702-ResourceActivation.zip
NameResource Activation Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
match


Trackinglink
all
Type
groupType Specification PDF
RI
tmforum-members Trackinglink
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_API_User_Guide_v4.0.0.pdf?api=v2Name Service Quality Management API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ri/TMF702_Resource_activation.zip
NameResource Activation Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
match


Trackinglink
all
Type
groupType CTK-Conformance
Postman
tmforum-members Trackinglink
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957551/TMF657_Service_Quality_Management_Conformance_Profile_4.0.0.pdf?api=v2Name Service Quality Management API
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/postman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zip
NameResource Activation Management API

 



Show If
special
@authenticatedmatch allgroup not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Not Yet Available
@anonymous

Image Added


21.5.0
v4.0.0
22-Nov-2021Resource, Common

Resource Function Activation and Configuration API

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

TMF664


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
Type
RI
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF657-ServiceQualityManagement-v4.zip?api=v2Name Service Quality Management API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json
NameResource Function Activation and Configuration API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
Type
Postman
Specification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/
projects
4.
tmforum
0.
org
0/
wiki/download/attachments/143534323/TMF657-ServiceQualityManagement-v4-Postman.zip?api=v2Name Service Quality Management API
user_guides/TMF664_Resource_Function_Activation_Management_API_REST_Specification_v4-0-0.pdf
NameResource Function Activation and Configuration API

 



Show If
special
@authenticated
@anonymous
match

Image Removed

Show If
special @anonymous

Image Removed

19.5.0

(
allgroup not-tmforum-members


Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.0.0
) TMF700
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.

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


Trackinglink
TypeSwagger
LicenceApache
2.0Link https://github.com/tmforum-apis/TMF700_ShippingOrderName Shipping Order Management API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

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

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
2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF699-Sales-v4.1.0.swagger.json
NameSales Management API

 



Show If
special
@authenticatedmatch all
@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
Type
Swagger
Specification PDF
Licence
Apache 2.0
RAND
Linkhttps://
github.com/tmforum-apis/TMF708_TestExecutionName Test Execution Management API
Show If
special @authenticated
match all
group not-tmforum-members

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@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
match all
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/TMF727-ServiceUsage-v4.0.0
.pdf?api=v2
.swagger.json
Name
Test Execution
Service Usage Management API

 



Show If
special
@authenticatedmatch allgroup not-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 all
grouptmforum-members


Trackinglink
Type
trackinglink CTK-Conformance
Swagger
Type
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/TMF711-ShipmentManagement-v4.0.0
.pdf?api=v2
.swagger.json
Name
Test Execution
Shipment Management Management API

 



Show If
special
@authenticatedmatch allgroup not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Not Yet Available
@anonymous

Image Added


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

Shipping Order Management API

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

TMF700


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
Type
RI
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957538/TMF708-TestExecution-v4.zip?api=v2Name Test Execution Management API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF700-ShippingOrder-v4.0.0.swagger.json
NameShipping Order Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
match all
grouptmforum-members


Trackinglink
Type
Postman
Specification PDF
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957536/TMF708-TestExecution-v4-Postman.zip?api=v2Name Test Execution Management API
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

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
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/TMF677_UsageConsumptionName Usage Consumption API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF700_Shipping_Order_v4.0.0_conformance.pdf
NameShipping Order Management API

 



Show If
special@anonymous
Image Removed
Not
Yet Available
yet available Not
Yet Available Not Yet Available Not Yet Available Not Yet Available
yet available Not yet available
21.
0
5.0
(
v4.0.0
) TMF672
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.

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
SwaggerLicence Apache 2.0Link https://github.com/tmforum-apis/TMF672_UserRolesPermissionsName User Roles & Permissions API Show If
special @authenticated
match all
group not-tmforum-members
Image Removed
Swagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF623-SLA-v4.0.0.swagger.json
NameSLA Management API

 



Show If
special@anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
TrackinglinkType Specification PDFLink https://projects.tmforum.org/wiki/download/attachments/134792889/TMF672_User_Role_Permission_Management_API_User_Guide_v4.0.0.pdf?api=v2Name User Roles & Permissions API
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
match all
group
not-
tmforum-members


Trackinglink
Image Removed
Type
show-if
Swagger
special @anonymous

Image Removed

Show If
special @authenticated
match all
group tmforum-members
Trackinglink
Type CTK-Conformance
Link https://projects.tmforum.org/wiki/download/attachments/146293796/TMF672B_User_Role_Permission_Conformance_Profile_v4.0.0.pdf?api=v2
Name User Roles & Permissions API
Show If
special @authenticated
match all
group not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed

Not Yet Available Not Yet Available
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF677-UsageConsumption-v4.0.1.swagger.json
NameUsage Consumption Management 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
match all
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=v2Name User Roles & Permissions API
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

20.5.0

(
allgroup not-tmforum-members

Image Removed

Show If
special @anonymous

Image Removed


Not yet available Not yet available Not yet available Not yet available Not yet available
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 trackclick(url,type,api,email){
 
 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>

...