TM Forum Ecosystem API Portal

Space shortcuts

Page tree

Versions Compared

Old Version 16

changes.mady.by.user Alan Pope

Saved on

compared with

New Version 17

changes.mady.by.user Alan Pope

Saved on

Key

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

Please be aware these are archived versions for historic access, please use the latest table unless you specifically need to access the previous version

  

The increasingly complex multi-partner digital services value chain raises new challenges in terms of ensuring time-to-market, seamless management, cost-effectiveness and revenue sharing.

...

By default, the information in the table is sorted by API title, but can be re-sorted (for example, by Document Number or Release Version) by clicking on the relevant column headings.


Hide If
special@authenticated


Note
titleTo access the API table links below you will need to be logged in

To login with your TM Forum account please click on the Login button below

Button Hyperlink
titleLogin
typeprimary
urlhttps://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

Don't have an account? You can register by clicking here:

Button Hyperlink
titleRegister
typeprimary
urlhttps://www.tmforum.org/user-registration/
targettrue



Dialog
idlogin-required
titleLogin Required


Section


Panel
borderStylenone

To access the API documentation you need to be logged in to your TM Forum account

Button Hyperlink
titleLogin
typeprimary
urlhttps://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

Don't have an account? You can register by clicking here:

Button Hyperlink
titleRegister
typeprimary
urlhttps://www.tmforum.org/user-registration/
targettrue



...

Table Filter
sparkNameSparkline
datepatternyy-mm-dd
id15330405340911583877703332_20039740851230810153
sortReleased TM Forum Open APIs (‍Asc)
isORAND
separatorPoint (.)


   

TM Forum Open APIs

_____________________________________

Document Number

Swagger

API Specification

Conformance Profile

CTK

Reference Implementation Code

Postman CollectionReleaseLifecycle Status

Account Management API

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

TMF666


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/accountManagement/v3/swagger2.json
NameAccount Management API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514822/TMF666_Account_Management_API_REST_Specification_R17.0.1.pdf?api=v2
NameAccount Management API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF666B_Account_Management_API_Conformance_Profile_R17.0.docx?api=v2
NameAccount Management API

 



Show If
special@anonymous

Image Modified


Not yet available

 

 

Not yet availableNot yet available17.0.1

Archived

N-2

Address API

The Address API is one of the Pre-Ordering Management APIs. The Address API provides a standardized client interface to an Address management system .It allows to look for worldwide addresses. It can also be used to validate address data, to be sure that it corresponds to a real address.

(Superseded by TMF673 Geographic Address Management API)

TMF647


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/addressManagement/v2/swagger2.json
NameAddress API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84580863/TMF647_Address_API_REST_Specification_R16.0.1.pdf?api=v2
NameAddress API

 



Show If
special@anonymous

Image Modified


Not yet availableNot yet available


Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSADDRESS
NameAddress API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://github.com/tmforum/DSADDRESS/blob/master/AddressManagementAdmin.json.postman_collection
NameAddress API

 



Show If
special@anonymous

Image Modified


16.0.1 Archived

N-2

Agreement Management API

  The Agreement API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners.

TMF651


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/agreementManagement/v2/swagger2.json
NameAgreement API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84580871/TMF651_Agreement_Management_API_REST_Specification_R16.0.1.pdf?api=v2
NameAgreement API

 



Show If
special@anonymous

Image Modified


Not yet availableNot yet available


Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSAGREEMENT
NameAgreement API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://github.com/tmforum/DSAGREEMENT/blob/master/Agreement_Management.postman.json
NameAgreement API

 



Show If
special@anonymous

Image Modified


16.0.1  Archived

N-2

Appointment API

The Appointment API is one of the Pre-Ordering Management APIs. The appointment API provides a standardized mechanism to book an appointment with all the necessary appointment characteristics. First, the API consists in searching free slots based on parameters, as for example a party. Then, the appointment is created. The appointment has characteristics such as nature of appointment, place of appointment.

TMF646


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/appointmentManagement/v2/swagger2.json
NameAppointment API

 



Show If
special@anonymous

Image Modified

 



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84580877/TMF646_Appointment_API_REST_Specification_R16.0.1.pdf?api=v2
NameAppointment API

 



Show If
special@anonymous

Image Modified


Not yet availableNot yet available


Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSAPPOINTMENT
NameAppointment API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://github.com/tmforum/DSAPPOINTMENT/blob/master/AppointementManagement.json.postman_collection
NameAppointment API

 



Show If
special@anonymous

Image Modified


16.0.1  Archived

N-2

Customer Management API

Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.

TMF629

Change Management API

The Change Management API provides the standard integration capabilities between external applications and Change Management Application. The API consists of a simple set of operations that interact with Change Request in a consistent manner. A Change Request is an IT service management discipline.

TMF655


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/
changeManagement
customerManagement/
v2
v3/swagger2.json
Name
Change
Customer Management API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/
84580882
90514784/
TMF655
TMF629_
Change
Customer_Management_API_REST_Specification_
R16
R17.
5
0.1.pdf?api=v2
Name
Change
Customer Management API

 



Show If
special@anonymous

Image Modified

Not yet availableNot yet availableNot yet available

Not yet available

 

16.5.1 



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF659B_Customer_Management_API_Conformance_Profile_R17.0.docx?api=v2
NameCustomer Management API

 

Communication API

Provides a capability to create and send communications, notifications and instructions to Parties, Individuals, Organizations or Users.

TMF681



Show If
special
@authenticated
@anonymous
match

Image Added

all


Not availableNot availableNot available17.0.1  Archived

N-2

Partnership Type Management API

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

TMF668


grouptmforum-members
Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/communicationManagement/v3/swagger2.json
NameCommunication API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
LicenceRAND
Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://
projects
github.com/tmforum
.org
/
wiki
TMFAPISWAGGER/
download
blob/
attachments
develop/partnershipTypeManagemnet/
90514901/TMF681_Communication_API_REST_Specification_R17.5.0.pdf?api=v2
v3/swagger2.json
Name
Communication
Partnership Type Management API

 



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated
matchallgrouptmforum-membersLicenceRAND


Trackinglink
Type
CTK-Conformance
Specification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/
90514901/TMF681B_Communication
90514826/TMF668_Partnership_Type_Management_API_
Conformance
REST_
Profile
Specification_R17.
5
0.
0
1.pdf?api=v2
Name
Communication
Partnership Type Management API

 



Show If
special@anonymous

Image Removed

Not yet availableNot yet availableNot yet available17.5.0 

Image Added



Customer Management API

Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.

TMF629
Show Ifspecial
Show If
special
@authenticated


Trackinglink
Type
Swagger
CTK-Conformance
Linkhttps://
github
projects.
com/
tmforum.org/
TMFAPISWAGGER
wiki/
blob
download/
develop
attachments/
customerManagement/v3/swagger2.jsonNameCustomer Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
TrackinglinkTypeSpecification PDFLinkhttps://projects.tmforum.org/wiki/download/attachments/90514784/TMF629_Customer_Management_API_REST_Specification
84575796/TMT668B_Partnership_Type_Management_API_Conformance_Profile_R17.0.
1.pdf
docx?api=v2
Name
Customer
Partnership Type Management API

 



Show If
special@anonymous

Image Removed

Show If
special@authenticated
TrackinglinkTypeCTK-ConformanceLinkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF659B_Customer_Management_API_Conformance_Profile_R17.0.docx?api=v2NameCustomer

Image Added


Not availableNot availableNot available17.0.1  Archived

N-2

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


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/partyRoleManagement/v3/swagger2.json
NameParty Role Management API

 



Show If
special@anonymous

Image Removed

Not yet availableNot yet availableNot yet available17.0.1 

Partnership Type Management API

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

Image Added



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514828/TMF669_Party_Role_Management_API_REST_Specification_R17.0.1.pdf?api=v2
NameParty Role Management API

 



Show If
special@anonymous

Image Added

TMF668



Show If
special@authenticated


Trackinglink
Type
Swagger
CTK-Conformance
Linkhttps://
github
projects.
com/
tmforum.org/
TMFAPISWAGGER
wiki/
blob
download/
develop
attachments/
partnershipTypeManagemnet/v3/swagger2.jsonNamePartnership Type Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
TrackinglinkTypeSpecification PDFLinkhttps://projects.tmforum.org/wiki/download/attachments/90514826/TMF668_Partnership_Type_
84575796/TMF669B_Party_Role_Management_API_
REST
Conformance_
Specification
Profile_R17.0.
1.pdf
docx?api=v2
Name
Partnership Type
Party Role Management API

 



Show If
special@anonymous

Image Added


Not availableNot availableNot available17.0.1   Archived

N-2

Product Catalog Management API

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.

TMF620


Show If
special@authenticated

Image Removed

Show Ifspecial@authenticated


Trackinglink
Type
CTK-Conformance
Swagger
Linkhttps://
projects
github.com/tmforum
.org
/
wiki
TMFAPISWAGGER/
download
blob/
attachments
develop/
84575796/TMT668B_Partnership_Type_Management_API_Conformance_Profile_R17.0.docx?api=v2
productCatalog/v2/swagger2.json
NameProduct Catalog
NamePartnership Type
Management API

 



Show If
special@anonymous

Image Removed

Not yet availableNot yet availableNot yet available17.0.1 

Image Added



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF620_Product_Catalog_Management_API_REST_Specification_R14.5.1%202015.pdf'
NameProduct Catalog Management API

 



Show If
special@anonymous

Image Added

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



Show If
special@authenticated


Trackinglink
Type
Swagger
CTK-Conformance
Linkhttps://github.com/tmforum/
TMFAPISWAGGER/blob/develop/partyRoleManagement/v3/swagger2.jsonNameParty Role Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514828/TMF669_Party_Role_Management_API_REST_Specification_R17.0.1.pdf?api=v2
NameParty Role Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF669B_Party_Role_Management_API_Conformance_Profile_R17.0.docx?api=v2
NameParty Role Management API

 

Show If
special@anonymous

Image Removed

Not yet availableNot yet availableNot yet available17.0.1  

Payment Methods 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

Show If
special@authenticated
Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/paymentMethod/v3/swagger2.json
NamePayment Methods API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514830/TMF670_Payment_Methods_API_REST_Specification_R17.0.1.pdf?api=v2
NamePayment Methods API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF670B_Payment_Methods_API_Conformance_Profile_R17.0.docx?api=v2
NamePayment Methods API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeCTK
Linkhttps://github.com/tmforum/CTKFILES/tree/master/paymentMethods
NamePayment Methods API

 

Show If
special@anonymous

Image Removed

Not yet available

Show If
special@authenticated
Trackinglink
TypePostman
Linkhttps://github.com/tmforum/CTKFILES/blob/master/paymentMethods/TMForum%20-%20PaymentMethodsAPI%20CTK.postman_collection.json
NamePayment Methods API

 

Show If
special@anonymous

Image Removed

17.0.1 

Product Catalog Management API

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.

TMF620

Show If
special@authenticated
Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/productCatalog/v2/swagger2.json
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF620_Product_Catalog_Management_API_REST_Specification_R14.5.1%202015.pdf'
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeCTK-Conformance
Linkhttps://github.com/tmforum/PRODUCTCATALOG-CTK/raw/master/TMF660_Product_Catalog_API_Conformance_Profile_R16.5.0.pdf
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeCTK
Linkgithub.com/tmforum/PRODUCTCATALOG-CTK/archive/master.zip
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSPRODUCTCATALOG2/tree/master
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypePostman
Linkhttps://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFProductCatalogAPI.json.postman_collection
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Removed

14.5.1 

Product Inventory Management API

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.

TMF637

Show If
special@authenticated
Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/productInventory/v2/swagger2.json
NameProduct Inventory Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84580713/TMF637_Product_Inventory_Management_API_REST_Specification_R16.5.1.pdf?api=v2
NameProduct Inventory Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeCTK-Conformance
Linkhttps://github.com/tmforum/PRODUCTINVENTORY-CTK/raw/master/Open%20API%20Conformance-v40-20170503_2245.docx
NameProduct Inventory Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeCTK
Linkhttps://github.com/tmforum/PRODUCTINVENTORY-CTK/archive/master.zip
NameProduct Inventory Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSPRODUCTINVENTORY/tree/develop
NameProduct Inventory Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypePostman
Linkhttps://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFProductInventoryAPI.json.postman_collection
NameProduct Inventory Management API

 

Show If
special@anonymous

Image Removed

16.5.1 

Product Ordering API

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.

TMF622

Show If
special@authenticated
Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/productOrdering/v2/swagger2.json
NameProduct Ordering Management API

 

Show If
special@anonymous

Image Removed

 

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84580716/TMF622_Product_Ordering_Management_API_REST_Specification_R16.5.1.pdf?api=v2
NameProduct Ordering Management API

 

Show If
special@anonymous

Image Removed

Not yet available

Not yet available

Show If
special@authenticated
Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSPRODUCTORDERING/tree/develop
NameProduct Ordering Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
Trackinglink
TypePostman
Linkhttps://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFProductOrderingAPI.json.postman_collection
NameProduct Ordering Management API

 

Show If
special@anonymous

Image Removed

16.5.1 
PRODUCTCATALOG-CTK/raw/master/TMF660_Product_Catalog_API_Conformance_Profile_R16.5.0.pdf
NameProduct Catalog Management API

 



Show If
special@anonymous

Image Added

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


Trackinglink
Type
Swagger
CTK
Link
https://
github.com/tmforum/
TMFAPISWAGGER
PRODUCTCATALOG-CTK/
blob/develop/promotionManagement/v3/swagger2.json
archive/master.zip
Name
Promotion
Product Catalog Management API

 



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated


Trackinglink
Type
Specification PDF
RI
Linkhttps://
projects.tmforum
github.
org
com/
wiki
tmforum/
download
DSPRODUCTCATALOG2/
attachments/90514832/TMF671_Promotion_API_REST_Specification_R17.0.1.pdf?api=v2
tree/master
Name
Promotion
Product Catalog Management API

 



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated


Trackinglink
Type
CTK-Conformance
Postman
Linkhttps://
projects
github.com/tmforum
.org
/
wiki
TMFAPIPOSTMAN/
download
blob/
attachments/84575796/TMF671B_Promotion_API_Conformance_Profile_R17.0.docx?api=v2
master/TMFProductCatalogAPI.json.postman_collection
NameProduct Catalog Management
NamePromotion
API

 



Show If
special@anonymous

Image Removed

Not yet availableNot yet availableNot yet available

Image Added


14.517.0.1 Quote   Archived

N-2

Product Inventory Management API

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.

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.

TMF637TMF648


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/
quoteManagement
productInventory/
v3
v2/swagger2.json
Name
Quote
Product Inventory Management API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/
84580731/TMF648_QUOTE
84580713/TMF637_Product_Inventory_Management_API_REST_Specification_R16.
0
5.1.pdf?api=v2
Name
Quote
Product Inventory Management API

 



Show If
special@anonymous

Image Modified

Not yet available

Not yet available



Show If
special@authenticated


Trackinglink
Type
RILinkhttps://github.com/tmforum/DSQUOTENameQuote Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
TrackinglinkTypePostman
CTK-Conformance
Linkhttps://github.com/tmforum/
DSQUOTE
PRODUCTINVENTORY-CTK/
blob
raw/master/
POST
Open%20API%20Conformance-
full
v40-
quote
20170503_2245.
json
docx
Name
Quote Management API

 

Show If
special@anonymous

Image Removed

16.0.1 

Recommendation API

Recommendation API is used to recommend offering quickly based on the history and real-time context of 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
Product Inventory Management API

 



Show If
special@anonymous

Image Added

Not yet available



Show If
special@authenticated
match


Trackinglink
Type
all
CTK
Linkhttps://github.com/tmforum/PRODUCTINVENTORY-CTK/archive/master.zip
NameProduct Inventory Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-membersLicenceRAND


Trackinglink
Type
Specification PDF
RI
Linkhttps://
projects.tmforum.org/wiki/download/attachments/90514896/TMF680_Recommendation_API_REST_Specification_R17.5.0.pdf?api=v2
github.com/tmforum/DSPRODUCTINVENTORY/tree/develop
NameProduct Inventory Management
NameRecommendation
API

 



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated
matchallgrouptmforum-membersLicenceRAND


Trackinglink
Type
CTK-Conformance
Postman
Linkhttps://
projects
github.com/tmforum
.org
/
wiki
TMFAPIPOSTMAN/
download
blob/
attachments/90514896/TMF680B_Recommendation_API_Conformance_Profile_R17.5.0.pdf?api=v2
master/TMFProductInventoryAPI.json.postman_collection
NameProduct Inventory Management
NameRecommendation
API

 



Show If
special@anonymous

Image Removed

Not yet availableNot yet availableNot yet available

Image Added


1617.5.0 1  Archived

N-2

Product Ordering API

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.

TMF622

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


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/
resourceFunctionActivationConfiguration
productOrdering/v2/swagger2.json
Name
Resource Function Activation and Configuration
Product Ordering Management API

 



Show If
special@anonymous

Image Modified

 



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/
90514820
84580716/
TMF664
TMF622_Product_
Resource
Ordering_
Function
Management_
Activation
API_
and
REST_
Configuration_API_REST_Specification_R17.0.1.pdf?api=v2NameResource Function Activation and Configuration
Specification_R16.5.1.pdf?api=v2
NameProduct Ordering Management API

 



Show If
special@anonymous

Image Added


Not available

Not available


Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSPRODUCTORDERING/tree/develop
NameProduct Ordering Management API

 



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated


Trackinglink
Type
CTK-Conformance
Postman
Linkhttps://
projects
github.com/tmforum
.org
/
wiki
TMFAPIPOSTMAN/
download
blob/
attachments/84575796/TMF664B_Resource_Function_Config_and_Activation_API_Conformance_Profile_R17.0.docx?api=v2Name
master/TMFProductOrderingAPI.json.postman_collection
NameProduct Ordering Management
Resource Function Activation and Configuration
API

 



Show If
special@anonymous

Image Removed

Not yet availableNot yet availableNot yet available

Image Added


16.517.0.1  Archived

N-2

Quote Management

 

Service Catalog API

The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.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.

TMF648TMF633


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/
serviceCatalogManagement
quoteManagement/
v2
v3/swagger2.json
Name
Service Catalog
Quote Management API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/
84580754
84580731/
TMF633
TMF648_
Service
QUOTE_
Catalog_Management_
API_REST_Specification_R16.
5
0.1.pdf?api=v2
Name
Service Catalog
Quote Management API

 



Show If
special@anonymous

Image Modified


Not yet available 

Not yet availableNot yet availableNot yet available16.5.1 

Service Inventory Management API

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

TMF638


Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSQUOTE
NameQuote Management API

 



Show If
special@anonymous

Image Added

Not yet available

 



Show If
special@authenticated


Trackinglink
Type
Specification PDFLicenceRAND
Postman
Linkhttps://
projects
github.com/tmforum
.org
/
wiki
DSQUOTE/
download
blob/
attachments/84580767/TMF638_Service_Inventory_Management_API_REST_Specification_R16.5.1.pdf?api=v2NameService Inventory Management API 
master/POST-full-quote.json
NameQuote Management API

 



Show If
special@anonymous

Image Added


16.0.1  Archived

N-2

Service Catalog API

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

TMF633


Show If
special
@anonymous
@authenticated
Image Removed


Trackinglink

Not yet available

Not yet availableNot yet availableNot yet available16.5.1 

Service Ordering Management API

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.

TMF641
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/serviceCatalogManagement/v2/swagger2.json
NameService Catalog Management API

 



Show If
special@anonymous

Image Added

Not yet available



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/
84580770
84580754/
TMF641
TMF633_Service_
Ordering
Catalog_Management_API_REST_Specification_R16.5.1.pdf?api=v2
NameService
Ordering
Catalog Management API

 



Show If
special@anonymous

Image Modified


Not yet available

 

Not yet availableNot yet availableNot yet available16.5.1   Archived

N-2

Service Inventory Management API

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

TMF638

Not available

 

Service Qualification API

Service Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location.

TMF645


Show If
special@authenticated


Trackinglink
Type
Swagger
Specification PDF
LicenceRAND
Linkhttps://
github
projects.
com/
tmforum.org/
TMFAPISWAGGER
wiki/
blob
download/
develop
attachments/
serviceQualification/v2/swagger2.json
84580767/TMF638_Service_Inventory_Management_API_REST_Specification_R16.5.1.pdf?api=v2
NameService
Qualification
Inventory Management API

 



Show If
special@anonymous

Image Added


Not available

Not availableNot availableNot available16.5.1  Archived

N-2

Service Ordering Management API

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.

TMF641

Not availableImage Removed


Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/
84580777
84580770/
TMF645
TMF641_Service_
Qualification
Ordering_Management_API_REST_Specification_R16.
0
5.1.pdf?api=v2
NameService
Qualification
Ordering Management API

 



Show If
special@anonymous

Image Modified


Not available

Not availableNot availableNot available16.5.1  Archived

N-2

Service Qualification API

Service Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location.

TMF645

Show If
special@authenticated
Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://github.com/tmforum/SERVICEQUALIFICATION-CTK/raw/master/Open%20API%20Conformance-v40-20170503_2245.docx
NameService Qualification API

 

Show If
special@anonymous

Image Removed


Show If
special@authenticated


Trackinglink
TypeSwagger
Licence
CTK
RAND
Linkhttps://github.com/tmforum
/SERVICEQUALIFICATION-CTK/archive/master.zip
/TMFAPISWAGGER/blob/develop/serviceQualification/v2/swagger2.json
NameService Qualification API

 



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Licence
RI
RAND
Linkhttps://
github.com/tmforum/DSSERVICEQUALIFICATION
projects.tmforum.org/wiki/download/attachments/84580777/TMF645_Service_Qualification_API_REST_Specification_R16.0.1.pdf?api=v2
NameService Qualification API

 



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated


Trackinglink
Type
Postman
CTK-Conformance
LicenceRAND
Linkhttps://github.com/tmforum/
DSSERVICEQUALIFICATION
SERVICEQUALIFICATION-CTK/
blob
raw/master/
APIServiceQualification.json.postman_collection
Open%20API%20Conformance-v40-20170503_2245.docx
NameService Qualification API

 



Show If
special@anonymous

Image Removed

 

 

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

Image Added

TMF657



Show If
special@authenticated


Trackinglink
Type
Swagger
CTK
Linkhttps://github.com/tmforum/
TMFAPISWAGGER/blob/develop/serviceQualityManagement/v2/swagger2.json
SERVICEQUALIFICATION-CTK/archive/master.zip
NameService Qualification API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSSERVICEQUALIFICATION
NameService
Quality Management
Qualification API

 



Show If
special@anonymous
Image Removed

Image Added



Show If
special@authenticated


Trackinglink
Type
Specification PDF
Postman
Linkhttps://
projects
github.com/tmforum
.org
/
wiki
DSSERVICEQUALIFICATION/
download/attachments
blob/
84580781/TMF657_Service_Quality_Management_API_REST_Specification_R16.5.1.pdf?api=v2
master/APIServiceQualification.json.postman_collection
NameService
Quality Management
Qualification API

 



Show If
special@anonymous
Image Removed

Image Added

Not yet availableNot yet availableNot yet availableNot yet available16.5.1
 


 

16.0.1  Archived

N-2

 

Service Test Management API  

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.

TMF653


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/serviceTestManagement/v2/swagger2.json
NameService Test Management API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84580784/TMF653_Service_Test_Management_API_REST_Specification_R16.5.1.pdf?api=v2
NameService Test Management API

 



Show If
special@anonymous

Image Modified


Not yet availableNot yet availableNot yet availableNot yet available16.5.1  Archived

 

N-2

Shopping Cart API

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

TMF663


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/shoppingCart/v3/swagger2.json
NameShopping Cart API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514818/TMF663_Shopping_Cart_API_REST_Specification_R17.0.1.pdf?api=v2
NameShopping Cart API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF633B_Shopping_Cart_API_Conformance_Profile_R17.0.docx?api=v2
NameShopping Cart API

 



Show If
special@anonymous

Image Modified


Not yet availableNot yet availableNot yet available17.0.1   Archived

N-2

Trouble Ticket API

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

TMF621


Show If
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/troubleTicket/v2/swagger2.json
NameTrouble Ticket API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF621_Trouble_Ticket_API_REST_Specification_R14.5.1%202015.pdf
NameTrouble Ticket API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://github.com/tmforum/TROUBLETICKET-CTK/raw/master/TMF661_Trouble_Ticket_API_Conformance_Profile_R16.5.0.pdf
NameTrouble Ticket API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://github.com/tmforum/TROUBLETICKET-CTK/archive/master.zip
NameTrouble Ticket API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSMAPITT/tree/maven-glassfish4
NameTrouble Ticket API

 



Show If
special@anonymous

Image Modified



Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFTroubleTicketAPI.json.postman_collection
NameTrouble Ticket API

 



Show If
special@anonymous

Image Modified


14.5.1  Archived

 

N-2