TM Forum Open APIs Early Adopters | API Specification | Postman Collection | Swagger and Swagger_UI | Reference Implementation Code | Download PDF Specification | Conformance Profile and CTK | Release Status | Frameworx Release version |
---|
Alarm Management API 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. | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8175132784580997/RESTSpec_ALARM-API%20V0-3.docx?version=1&modificationDate=15020997860001505721743000&api=v2 |
---|
Name | Alarm Management API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8175132784580997/tmforum-alarm-api-11.0-swagger.json?version=1&modificationDate=15046042740001505721743000&api=v2 |
---|
Name | Alarm Management API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8175132784580997/RESTSpec_ALARM-API%20V0-3.pdf?version=1&modificationDate=15054910667301505721743000&api=v2 |
---|
Name | Alarm Management API |
---|
| |
|
Show If |
---|
| |
| Show If |
---|
| Trackinglink |
---|
Type | CTK-Conformance |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8175132784580997/Alarm_ConformanceProfile-v05.docx?version=1&modificationDate=15020997960001505721743000&api=v2 |
---|
Name | Alarm Management API |
---|
| |
|
Show If |
---|
| |
| Beta | 17.5.0 |
Payment Management API This API allows the following operations. Notify of a performed payment, retrieve a list of payments filtered by a given criteria, retrieve a single performed payment, notify of a performed refund, retrieve a list of refunds filtered by a given criteria and retrieve a single performed refund. | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/81735156/TMF_PaymentManagement_API_REST_Specification_Proposal_v1draft1C.docx?version=5&modificationDate=1499267004000&api=v2 |
---|
Name | Payment Management API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/81735156/paymentManagementTMF_v0.1.6.json?version=1&modificationDate=1499267025000&api=v2 |
---|
Name | Payment Management API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/81735156/TMF_PaymentManagement_API_REST_Specification_Proposal_v1draft1C.pdf?version=1&modificationDate=1505065795000&api=v2 |
---|
Name | Payment Management API |
---|
| |
|
Show If |
---|
| |
| Show If |
---|
| Trackinglink |
---|
Type | CTK-Conformance |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/81735156/TMF_PaymentManagement_ConformanceProfile-v01draft5.docx?version=1&modificationDate=1499166813000&api=v2 |
---|
Name | Payment Management API |
---|
| |
|
Show If |
---|
| |
| Beta | 17.5.0 |
Performance Management Threshold API Provides a standardized mechanism for performance management such as creation, partial or full update and retrieval of the resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It allows also notification of events related to performance | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8457994484581017/Performance_Threshold_API_REST_Specification-v0.9.docx?version=2&modificationDate=15055048220001505722417006&api=v2 |
---|
Name | Performance Management Thresholding API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8457994484581017/tmforum-open-api-PMThreshold-swagger-v0.9.json?version=12&modificationDate=15055048510001505722453730&api=v2 |
---|
Name | Performance Management Thresholding API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8457994484581017/Performance_Threshold_API_REST_Specification-v0.9.pdf?version=13&modificationDate=15055048350001505722833797&api=v2 |
---|
Name | Performance Management Thresholding API |
---|
| |
|
Show If |
---|
| |
| N/A | Beta | 17.5.0 |
Resource Catalog Management API 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. | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84578548/TMF634_Resource_Catalog_Management_API_REST_Specification_R17.5.0.docx?version=2&modificationDate=1505206919011&api=v2 |
---|
Name | Resource Catalog API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84578548/TMF634_Resource_Catalog_Management.regular.swagger-R17.5.0.json?version=1&modificationDate=1504709198000&api=v2 |
---|
Name | Resource Catalog API |
---|
| |
Trackinglink |
---|
Type | SwaggerUI |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84578548/TMF634_Resource_Catalog_Management.admin.swagger-R17.5.0.json?version=1&modificationDate=1504709206000&api=v2 |
---|
Name | Resource Catalog API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84578548/TMF634_Resource_Catalog_Management_API_REST_Specification_R17.5.0.pdf?version=2&modificationDate=1505206916249&api=v2 |
---|
Name | Resource Catalog API |
---|
| |
|
Show If |
---|
| |
| Show If |
---|
| Trackinglink |
---|
Type | CTK-Conformance |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84578548/Resource_Catalog_Management_API_REST_Conformance_Profile_R17.5.0.docx?version=1&modificationDate=1504709255000&api=v2 |
---|
Name | Resource Catalog API |
---|
| |
|
Show If |
---|
| |
| Beta | 17.5.0 |
Resource Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory. | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84579888/TMF639_Resource_Inventory_Management_REST_API_Specification_R17.5.0.docx?version=2&modificationDate=1505307411000&api=v2 |
---|
Name | Usage Consumption API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84579888/Resource_Inventory_Management.regular.swagger.json?version=1&modificationDate=1505307174000&api=v2 |
---|
Name | Usage Consumption API |
---|
| |
Trackinglink |
---|
Type | SwaggerUI |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84579888/Resource_Inventory_Management.admin.swagger.json?version=1&modificationDate=1505307174000&api=v2 |
---|
Name | Resource Inventory API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84579888/TMF639_Resource_Inventory_Management_REST_API_Specification_R17.5.0.pdf?version=2&modificationDate=1505485999237&api=v2 |
---|
Name | Usage Consumption API |
---|
| |
|
Show If |
---|
| |
| Show If |
---|
| Trackinglink |
---|
Type | CTK-Conformance |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84579888/Resource_Inventory_Management_Conformance_Profile-R17.5.0.docx?version=2&modificationDate=1505307417000&api=v2 |
---|
Name | Usage Consumption API |
---|
| |
|
Show If |
---|
| |
| Beta | 17.5.0 |
Service Catalog Management API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84578532/TMF633_Service_Catalog_Management_API_REST_Specification_R17.0.docx?version=1&modificationDate=1504708436000&api=v2 |
---|
Name | Service Catalog API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84578532/TMF633_Service_Catalog_Management.regular.swagger_R17.0.json?version=1&modificationDate=1504708572000&api=v2 |
---|
Name | Service Catalog API |
---|
| |
Trackinglink |
---|
Type | SwaggerUI |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84578532/TMF633_Service_Catalog_Management.admin.swagger_R17.0.json?version=1&modificationDate=1504708589000&api=v2 |
---|
Name | Service Catalog API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84578532/TMF633_Service_Catalog_Management_API_REST_Specification_R17.0.pdf?version=1&modificationDate=1505125520514&api=v2 |
---|
Name | Service Catalog API |
---|
| |
|
Show If |
---|
| |
| Show If |
---|
| Trackinglink |
---|
Type | CTK-Conformance |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84578532/Service_Catalog_Management_API_Conformance_Profile_R17.0.docx?version=1&modificationDate=1504708603000&api=v2 |
---|
Name | Service Catalog API |
---|
| |
|
Show If |
---|
| |
| Beta | 17.5.0 |
Usage Consumption Management API This API should allow to view in real-time the balance of the various buckets (SMS, Voice, Data for example) that an user consumes with each of his devices and the usages done out of the bucket. An usage report retrieve the data related to these balances. This API should also allow to perform a direct topup on the balance of a prepaid bucket with voucher references or with a given credit value after a payment done by a credit card or with a credit value transfered. | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/81736016/TMF_Usage_Consumption_API_REST_Specification_1.0-06092017.docx?version=1&modificationDate=1504692176000&api=v2 |
---|
Name | Usage Consumption API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/81736016/usageConsumption_swagger_06092017.json?version=1&modificationDate=1504692203000&api=v2 |
---|
Name | Usage Consumption API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/81736016/TMF_Usage_Consumption_API_REST_Specification_1.0-06092017.pdf?version=1&modificationDate=1505066778000&api=v2 |
---|
Name | Usage Consumption API |
---|
| |
|
Show If |
---|
| |
| Show If |
---|
| Trackinglink |
---|
Type | CTK-Conformance |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/81736016/UsageConsumption_ConformanceProfile-v101draft5-0609017.docx?version=1&modificationDate=1504881055000&api=v2 |
---|
Name | Usage Consumption API |
---|
| |
|
Show If |
---|
| |
| Beta | 17.5.0 |