API program
VERSION 22
- Open API map
TMF699 SALES MANAGEMENT
MARKET / SALES
Sales Management provides for Sales Lead, Sales
Opportunity, Sales Quote to support the sales activities
used to build a relationship with a prospective customer
(Individual or Organization) that has an interest in your
goods and/or services.
TMF646 APPOINTMENT MANAGEMENT
Appointment can be used to book an appointment with
relevant characteristics (nature of appointment, place etc).
This allows searching of free slots based on parameters such
as a party, then creating the appointment.
CUSTOMER
TMF678 CUSTOMER BILL MANAGEMENT
Customer Bill can be used to find and retrieve one or more
customer bills (also called invoices) and to find and retrieve
the details of applied customer billing rates presented on a
customer bill.
TMF658 LOYALTY MANAGEMENT
Supports the management of loyalty program specifications,
PRODUCT
loyalty program members, their associated products and
loyalty accounts with loyalty balances.
TMF909 NETWORK AS A SERVICE MANAGEMENT
This API Component Suite supports of a set of Operational
Domains exposing and managing Network Services. These
services are referred to as Network as a Service (NaaS) and
SERVICE
include all services offered from a service provider including
connectivity, end points, media services, etc.
TMF642 ALARM MANAGEMENT
Alarm Management builds on ITU recommendations, TM
RESOURCE
Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment
between 3GPP and TM Forum, and the more recent ETSI
work on requirements for NFV interfaces.
TMF666 ACCOUNT MANAGEMENT
BUSINESS PARTNER
Account Management of billing and settlement accounts,
and financial accounting (accounts receivable) in B2B or
B2B2C contexts.
TMF651 AGREEMENT MANAGEMENT
The Agreement API manages agreements, especially in the
context of partnerships between partners.
TMF915 AI MANAGEMENT
The AI Management Component Suite allows a Service
Provider to govern Artificial Intelligence systems deployed at
scale. The initial focus is restricted to the in-life management
of ‘model contracts’.
COMMON BUSINESS ENTITIES
TMF655 CHANGE MANAGEMENT
Change Management defines interactions between external
applications and a Change Management Application, based
on a Change Request.
TMF681 COMMUNICATION MANAGEMENT
Provides a capability to create and send communications,
notifications, and instructions to Parties, Individuals,
Organizations or Users.
TMF710 GENERAL TEST ARTIFACT MANAGEMENT
Management of Test artefacts that do not fall into the
categories managed by TMF704, TMF705, TMF706, TMF707,
or TMF709, such as binaries, jars, etc.
The Open API map is a work in progress. If you wish to contribute or comment on the map, join us on the Open API team calls.
TMF629 CUSTOMER MANAGEMENT
Customer is used to manage the Customer Account
(a Party Role), such as creation, update, retrieval,
deletion and notification of events.
TMF676 PAYMENT MANAGEMENT
The Payments API manages payments or refunds in
a Payment System. Payment API originators (clients)
include Web servers, mobile app servers, Contact
center dashboards or retail store systems.
TMF620 PRODUCT CATALOG MANAGEMENT
Provides a standardized solution for rapidly adding
partners’ products to an existing Catalog. This allows
Service Providers to directly feed partners systems
with the technical description of the ProductOffering
that they propose to them.
TMF640 SERVICE ACTIVATION MANAGEMENT
Activation and Configuration allows the user to retrieve,
create, update, delete services and retrieve the monitor
resource used to monitor the execution of asynchronous
requests on a specific resource. Although the examples
in the API specification are relative to Services, the
same API can also be used to Activate and Configure
Resources.
TMF634 RESOURCE CATALOG MANAGEMENT
Resource Catalog manages the lifecycle of Resource
Catalog elements and the consultation of resource
catalog elements during several processes such as
ordering process.
TMF668 PARTNERSHIP TYPE MANAGEMENT
This API manages partnership types in an onboarding
process. It identifies a type of partnership between
parties, including the list of role types that are permitted
(i.e. Buyer, Seller, Developer). Role types may refer to
agreement specifications to be signed by parties playing
the role.
TMF707 TEST RESULT MANAGEMENT
Management of test results. These include Test Case
Results, Test Suite Results, and Non-functional Test
Results.
TMF708 TEST EXECUTION MANAGEMENT
This API manages the test case, test suite, and non-
functional test model execution. This also includes
allocation and provisioning of test environments for
test execution.
TMF704 TEST CASE MANAGEMENT
This API manages the test artefacts that do not fall
into the categories managed by TMF704, TMF705,
TMF706, TMF707, or TMF709, such as binaries, jars,
etc.
TMF709 TEST SCENARIO MANAGEMENT
This API manages Test Scenarios: The full
specification of required test elements, e.g. Test Case
T parameterized with test data instance D running on
abstract test environment E provisioned with a set of
provisioning artefacts P.
TMF670 PAYMENT METHOD MANAGEMENT
This API supports the frequently-used payment methods (aka payment
means) for a Customer to choose and pay for usage, including credit-card,
voucher, coupon, and money transfer.
TMF654 PREPAY BALANCE MANAGEMENT
Prepay Balance Management allows pre-paid subscribers to manage
(view/top-up) Buckets of allowance before using services. Operators can
provide multiple recharge channels for subscribers, and subscribers can
transfer credit between different subscriptions.
TMF637 PRODUCT INVENTORY MANAGEMENT
Product Inventory Management allows the creation, partial or full update
and retrieval of the representation of a Product in the Inventory. It also
allows the notification of events related to product lifecycle.
TMF633 SERVICE CATALOG MANAGEMENT
Service Catalog Management allows the management of the entire
lifecycle of the service catalog elements.
TMF638 SERVICE INVENTORY MANAGEMENT
Service Inventory Management allows the query and manipulation of the
Service Inventory.
TMF664 RESOURCE FUNCTION ACTIVATION MANAGEMENT
Resource Function 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.
TMF683 PARTY INTERACTION MANAGEMENT
A User Interaction captures information about past interactions in order
to re-use them in future ones. This allows agents to serve users better
by knowing the steps they went through. It also allows customers to see
better the actions they have performed and how they interacted with us.
TMF706 TEST DATA MANAGEMENT
This API manages test data artefacts used for test case parameterization.
These include Test Data Schemas and Test Data Instances.
TMF705 TEST ENVIRONMENT MANAGEMENT
The management of test artefacts related to test environment
specification, including Abstract Test Environments, Concrete Environment
Metamodels (used to map abstract environments to concrete test
resources), Environment Provisioning Artefacts, and Test Resource APIs
exposed to test cases.
TMF667 DOCUMENT MANAGEMENT
Document is used to manage the characteristics of a Document against
its Specification (eg: book, picture, video). The document media is in the
associated Attachment.
TMF662 ENTITY CATALOG MANAGEMENT
Entity Catalog provides 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
through CRUD operations.
sponsored by:
TMF622 PRODUCT ORDERING MANAGEMENT
Provides the ability to place a Product Order with all necessary order
parameters, interacting with CRM/Order negotiation systems in a consistent
manner. A Product Order is based on a Product Offering that is defined in
a Product Catalog, which includes characteristics such as pricing, product
options and market.
TMF648 QUOTE MANAGEMENT
The Quote API allows for obtaining a quote with all the necessary quote
parameters, from the Pre-Ordering Management APIs.
TMF679 PRODUCT OFFERING QUALIFICATION MANAGEMENT
Product Offering Qualification allows Product Offering commercial
eligibility in the Pre-Ordering Management API Family.
TMF641 SERVICE ORDERING MANAGEMENT
Service Order Management provides for placing a Service Order with
all the necessary order parameters. It allows users to create, update &
retrieve Service Orders and manages related notifications.
TMF656 SERVICE PROBLEM MANAGEMENT
Service problems are generated based on the information declared by a
partner or the event information notified from infrastructure providers. This
may include alarms, performance anomalies, trouble tickets, SLA violations,
maintenance information, and predictions.
TMF639 RESOURCE INVENTORY MANAGEMENT
Resource Inventory manages allocated Resources (logical and physical)
that are typically used in support of Services.
TMF632 PARTY MANAGEMENT
This API manages a Party, which can be an Individual or an Organization
that has any kind of relationship with the enterprise.
TMF669 PARTY ROLE MANAGEMENT
This API manages general Party Roles (a Party acting in the role of...).
Notice that Customer Party Role has a specific API.
TMF691 FEDERATED ID MANAGEMENT
The management of principals of any kind (persons, objects) and their access to
resources in an open environment which can span across enterprise boundaries.
It relies on authentication, authorization and consent mechanisms to protect
privacy with a simple user experience. Different parties can provide identity
services (operators, social networks, GSMA).
TMF673 GEOGRAPHIC ADDRESS MANAGEMENT
Defines an Address management system, allowing validation and lookup of
worldwide addresses by: searching an area as a start (city, town ...), then the
streets of this area, and finally listing all the street segments (numbers) in a
street.
TMF675 GEOGRAPHIC LOCATION MANAGEMENT
Provides the information of a geographic region of the entity (customer,
equipment, address), described by GeoJSON geometric primitives.
TMF674 GEOGRAPHIC SITE MANAGEMENT
This API manages sites that can be associated with a customer, account,
service delivery or other entities. This allows reference to places important to
other entities.
TMF680 RECOMMENDATION MANAGEMENT
Recommendation is used to recommend personalized Product Offerings
based on the history and context of a Customer in real-time. It is usually
provided by omnichannel e-commerce or BSS, CRM systems.
TMF910 SELF CARE MANAGEMENT
The Self Care Component Suite covers the operations required by a SelfCare
application used by a Service Provider to allow its customers to manage the
services it has subscribed to.
TMF671 PROMOTION MANAGEMENT
Promotion is used to provide an additional discount, voucher, bonus or gift
to the customer who meets pre-defined criteria. It is used to attract the
users and encourage more consumption, especially continuous purchases.
It is often applied when the customer buys product offerings with the
price or amount surpassing a certain limit.
TMF645 SERVICE QUALIFICATION MANAGEMENT
Service Qualification provides Service Availability at a Customer location,
within the Pre-Ordering Management APIs.
TMF657 SERVICE QUALITY MANAGEMENT
Service Quality manages Service Level Specifications and associated
Service Level Objectives (SLO) and their thresholds.
TMF652 RESOURCE ORDER MANAGEMENT
Resource Order Management allows for creating, updating and retrieving
Resource Orders (including filtering).
TMF644 PRIVACY MANAGEMENT
Privacy Management provides for privacy profile types, privacy profiles
and privacy agreements such as creation, update, retrieval, deletion and
notification of events.
TMF628 PERFORMANCE MANAGEMENT
This API allows for the creation, partial or full update and retrieval of
resources involved in performance management (Measurement Production
Job, Measurement Collection Job, and Ad hoc Collection), and notification of
events related to performance.
TMF649 PERFORMANCE THRESHOLDING MANAGEMENT
This API allows for the creation, partial or full update and retrieval of the
thresholds involved in performance management (Measurement Production
Job, Measurement Collection Job, and Ad hoc Collection). It allows also
notification of events related to performance.
TMF701 PROCESS FLOW MANAGEMENT
The Process Flow API allows management (configuration/activation) of
business Processes made up of Tasks. It can coordinate these tasks which may
require manual actions.
TMF685 RESOURCE POOL MANAGEMENT
Resource Pool Management provides for Resource Reservation at the pre-
order phase. In order to reserve a physical product, logical product, and
virtual product, the API uses the idea of a resource pool.
upskill on
APIs here
TMF663 SHOPPING CART MANAGEMENT
This API manages Shopping Carts including creation, update, retrieval,
deletion and notification of related events. A Shopping Cart is used for the
temporary selection and reservation of Product Offerings in e-commerce
and retail purchase.
TMF696 RISK MANAGEMENT
Risk Management allows the retrieval of Risk Assessments during
interactions with PartyRoles (Individuals or 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 assessments are Task resources, as per
the Open API guidelines for tasks.
TMF677 USAGE CONSUMPTION MANAGEMENT TMF635 USAGE MANAGEMENT
Usage Consumption represents the real-time value within Buckets (SMS, Usage manages both rated and non-rated use of a Product or Service.
Voice, Data, TV for example) that a Customer consumes with each of their For example, it allows a service provider to retrieve usage generated by a
devices, related to subscribed Products without having to wait for the bill partner service platform in order to rate it; or to provide rated usage to a
cycle. A Usage Consumption Report retrieves the data related to these partner for consumption follow-up purposes.
balances.
TMF653 SERVICE TEST MANAGEMENT
Service Test manages a Service Test with all the necessary test parameters.
A Service Test is a procedure intended to check the quality, performance, or
reliability of a Service.
TMF687 STOCK MANAGEMENT
Stock Management provides for the creation, update and retrieval of the
representation of a Product Stock, as well as the reservation, checking,
querying and adjusting of Product Stock. It also allows the for notification
of related events.
TMF623 SLA MANAGEMENT TMF720 DIGITAL IDENTITY MANAGEMENT
Service Level Agreement (SLA) manages the life-cycle (negotiation, The digital identity allows identification of an Individual, a Resource, or a
configuration activation/enforcement, operations, violation/consequence Party Role (a specific role - or set of roles - for a given individual). A digital
handling, and reporting) of an SLA between a Customer and Service identity is associated with credential / authentication method, which are
Provider which provides offers (Product with an attached SLA in its extensible to describe all types of authentication methods such as login/
Catalogue) that the Customer can discover, browse, trigger and order. password, biometric, token, etc. A contact medium is associated with
a digital identity (or directly at credential level) to manage credential
recovery UCs.
TMF684 SHIPMENT TRACKING MANAGEMENT
Shipment Tracking captures information about the current status of the
shipment, the past checkpoints and the estimated arrival date. Shipments
can be tracked with an order ID or the shipping company’s tracking id.
TMF621 TROUBLE TICKET MANAGEMENT
Trouble Ticket Management provides for creating, tracking and managing
Trouble Tickets among partners as a result of an issue or Problem
identified by a Customer or another system, such as CRM applications,
network management or fault management systems, or other trouble
ticket management systems (e.g. B2B).
TMF672 USER ROLE PERMISSION MANAGEMENT
A User Role is 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 allocated all the Privileges defined for that Role type and the corresponding
Permissions are created for that user.
Poster design © NetCracker® and TM Forum 2022. File updated: August 26, 2022