Account Management API TMF666

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

Agreement Management API TMF651

The Agreement API provides a standardized mechanism for managing

agreements, especially in the context of partnerships between partners.

AI Management API Component Suite TMF915

The API Component Suite for AI Management defines the set of operations that
should be offered in order that a Service Provider can govern Artificial Intelligence
systems deployed at scale. Effective governance and management of AI must span
the lifecycle from design through deployment and eventual withdrawal from
service. However, the initial focus of the AI Management API is restricted to the in-
life aspects of AI and in particular on the management of ‘model contracts’.

Alarm Management API TMF642

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.

Appointment API TMF646

The appointment API provides a standardized mechanism to book an appointment

with all the necessary appointment characteristics. The API allows searching of free
slots based on parameters, as for example a party, then creating the appointment.
The appointment has characteristics such as nature of appointment, place of
appointment.

Communication API TMF681

Provides a capability to create and send communications, notifications, and

instructions to Parties, Individuals, Organizations or Users.

Customer Bill Management API TMF678

This API allows operations to find and retrieve one or several customer bills (also
called invoices) produced for a customer also allows operations to find and
retrieve the details of applied customer billing rates presented on a customer bill.

Customer Management API TMF629

Provides a standardized mechanism for customer and customer account

management, such as creation, update, retrieval, deletion and notification of
events.

Entity Catalog Management API TMF662

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.

General Test Artifact Management API TMF710

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

General Test Artifact Management API TMF704

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

Geographic Address Management API TMF673

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.

Geographic Site Management API TMF674

Covers the operations to manage (create, read, delete) sites that can be associated
with a customer, account, service delivery or other entities. This API defines a Site
as a convenience class that allows easy reference to places important to other
entities, where a geographic place is an entity that can answer the question
“where?”

Partnership Type Management API TMF668

Standardized mechanisms for creating partnership types. It is one of the APIs
involved in an onboarding process. Identifies a type of a 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.
The API allows the retrieval, creation, update, and deletion of partnership type and
its owned sub-resources.

Party Interaction Management API TMF683

A User Interaction captures information about past interactions in order to re-use

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

Party Management API TMF632

Provides a standardized mechanism for party management such as creation,

update, retrieval, deletion and notification of events.
Party can be an individual or an organization that has any kind of relationship with
the enterprise.

Party Role Management API TMF669

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

Payment Management API TMF676

The Payments API provides the standardized client interface to Payment Systems
for notifying about performed payments or refunds. Examples of Payment API
originators (clients) include Web servers, mobile app servers, Contact center
dashboards or retail store systems. 

Prepay Balance Management API TMF654

REST API for Balance Management. It includes the model definition as well as all
available operations for prepay balance management. Prepaid subscribers pay fees
before using services. Therefore, the subscribers must have sufficient balances.
Operators can provide multiple recharge channels for subscribers. Subscribers can
pass credit between different subscriptions, therefore transferring the balance
from one account to another.

Privacy Management API TMF644

The Privacy management API provides a standardized mechanism for privacy

profile types, privacy profiles and privacy agreements such as creation, update,
retrieval, deletion and notification of events

Product Catalog Management API TMF620

Provides a standardized solution for rapidly adding partners’ products to an

existing Catalog. It brings the capability for Service Providers to directly feed
partners systems with the technical description of the products they propose to
them. 

Product Inventory Management API TMF637

Provides standardized mechanism for product inventory management such as

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.

Product Offering Qualification API TMF679

Product Offering Qualification API is one of Pre-Ordering Management API Family.

Product Offering Qualification API goal is to provide Product Offering commercial
eligibility.

Product Ordering API TMF622

Provides a standardized mechanism for placing a product order with all of the
necessary order parameters. The API consists of a simple set of operations that
interact with CRM/Order negotiation systems in a consistent manner. A product
order is created based on a product offering that is defined in a catalog. The
product offering identifies the product or set of products that are available to a
customer and includes characteristics such as pricing, product options and market.

Quote Management API TMF648

The Quote API is one of the Pre-Ordering Management APIs. The customer Quote
API provides a standardized mechanism for placing a customer quote with all of
the necessary quote parameters.

Resource Catalog Management API TMF634

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.

Resource Function Activation and Configuration API TMF664

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

Resource Inventory Management API TMF639

The intent of this API is to provide a consistent/standardized mechanism to query

and manipulate the Resource inventory.

Resource Ordering Management API TMF652

The REST API for Resource Order Management. It includes the model definition as
well as all available operations. Possible actions are creating, updating and
retrieving Resource Orders (including filtering). A Resource Order API provides a
standard mechanism for placing a Resource Order with all necessary order
parameters.

Risk Management API TMF696

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.

Sales Management API TMF699

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.

Service Activation and Configuration API TMF640

The REST API for 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 all the
examples given in the API specification are relative to Services, the same API can
be used to Activate and Configure Services or Resources.

Service Catalog API TMF633

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

Service Inventory Management API TMF638

The intent of this API is to provide a consistent/standardized mechanism to query

and manipulate the Service inventory.

Service Ordering Management API TMF641

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.

Service Problem Management TMF656

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.

Service Qualification API TMF645

Service Qualification API is one of the Pre-Ordering Management APIs. Service

Qualification API goal is to provide service availability at Customer location.

Service Quality Management API TMF657

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.

Service Test Management API TMF653

The Service Test API provides a standardized mechanism for placing a service test
with all of the necessary test parameters. The API consists of a simple set of
operations that interact with CRM/Service Management systems in a consistent
manner. A service test is a procedure intended to check the quality, performance,
or reliability of a service.

Shopping Cart API TMF663

A standardized mechanism for the management of shopping carts. Including

creation, update, retrieval, deletion and notification of an event. Shopping Cart
entity is used for the temporary selection and reservation of product offerings in
e-commerce and retail purchase.

Stock Management API TMF687

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

Test Data Management API TMF706

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

Test Environment Management API TMF705

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

Test Execution Management API TMF708

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.

Test Result Management API TMF707

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

Test Scenario Management API TMF709

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

Trouble Ticket API TMF621

Provides a standardized client interface to Trouble Ticket Management Systems for

creating, tracking and managing trouble tickets among partners as a result of an
issue or problem identified by a customer or another system. Examples of Trouble
Ticket API clients include CRM applications, network management or fault
management systems, or other trouble ticket management systems (e.g. B2B).

Usage Consumption Management API TMF677

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.

Usage Management API TMF635

Provides standardized mechanism for usage management such as creation,

update, retrieval, import and export of a collection of usages. The API manages
both rated and non-rated usage. For example, it allows a service provider to 1)
retrieve usage generated by a partner service platform in order to rate it and 2) to
provide rated usage to a partner for consumption follow up purposes.

User Roles & Permissions API TMF672

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.