Page History

...

21.5.0

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.

21.5.0

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

21.5.0

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.

21.5.0

Geographic Location Management API

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

21.5.0

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.

21.5.0

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.

21.5.0

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.

21.5.0

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.

21.5.0

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

21.5.0

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.

19.0.1

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

21.5.0

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.

21.5.0

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.

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

21.5.0

Geographic Location Management API

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

21.5.0

21.5.0

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.

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

21.5.0

Risk IoT Service Management API Component Suite

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

21.5.0

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.

Image Removed

Image Removed

21.5.0

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.

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 PostmanSwagger Licence RANDApache 2.0 Link https://projectsgithub.tmforum.org/wiki/download/attachments/162957536/TMF696-RiskManagement-v4.0.0-Postman.zip?api=v2com/tmforum-apis/TMF628_Performance Name Risk Performance Management API

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

Image Removed

Show If
special @anonymous
Image Added

21.5.0

Service Problem Process Flow Management API

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.

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

Image Removed

Image Removed

19.

0.

1

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.

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

Show If
special @authenticated match all group tmforum-members
Trackinglink Type Swagger Licence Apache 2.0 Link https://github.com/tmforum-apis/TMF657_ServiceQualityManagement Name Service Quality Management API

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

TMF671_Promotion Name Promotion API
Show If
special @anonymous
Image Removed

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

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

Show If

special	@anonymous

Image Removed

Image Added

Show If
special @anonymous
Image Added

21.5.0

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.

Show If
special @authenticated match all group tmforum-members
Trackinglink Type Postman Licence RAND CTK-Conformance Link https://projects.tmforum.org/wiki/download/attachments/143534323/TMF657-ServiceQualityManagement-v4-Postman.zip146293804/TMF680B_Recommendation_Conformance_Profile_v4.0.0.pdf?api=v2 Name Service Quality Management Recommendation API

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

Image Removed

Show If
special @anonymous
Image Added

21.5.0

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.

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.

21.5.0

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.

Show If
special @authenticated match all group tmforum-members
Trackinglink Type Swagger Licence Apache 2.0 Specification PDF Link https://github.com/tmforum-apis/TMF677_UsageConsumption Name Usage Consumption API
Show If
special @authenticated match all group not-tmforum-members
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 Image Removed

Image Removed

Show If
special @anonymous@authenticated	match

21.5.0

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.

21.5.0

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.

21.5.0

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.

Show If
special @authenticated match all group tmforum-members
Trackinglink Type PostmanSwagger Licence RANDApache 2.0 Link https://projectsgithub.com/tmforum.org/wiki/download/attachments/143534323/TMF672-UserRolePermission-v4-Postman.zip?api=v2-apis/TMF677_UsageConsumption Name Usage Consumption Name User Roles & Permissions API

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

Image Removed

Show If
special @anonymous
Image Added

21.5.0

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)
• Notification of events on a workOrder.