SPONSORED BY:

LEGEND

API Program - Open API Map

L1 API (CURRENT) L2 API (FUTURE RESOURCE)

L1 API (PLANNED) L2 API (TMF RESOURCE)

L1 API (FUTURE)
FRAMEWORX RELEASE 17.5

SALES MANAGEMENT MARKETING SALES ORGANIZATION MANAGEMENT

MARKET / SALES

Provides interfaces for Sales Lead, Sales Opportunity, Sales Quote and the other Manages the campaign to represent the carrier initiated marketing activity which aims at Provides the management capability for sales organization. The structure of a sales
management capabilities to support the sales activities to build relationship with the the better recognition about its brand and offerings by the market. organization identifies how an organizations sales department is organized in order
prospect customer who could be a person or organization that has an interest in the goods to facilitate the organizations sales growth.
MARKETING CAMPAIGN
and/or services and possibly become the actual customers with one or more Subscriptions.
SALES CHANNEL MANAGEMENT
SALES LEAD SALES OPPORTUNITY
SALES TASK SALES PARTNER ACCOUNT
SALES ACCOUNT

PRODUCT CATALOG MANAGEMENT LOYALTY MANAGEMENT PRODUCT INVENTORY MANAGEMENT PROMOTION RECOMMENDATION MANAGEMENT STOCK MANAGEMENT
Checks availability of products in stock, and
PRODUCT

Manages the entire lifecycle of the catalog elements, the consultation of catalog elements Provides capabilities to manage customer loyalty points Provides standardized mechanism for product inventory management such as creation, partial Promotion is the online incentive which provides discount, gift or other substantial stimulation This API provides automated system action to determine the
during several processes such as ordering process, campaign management and sales account information as well as its redemption and adjustment. or full update and retrieval of the representation of a product in the inventory. It also allows to encourage more consumption according to the purchased offering. products offerings to be presented to the customer. provides adjustment, reservation for the stock.
management. the notification of events related to product lifecycle. PRODUCT STOCK
LOYALTY ACCOUNT LOYALTY PROGRAM PRODUCT PROMOTION RECOMMENDATION
CATALOG CATEGORY LOYALTY RULE SPECIFICATION PRODUCT PRODUCT STOCK ADJUST
PRODUCT OFFERING PRODUCT SPECIFICATION LOYALTY ACTION PRODUCT STOCK RESERVATION
LOYALTY CONDITION

CUSTOMER MANAGEMENT SHOPPING CART QUOTE APPOINTMENT REQUEST MANAGEMENT CUSTOMER PREFERENCE PRODUCT ORDERING BILLING MANAGEMENT SLA MANAGEMENT DUNNING CASE
Provides shopping cart which is used for Provides a standardized mechanism for placing a customer Helps to control the overdue charge (arrear) of the customer
Provides standardized mechanism for customer and Provides a standardized Provides service to store and manage records Provides the capabilities to manage Provides a standardized mechanism Provides standardized mechanisms for billing account, bill item and Provides a standardized interface for SLA life cycle
the temporarily selection and reservation of quote with all of the necessary quote parameters. by the way of notification and service limitation.
customer account management, such as creation, update, mechanism to book an of a contact with the customer. It manages the the customers’ preference for their for placing a product order with all settlement note advice management either in B2B or B2B2C contexts. Management (SLA Negotiation, SLA configuration
offerings in e-commerce and retail purchase. QUOTE
retrieval, deletion and notification of events. Customer appointment with all the request from the customer which represents information access and control, of the necessary order parameters. BILLING ACCOUNT SLA Activation/enforcement, SLA Operations, SLA DUNNING CASE
can be a person, an organization or another service SHOPPING CART necessary appointment communications with customers, and the including permission and profile. The API consists of a simple set of violation / consequence handling, SLA reporting)
CUSTOMER

BILL FORMAT
provider who buys products from an enterprise. Customer characteristics. translation of customer requests and inquiries operations that interact with between a Customer and a Service Provider which
CUSTOMER PREFERENCE BILLING CYCLE SPECIFICATION CUSTOMER 360 VIEW
management API allows management of identification and FEDERATED IDENTITY into appropriate events. CRM/Order negotiation systems provides offers (product with attached SLA in its
financial information about him. APPOINTMENT CUSTOMER PERMISSION in a consistent manner. BILL PRESENTATION MEDIA catalog) the customer can discover, browse, trigger Allows finding and retrieving the main information regarding
Identity management provides the management of principals of any kind (persons, objects …) and their
SEARCH TASK CUSTOMER INTERACTION SETTLEMENT NOTE ADVICE and order. the customer. A customer view gathers different information
CUSTOMER CUSTOMER ACCOUNT access to resources in an open environment which can span across different enterprise boundaries. PRODUCT ORDER
APPLIED CUSTOMER BILLING CHARGE to be presented to a user or the customer himself.
PAYMENT MEAN FEDERATED IDENTITY SLA SLA VIOLATION

PREPAYMENT BALANCE MANAGEMENT PRODUCT OFFERING QUALIFICATION CUSTOMER BILL PAYMENT MANAGEMENT HOT BILLING
Manages the balance, recharge (top-up) and transfer resources. It checks whether the product offering can be delivered to a specific location. CUSTOMER BILL This API manages the payment action Hot billing is used to generate the bill before the formal bill-run at the bill cycle date.
BALANCE BALANCE TRANSFER PRODUCT OFFERING QUALIFICATION of the customer. It can help provide the usage and accumulation result until the current moment.
APPLIED CUSTOMER BILLING RATE
BALANCE TOPUP BALANCE ADJUSTMENT PAYMENT REFUND HOT BILLING

SERVICE ORDERING SERVICE CATALOG SERVICE QUALITY MANAGEMENT SERVICE TEST MANAGEMENT CHANGE MANAGEMENT SERVICE QUALIFICATION
Provides a standardized mechanism for placing a service order with all of the necessary order parameters. Manages the entire lifecycle of the catalog elements, the SERVICE SPECIFICATION CATEGORY Provides Quality Management for the certain service. It enables easy integration of SQM Provides test procedure for the certain service. The Service Test API Provides the control mechanism for the change of the service. Service Qualification API goal is to provide service
It allows users to create, update & retrieve Service Orders and manages related notifications. consultation of catalog elements during service processes. CATALOG SERVICE CANDIDATE applications and client applications within the Digital Eco-system, where SQM application may provides a standardized mechanism for placing a service test with all Change Management process is to respond to the customer’s availability at Customer location.
SERVICE

reside in one enterprise and client applications may be in multiple other Enterprises. of the necessary test parameters. The API consists of a simple set of changing business requirements while maximizing value and SERVICE QUALIFICATION
SERVICE ORDER ACTIVATION & CONFIGURATION SERVICE LEVEL OBJECTIVE SERVICE LEVEL SPECIFICATION RESOURCES operations that interact with CRM/Service Management systems in reducing incidents, disruption and network. The Change PRODUCT OFFERING QUALIFICATION
Allows the user to retrieve, create, update, delete services and retrieve the monitor resource a consistent manner. A service test is a procedure intended to check Management API provides the standard integration capabilities
used to monitor the execution of asynchronous requests on specific resource. the quality, performance, or reliability of a service. between external applications and Change Management Application.
SERVICE INVENTORY DIGITAL SERVICE MANAGEMENT
SERVICE TEST CHANGE REQUEST SPECIFICATION
Provides standardized mechanism for service management such as creation, partial SERVICE MONITOR SERVICE Provides management capabilities for a digital service and can be defined as the set of
capabilities exposed by a digital service through which it can be managed. SERVICE TEST SPECIFICATION CHANGE REQUEST RESOURCES
or full update and retrieval of the representation of a service in the inventory.

RESOURCE ORDERING RESOURCE INVENTORY RESOURCE CATALOG RESOURCE MANAGEMENT ACTIVATION & CONFIGURATION ENTITY PROVISIONING TOPOLOGY ALARM MANAGEMENT
RESOURCE

Provides the order implementation on the resource Provides capabilities to update and retrieve sets of Provides the catalogue and categories to Provides capability to configure the resource type Used to Configure Logical and Physical Resources. Allows the user to retrieve, create, Used for provisioning of components in Is used to support application to have Is to be used to management the information
to change or allocate the resource to meet the recourses available for the Service Provider. manage the variety of resources. and item models for the sales and network enabling update, delete resources and retrieve the monitor resource used to monitor the support of cloud services. The components an up to date and accurate view of the about a given alarm condition of an alarmed
request of product order and service order. all services to run. It also supports capability to execution of asynchronous requests on specific resource. may be virtualized or physical. topology and the vertexes and edges Managed Object.
PHYSICAL RESOURCE RESOURCE SPECIFICATION
manage alarm information related to resources. required to provide the service.
RESOURCE ORDER LOGICAL RESOURCE CATALOG MONITOR
RESOURCE CONFIGURATION
CATEGORY PHYSICAL RESOURCE
ALARM
RESOURCE CANDIDATE LOGICAL RESOURCE
ENGAGED PARTY

PARTY MANAGEMENT SLA MANAGEMENT PRODUCT ORDERING PRIVACY ONBOARDING PAYMENT METHOD AGREEMENT MANAGEMENT ACCOUNT MANAGEMENT
PURCHASE ORDER
Provides standardized mechanism for party Provides a standardized interface for SLA life cycle Management Provides a standardized mechanism for Provides the management for the customer Provides standardized mechanisms for managing an onboarding process. Provides the frequently-used payment Provides standardized mechanism for This API is used to manage the account resources
management such as creation, update, retrieval, (SLA Negotiation, SLA configuration SLA Activation/ placing a product order with all of the privacy information and preference. The intention for onboarding process in the Digital Ecosystem is to have a Supports capability to manage
methods for the customer to choose managing agreements, especially in the purchase order raised by the and some related billing resources.
deletion and notification of events. Party can enforcement, SLA Operations, SLA violation / consequence necessary order parameters. The API lightweight approach. The interface will provide onboarding that identifies and pay the usage, including voucher context on partnerships between partners.
PARTY PRIVACY PROFILE operator to 3rd party suppliers. PARTY ACCOUNT BILLING CYCLE SPECIFICATION
be an individual or an organization that has any handling, SLA reporting) between a Customer and a Service consists of a simple set of operations that that a new API would be needed to automate the onboarding process. The card, coupon and money transfer.
kind of relation with the enterprise. Provider which provides offers (product with attached SLA in its interact with CRM/Order negotiation PRIVACY PROFILE TYPE onboarding of the “Party”, the role can be Partner, Supplier, Developer, etc. AGREEMENT PURCHASE ORDER BILLING ACCOUNT BILL FORMAT
catalog) the customer can discover, browse, trigger and order. systems in a consistent manner. PARTY PRIVACY AGREEMENT The onboarding of the “Services” could be product offerings. PAYMENT METHOD AGREEMENT SPECIFICATION SETTLEMENT ACCOUNT BILL PRESENTATION MEDIA
INDIVIDUAL
ORGANIZATION SLA PRODUCT ORDER PARTY ROLE FINANCIAL ACCOUNT
SLA VIOLATION PARTNERSHIP TYPE
ENTERPRISE

WORKFORCE MANAGEMENT SHIPPING MANAGEMENT RETAIL PREMISE

Manages work force which supports and execute the manual work that can be sent to a workforce staff team Used to manage the delivery and transportation of physical goods. Used to manage the information maintenance of physical retail outlets.
to process.
SHIPPING ORDER RETAIL PREMISE
WORK ORDER ADVANCE SHIPMENT NOTIFICATION

PERFORMANCE MANAGEMENT USAGE MANAGEMENT TROUBLE TICKET LOCATION CUSTOMER INSIGHT COMMUNICATION PROJECT DOCUMENT MANAGEMENT CHANGE ROLE AND PERMISSIONS
Provides standardized mechanism for performance management such as creation, partial Provides standardized mechanism for usage Retrieves, creates, updates, deletes Provides the information of Provides the statistics and business intelligence Provides a capability Provides management of Provides the operations to synchronize Used to manage the user account with which
COMMON BUSINESS ENTITIES

or full update and retrieval of the resources involved in performance management management such as creation, update, retrieval, import services and retrieves the monitor geographic region of the entity capabilities for the enterprise data. to create and send internal enterprise project. documents and document versions across the customer or staff can log-in and log-off
(Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). and export of a collection of usages. Usage API manages resource used to monitor the (customer, equipment, address). communications, systems. It also provides operations for the system and the permission for the user to
CHECK CUSTOMER CREDIT RATING PROJECT
It allows also notification of events related to performance. both rated and non-rated usage. execution of asynchronous requests notifications and instructions uploading documents by Users as well as enter or operate the special information.
on specific resource. CUSTOMER INSIGHT to Parties, Individuals, for viewing of documents online.
MEASUREMENT COLLECTION USAGE Organizations or Users. USER
MEASUREMENT PRODUCTION USAGE SPECIFICATION TICKET DOCUMENT PRIVILEGE
AD-HOC COLLECTION COMMUNICATION

GEOGRAPHIC LOCATION GEOGRAPHIC SITE ADDRESS USAGE CONSUMPTION FOLLOW UP ENTITY CATALOG PM THRESHOLDING
This API provides the information of geographic This API covers the operations to manage (create, read, delete) sites Provides a standardized client interface to an Address Is used by applications to request/publish a report on the measured usage Provides the capability to manage the entity catalog API. The catalog entity item could Covers the Thresholding aspects of Performance
region of the entity (customer, equipment, address). that can be associated to a customer, an account, a service delivery management system. of a given product/service by a customer. be an entity, entity specification, product offering, service candidate, or resource Management, also named Performance
or other entities. candidate that appears in an entity catalog. Thresholding Management or PM Thresholding.
GEOGRAPHIC LOCATION ADDRESS STREET USAGE CONSUMPTION FOLLOW UP
GEOGRAPHIC SITE ENTITY CATALOG ENTITY CATALOG ITEM ASSOCIATION
AREA STREET SEGMENT PM THRESHOLDING
CATEGORY ENTITY SPECIFICATION ASSOCIATION SPECIFICATION

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. File updated: April 24, 2018

042418_API.Poster.indd 1 4/24/18 11:26 AM