Versions Compared

Key

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

...

Digital Identity
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 StatusTMF720
Show If
special@authenticated
matchall
Publication DateODA DomainNotes

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

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
NameDigital Identity Management API
Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF720_DigitalIdentity
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@anonymous
Image Removed
Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available
21.5.0
4
v4.
0
1.0
Pre-production
10-Jan-2022Business Partner, Customer

Change

Entity Inventory TMF703

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.

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

TMF655


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
githubNameEntity Inventory Management API
Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/
tmforum-apis/TMF703_EntityInventory
Beta/4.0.0/swagger/TMF655-Change-v4.0.0.swagger.json
NameChange Management API

 



Show If
special@anonymous
Image Removed
Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available

21.5.0

yet available
v4
4
.0.0
Pre-production
10-Jan-2022Common

Customer360

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.

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
TMF688


Show If
special@authenticated
match
all
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF688-EventNameEvent 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
match
allgroupnot-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 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
grouptmforum-members


Trackinglink
Type
CTK-Conformance
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/172125911/TMF688B_Event_API_Conformance_Profile_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF720-DigitalIdentity-v4.0.0.
pdf?api=v2
swagger.json
Name
Event
Digital Identity Management API
Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

.

 



Show If
special@anonymous
Image Removed
Not
Yet Available
yet available Not
Yet Available
yet available Not yet available Not yet available Not yet available
Not Yet Available
21.5.0
4
v4.0.0
Pre-production
22-Nov-2021Business Partner, Common

Entity Inventory Management

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, …).

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

TMF703
TMF691


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
githubNameFederated Identity API
Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/
tmforum-apis/TMF691_FederatedIdentity
Beta/4.0.0/swagger/TMF703-EntityInventory-v4.0.0.swagger.json
NameEntity Inventory 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/134792909/TMF691_Federated_ID_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameFederated Identity 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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://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 Added

Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Show If
special@anonymous

Image Removed

Not Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

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


Trackinglink
Type
Swagger
Specification PDF
Licence
Apache 2.0
RAND
Linkhttps://
github.com/tmforum-apis/TMF675_GeographicLocation
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF688_Event_Management_API_user_guides_21.5.0.pdf
NameEvent Management API

 



Show If
special@anonymous

Image Added

NameGeographic Location Management API Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed



Show If
special
@anonymous
@authenticated
Image Removed


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

21.5.0

TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.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.

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


Show If
special@authenticated
matchallNameIot Agent and Device API Suite
Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF908_IoTAgentAndDeviceComponentSuite
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
group
allgroupNameIot Agent and Device API Suite
Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

tmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
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
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF691_Federated_Identity_API_user_guides_21.5.0.pdf
NameFederated ID Management API

 



Show If
special@anonymous

Image Modified


Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available
21.5.0
4
v4.0.0
Pre-production
22-Nov-2021Common

Geographic Location Management API

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

TMF675

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
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/
tmforum-apis/TMF914_IoTServiceComponentSuite
Beta/4.0.0/swagger/TMF675-GeographicLocation-v4.0.0.swagger.json
NameGeographic Location Management API

 

NameIoT Service Management API Suite



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

Image Removed

Show If
special@anonymous

Image Removed

Show If


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


Trackinglink
Type
Specification PDF
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/143531023/TMF914_IOT_Service_Management_API_User_Guide_
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF921-Intent-v4.0.0
.pdf?api=v2
.swagger.json
Name
IoT Service Management API Suite
Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

Intent

 



Show If
special@anonymous
Image Removed
Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not yet available
22.0
21.5
.0
4
v4.0.0
Pre
08-06-
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
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
matchallNamePayment Methods API
Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF670_PaymentMethods
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/176327026/TMF670_Payment_Method
tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF908_IoT_Device_Management_API_Component_Suite_
User
user_
Guide
guides_
v4
21.
0
5.0.pdf
?api=v2
Name
Payment Methods
IoT Agent and Device Management API

 



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

Image Removed

Show If
special@anonymous

Image Removed

Not Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available


Not yet available Not yet available Not yet available Not yet available
21.5.0
4
v4.0.0
Pre-production

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.

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
TMF628


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/TMF628_Performance
Beta/4.0.0/swagger/TMF914-IotService-v4.0.0.swagger.json
Name
Performance
IoT Service Management API

 



Show If
special
@authenticatedmatchallgroupnot-tmforum-members
@anonymous

Image Added

Image Removed



Show If
special
@anonymous
@authenticated

Image Removed

Not Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

Process Flow Management API

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

  • A ProcessFlow will describe an orchestration of TaskFlow
  • In event-based architecture the processFlow are triggered as consequence of event
  • TaskFlow could be completed automatically (rules, event triggered, process delegation) or requiring manual action
  • Operations on taskFlow allow to update taskFlow
TMF701 Show If
grouptmforum-members


Trackinglink
TypeSpecification PDF
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@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
grouptmforum-members
special@authenticated


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

 

NameProcess Flow Management API



Show If
special@anonymous

Image Removed

Show If
special@authenticated
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
TrackinglinkTypeSpecification PDFLinkhttps://projects.tmforum.org/wiki/download/attachments/128869433/TMF701_Process_Flow_Management_API_REST_Specification_R19.0.1.pdf?version=1&modificationDate=1585949431000&api=v2NameProcess Flow Management API


Show If
special
@anonymous
@authenticated
Image Removed
group
show
tmforum-
if
members
special


Trackinglink
@authenticated
Type
trackinglink
Swagger
Type
LicenceApache 2.0
CTK-ConformanceNameProcess Flow Management API
Linkhttps://
projects.tmforum.org/wiki/download/attachments/128869433/TMF701B_Process_Flow_Management_Conformance_Profile_R19.0.1.pdf?version=1&modificationDate=1585949500000&api=v2
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
Not yet available Not yet available
Image Removed
Not yet available Not yet available Not yet available
19
22.0.
1
0
(
v4.
0
1.0
)
Pre-production

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


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://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@anonymous

Image Added


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

Process Flow Management API

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

TMF701


Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://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


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


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

 



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

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


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://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@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF680_Recommendation_API_conformance_21.5.0.pdf
NameRecommendation 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-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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.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@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


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

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://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 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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://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 Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/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
grouptmforum-members


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

 



Show If
special@anonymous

Image Added

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

21.5.0

4.0.0Pre-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
Type
Swagger
Specification PDF
Licence
Apache 2.0
RAND
Linkhttps://
github.com/tmforum-apis/TMF680_Recommendation
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

 

NameRecommendation API
Show If
special@anonymous

Image Removed



Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

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 PDFLink
Swagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF727-ServiceUsage-
https://projects.tmforum.org/wiki/download/attachments/134777000/TMF680_Recommendation_Management_API_User_Guide_
v4.0.0
.pdf?api=v2
.swagger.json
Name
Recommendation
Service 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
matchall
grouptmforum-members


Trackinglink
Type
CTK-Conformance
Swagger
LicenceApache 2.0
Linkhttps://
projects.tmforum.org/wiki/download/attachments/146293804/TMF680B_Recommendation_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
Recommendation API Show If
special@authenticated
matchall
groupnot-tmforum-members
Shipment Management Management API

 

Image Removed



Show If
special@anonymous
Image Removed
Not yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available

21.5.0

yet available Not yet available
v4
4
.0.0
Pre-production
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

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
allNameResource Activation and Configuration API
Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF702-ResourceActivationConfiguration
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
Specification PDFLinkhttps://projects.tmforum.org/wiki/download/attachments/134792913/TMF702_Resource_Activation
Specification 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_
User
REST_
Guide
Specification_v4
.
-0
.
-0.pdf
?api=v2
Name
Resource Activation and Configuration API
Shipping Order Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed



Show If
special@anonymous

Image Modified

Not Yet AvailableNot Yet AvailableNot Yet Available



Show If
special@authenticated
matchallgrouptmforum-members


Trackinglink
Type
Postman
CTK-Conformance
LicenceRAND
Linkhttps://
projects.tmforum.org/wiki/download/attachments/162957536/TMF702-ResourceActivation-v4-Postman.zip?api=v2NameResource Activation and Configuration API
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
@authenticated
@anonymous
match
allgroupnot-tmforum-members


Not yet available Not yet available Not yet available

Image Removed

Show If
special@anonymous
Image Removed
21.5.0
4
v4.0.
0Pre-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.

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
TMF700


Show If
special@authenticated
matchallNameShipping Order Management API
Show If
special@authenticated
matchall
groupnot-tmforum-members

Image Removed

grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps
://github.com/tmforum-apis/TMF700_ShippingOrder
://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
Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available
21
22.
5
0.0
4
v4.0.0
Pre-production
08-06-2022Business Partner

Usage Consumption Management API

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

TMF677


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://
github.com/tmforum-apis/TMF677_UsageConsumption
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

 

NameUsage Consumption API Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed



Show If
special@anonymous
Image Removed
Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available Not
Yet Available
yet available
21.5.0
4
v4.0.0
Pre-production

Work Order Management API

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

  • Retrieval of a workOrder or a collection of workOrder depending on filter criteria
  • Partial update of a workOrder (including updating rules)
  • Creation of a workOrder (including default values and creation rules)
  • Deletion of a workOrder (for administration purposes)
  • 22-Nov-2021Product

    Work Order Management API

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

    Notification of events on a workOrder.

    TMF697


    Show If
    special@authenticated
    match
    all
    grouptmforum-members


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


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

    Image Removed

    Show If
    special@anonymous
    Image Removed


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

    ...