Versions Compared

Key

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

...

Geographic Site Management API

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?”

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


TMF691

TM Forum Open APIs

_____________________________________

Document Number

Swagger

(Apache 2.0 or RAND)

API User Guide / Specification

(RAND)

Conformance Profile

(RAND)

CTK

Sample Implementation Code

Postman CollectionReleaseSwagger VersionPublication DateODA DomainNotes

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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF666-Account-v4.1.0.swagger.json
NameAccount Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.1.0
10-Jan-2022Business Partner, Customer

Async Trouble Ticket API

Async API Enabled for Trouble Ticket, Async API conpect supporting the event-based architecture

TMF925


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF925-TroubleTicket-v4.0.0.asyncapi.yml
NameAsync Trouble Ticket API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
22.5.0
v4.0.0
Common

Change Management API

The Change Management API provides the standard integration capabilities between external applications and Change Management Application

TMF655


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF655-Change-v4.0.0.swagger.json
NameChange Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
v4.0.0
10-Jan-2022Common

Customer360 Management API

An API to give a consolidated Customer overview. This is a view-only API, based on the various underlying involved TM Forum Open APIs. This API provides references where one can find detailed information for: Account, Agreement, Appointment, CustomerBill, InteractionItem, LoyaltyBalance, ProductOrder, ProductValue, Promotion, Quote, ServiceProblem, TroubleTicket, UsageSpecification

TMF717


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF717-Customer360-v4.0.0.swagger.json
NameCustomer360 Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
05-Jan-2022Customer

DCS 5GSlice Service Activation API

Domain Context Specialization of TMF640 for 5G Service Slice, Swagger of Contract is strongly bound to the GSMA Service Definition

TMF924


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF924-dcs-5gslice-sa-swagger.json
NameDCS 5GSlice Service Activation API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
22.5.0
v4.0.0
Service

Digital Identity Management API.

Provides the ability to manage a digital identity. This digital identity allows identification of an individual, a resource, or a partyRole (a specific role - or set of roles - for a given individual). A digital identity is associated with credential / authentification method. These credential / authentification methods should be extensible to describe all types of authentification method such as login/password, biometric, token, etc. A contact medium is also associated with digital identity (or directly at credential level) to manage credential recovery UCs.

TMF720


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF720-DigitalIdentity-v4.0.0.swagger.json
NameDigital Identity Management API.

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Business Partner, Common

Entity Inventory Dunning Case Management API

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

No description available yet

TMF728TMF703


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF703TMF728-EntityInventoryDunningCase-v4.0.0.swagger.json
NameEntity Inventory Dunning Case Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21 22.5.0
v4.0.0
22-Nov-2021Common

Event Entity Inventory Management API

The Event Management API provides a standardized client interface to the enterprise event management system for creating, managing and receiving service related events to (indicatively) drive automation workflows, notify other service providers for service outages and SLA violations, trigger Trouble Ticket creation, and enable more complex orchestration scenarios between management systems. The Event Management API can also be used to convey business level Events in support of other processes.

TMF688

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

TMF703


showshow-if
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF688TMF703-EventEntityInventory-v4.0.0.swagger.json
NameEvent Entity Inventory Management API

 



 
Show If
special@anonymous

Show If
special@authenticated
grouptmforum-members
Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF688_Event_Management_API_user_guides_21.5.0.pdf
NameEvent Management API


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Common

Event Management API

The Event Management API provides a standardized client interface to the enterprise event management system for creating, managing and receiving service related events to (indicatively) drive automation workflows, notify other service providers for service outages and SLA violations, trigger Trouble Ticket creation, and enable more complex orchestration scenarios between management systems. The Event Management API can also be used to convey business level Events in support of other processes.

TMF688


Image Removed showif
Show If
special@anonymous@authenticated
group
tmforum-
members
special@authenticated


Trackinglink
TypeCTK-ConformanceSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformanceswagger/TMF688_Event_Management_API_conformance_21.5-Event-v4.0.0.pdfswagger.json
NameEvent Management API

 



Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Common

Federated ID Management API

The management of principals of any kind (persons, objects, …) and their access to resources in an open environment which can span across different enterprise boundaries. It relies on authentication, authorization and consent mechanisms to protect privacy with a simple and easy user experience. Different parties can provide identity services (operators, social networks, GSMA, …).


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF688_Event_Management_API_user_guides_21.5.0.pdf
NameEvent Management API

 



Show If
group
special@authenticated@anonymous

Image Added



Show If
special@authenticatedtmforum-members


Trackinglink
TypeSwaggerCTK-Conformance
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF691-FederatedIdentity-v4.0conformance/TMF688_Event_Management_API_conformance_21.5.0.swagger.jsonpdf
NameFederated ID Event Management API

 



Show If
special@anonymous

Image Removed

Image Added


Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Common

Federated ID Management API

The management of principals of any kind (persons, objects, …) and their access to resources in an open environment which can span across different enterprise boundaries. It relies on authentication, authorization and consent mechanisms to protect privacy with a simple and easy user experience. Different parties can provide identity services (operators, social networks, GSMA, …).

TMF691


Show If
special@authenticated
grouptmforum-members
Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF691_Federated_Identity_API_user_guides_21.5.0.pdf
NameFederated ID Management API

 

Show If
special@anonymous@authenticated

Image Removed

Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Common

Geographic Location Management API

Provides the information of a geographic region of the entity (customer, equipment, address).

TMF675
grouptmforum-members


Trackinglink
TypeSwagger
Licence
Show If
special@authenticated
grouptmforum-members
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF675TMF691-GeographicLocationFederatedIdentity-v4.0.0.swagger.json
NameGeographic Location Federated ID Management API

 



Show If
special@anonymous

Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Common



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF691_Federated_Identity_API_user_guides_21.5.0.pdf
NameFederated ID Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Common

Geographic Location Management API

Provides the information of a geographic region of the entity (customer, equipment, address).

TMF675TMF674


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/54.0.0/swagger/TMF674TMF675-GeographicSiteGeographicLocation-v5v4.0.0.oasswagger.yamljson
NameGeographic Site Location Management API

 



Show If
special@anonymous

Show If
special@authenticated
grouptmforum-members
Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF674-GeographicSite-v5.0.0.pdf
NameGeographic Site Management API

 

Show If
special@anonymous

Image Removed


Not yet available Not yet available Not yet available Not yet available Not yet available
22 21.5.0
v5 v4.0.0
Common

Intent

The Component Suite for Intent Management API defines the set of operations that should be offered to manage intent and intent-driven interactions in a consistent manner.

22-Nov-2021Common

Geographic Site Management API

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?”

TMF674TMF921


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/swagger/TMF921TMF674-IntentGeographicSite-v4v5.0.0.swaggeroas.jsonyaml
NameIntentGeographic Site Management API

 



Show If
special@anonymous

Not yet available



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF674-GeographicSite-v5.0.0.pdf
NameGeographic Site Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.05.0
v4 v5.0.0
08-06-2022Common

Intent

The Component Suite for Intent Management API defines the set of operations that should be offered to manage intent and intent-driven interactions in a consistent manner.

TMF921


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF921-Intent-v4.0.0.swagger.json
NameIntent

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.0.0
08-06-2022

IoT Agent and Device Management API

In addition to including established TM Forum Open APIs, such as alarm management, resource management and activation APIs, the IoT Device Management API Component Suite also includes an IoT Data Access Endpoint API. This API allows for IoT data access using different types of protocols (MQTT IoT, CoAP, etc.). It encapsulates the protocols and allows devices to be easily integrated into solutions that support a host of IoT initiatives, including smart cities, smart factories and other vertical markets.

TMF908


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF908-IoTAgentAndDevice-v4.0.0.swagger.json
NameIoT Agent and Device Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF908_IoT_Device_Management_API_Component_Suite_user_guides_21.5.0.pdf
NameIoT Agent and Device Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Resource

IoT Service Management API

The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale.

TMF914


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF914-IotService-v4.0.0.swagger.json
NameIoT Service Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF914_IoT_Service_Management_API_Component_Suite_user_guides_21.5.0.pdf
NameIoT Service Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Product, Common, Resource, Service

Metadata Catalog Management API

Metadata Catalog

TMF725


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF725-MetadataCatalog-v4.0.0.swagger.json
NameMetadata Catalog Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
v4.0.0
10-Jan-2022Common

Network as a Service Management API

The 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 include all services offered from a service provider including connectivity, end points, media services, etc.

TMF909


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.2.0/swagger/TMF909-NetworkasaService-v4.2.0.swagger.json
NameNetwork as a Service Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.2.0/user_guides/TMF909_Network_as_a_Service_Management_API_REST_Specification_v4-2-0.pdf
NameNetwork as a Service Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
18.5.1
v4.2.0
Common, Product, Service

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

IoT Agent and Device Management API

In addition to including established TM Forum Open APIs, such as alarm management, resource management and activation APIs, the IoT Device Management API Component Suite also includes an IoT Data Access Endpoint API. This API allows for IoT data access using different types of protocols (MQTT IoT, CoAP, etc.). It encapsulates the protocols and allows devices to be easily integrated into solutions that support a host of IoT initiatives, including smart cities, smart factories and other vertical markets.

TMF908


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.01.0/swagger/TMF908TMF669-IoTAgentAndDevicePartyRole-v4.01.0.swagger.json
NameIoT Agent and Device Party Role Management API

 



Show If
special@anonymous



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.01.0/user_guides/TMF908TMF669_IoTParty_DeviceRole_Management_API_ComponentREST_Suite_user_guides_21.5Specification_v4.1.0.pdf
NameIoT Agent and Device Party Role Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available
21 22.50.0
v4.01.0
2208-Nov06-20212022ResourceBusiness Partner

IoT Service Performance Management API

The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale.

Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance.

TMF628TMF914


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF914-IotService-amazonaws.com/Beta/4.0.0/swagger/TMF628-Performance-v4.0.0.swagger.json
NamePerformance Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Service, Common

Process Flow Management API

The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:

TMF701


.swagger.jsonNameIoT Service Management API

 

Show If
special@anonymous

Image Removed

Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.01.0/user_guides/TMF914_IoT_Service_Management_API_Component_Suite_user_guides_21.5.0.pdfswagger/TMF701-ProcessFlow-v4.1.0.swagger.json
NameProcess Flow NameIoT Service Management API

 



Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Product, Common, Resource, Service

Metadata Catalog Management API

Metadata Catalog

TMF725


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.01.0/swagger/TMF725-MetadataCatalog-v4.0.0.swagger.jsonuser_guides/TMF701_Process_Flow_Management_API_Specification_v4.1.0.pdf
NameProcess Flow NameMetadata Catalog Management API

 



Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available Not yet available
v4.0.0
10-Jan-2022Common

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
group
special@authenticatedtmforum-members


Trackinglink
TypeSwaggerCTK-Conformance
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF669-PartyRoleconformance/TMF701_Process_Flow_Management_Conformance-v4.1.0.swagger.jsonpdf
NameParty Role Process Flow Management API

 



Show If
special@anonymous

Image Removed Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22 19.0.0 1
v4.1.0
0822-06Nov-20222021Business PartnerCommon

Performance Product Catalog Management API

Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance.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. 

TMF620TMF628


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/swagger/TMF628-Performance-v4TMF620-Product_Catalog_Management-v5.0.0.swaggeroas.jsonyaml
NamePerformance Management API

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Service, Common

Process Flow Management API

The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:

TMF701
Product Catalog Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.10.0/swagger/TMF701-ProcessFlow-v4.1.0.swagger.json
NameProcess Flow Management API

 

user_guides/TMF620-Product_Catalog_Management-v5.0.0.pdf
NameProduct Catalog Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Product

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@anonymous

Image Removed

Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.10.0/user_guides/TMF701_Process_Flow_Management_API_Specification_v4.1.0.pdfswagger/TMF637-ProductInventory-v5.0.0.oas.yaml
NameProduct Inventory NameProcess Flow Management API

 



Show If
special@anonymous

Image Removed Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeCTK-ConformanceSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.10.0/conformance/TMF701_Process_Flow_Management_Conformance-v4.1user_guides/TMF637-ProductInventory-v5.0.0.pdf
NameProcess Flow Product Inventory Management API

 



Show If
special@anonymous

Image Added Image Removed


Not yet available Not yet available Not yet available Not yet available
19 22.5.0 .1
v4 v5.10.0
22-Nov-2021Common

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. 

Product

Product Offering Qualification Management API

Product Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility.

TMF679TMF620


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF620-Product_Catalog_ManagementTMF679-ProductOfferingQualification-v5.0.0.oas.yaml
NameProduct Catalog Offering Qualification Management API

 



Show If
special@anonymous



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF620-Product_Catalog_ManagementTMF679-ProductOfferingQualification-v5.0.0.pdf
NameProduct Catalog Offering Qualification Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Product

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
grouptmforum-members
.0.0
Product

Product Ordering Management API

Provides a standardized mechanism for placing a product order with all 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 Trackinglink

TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF637-ProductInventory-v5.0.0.oas.yaml
NameProduct Inventory Management API
 


Image Removed
Show If
special@anonymous
Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guidesswagger/TMF637TMF622-ProductInventoryProductOrdering-v5.0.0.pdf
NameProduct Inventory Management API

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Product

Product Offering Qualification Management API

Product Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility.

TMF679
oas.yaml
NameProduct Ordering Management API

 



Show If
special@anonymous

Image Added



Image Removed
Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swaggeruser_guides/TMF679TMF622-ProductOfferingQualificationProductOrdering-v5.0.0.oas.yaml
NameProduct Offering Qualification Management API

 

Show If
special@anonymous
pdf
NameProduct Ordering Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Customer, Product

Promotion Management 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
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/54.0.0/user_guidesswagger/TMF679TMF671-ProductOfferingQualificationPromotion-v5v4.0.0.swagger.pdfjson
NameProduct Offering Qualification Promotion Management API

 



Show If
special@anonymous

Image Added Image Removed


Not yet available Not yet available Not yet available Not yet available Not yet available
22 21.5.0
v5 v4.0.0
22-Nov-2021Product

Product Ordering Quote Management API

Provides a standardized mechanism for placing a product order with all 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.

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 the necessary quote parameters.

TMF648TMF622


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF622TMF648-ProductOrderingQuote-v5.0.0.oas.yaml
NameProduct Ordering Quote Management API

 



Show If
special@anonymous



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guides/TMF622TMF648-ProductOrderingQuote-v5.0.0.pdf
NameProduct Ordering Quote Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Customer, Product

Promotion Recommendation Management 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

Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omnichannel.

TMF680TMF671


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF671-Promotion-v4.0.0.swagger.json
NamePromotion Management API

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
TMF680-Recommendation-v4.0.0
22-Nov-2021Product

Quote 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 the necessary quote parameters.

.swagger.json
NameRecommendation Management API

 



Show If
special@anonymous

Image Added

TMF648



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/54.0.0/swagger/TMF648-Quote-v5.0user_guides/TMF680_Recommendation_API_user_guides_21.5.0.oas.yamlpdf
NameQuote Recommendation Management API

 



Show If
special@anonymous

Image Removed Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/54.0.0/user_guides/TMF648-Quote-v5.0/conformance/TMF680_Recommendation_API_conformance_21.5.0.pdf
NameQuote Recommendation Management API

 



Show If
special@anonymous

Image Removed Image Added


Not yet available Not yet available Not yet available Not yet available
22 21.5.0
v5 v4.0.0
22-Nov-2021Customer

Recommendation Resource Activation Management API

Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omnichannel.

The Resource Activation and Configuration API can be used to query resource instances to acquire the resource activation states and attributes, and it can be used to create/update, configure and activate the resource instances.

TMF702TMF680


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF680TMF702-RecommendationResourceActivation-v4.0.0.swagger.json
NameRecommendation Resource Activation Management API

 



Show If
special@anonymous



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/user_guides/TMF680_RecommendationTMF702_Resource_Activation_and_Configuration_API_user_guides_21.5.0.pdf
NameRecommendation Resource Activation Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF680TMF702_RecommendationResource_APIActivation_conformance_21v4.50.0_conformance.pdf
NameRecommendation Resource Activation Management API

 



Show If
special@anonymous

Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Customer


TMF702


Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ctk/TMF702-ResourceActivation.zip
NameResource Activation Management API

The Resource Activation and Configuration API can be used to query resource instances to acquire the resource activation states and attributes, and it can be used to create/update, configure and activate the resource instances.

 



Show If
group
special@authenticated@anonymous

Image Added



Show If
special@authenticatedtmforum-members


Trackinglink
TypeSwaggerRI
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swaggerri/TMF702-ResourceActivation-v4.0.0.swagger.json_Resource_activation.zip
NameResource Activation Management API

 



Show If
special@anonymous

Image Removed Image Added



Show If
special@authenticated
group
tmforum-members


Trackinglink
Type
Specification PDF
Postman
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/
user_guides
postman/TMF702_Resource_Activation_and_Configuration_API_
user_guides_21.5.0.pdfNameResource Activation Management API
postman_21.5.0.zip
NameResource Activation Management API

 



Show If
special@anonymous

Image Added


21.5.0
v4.0.0
22-Nov-2021Resource, Common

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 


Image Removed
Show If
special@anonymous@authenticated
group
Show If
special@authenticatedtmforum-members


Trackinglink
TypeCTK-ConformanceSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformance/TMF702_Resource_Activation_swagger/TMF664-ResourceFunctionActivation-v4.0.0_conformance.swagger.pdfjson
NameResource Function Activation Management and Configuration API

 



Show If
special@anonymous

Image Removed Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeCTKSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ctk/TMF702-ResourceActivation.zipuser_guides/TMF664_Resource_Function_Activation_Management_API_REST_Specification_v4-0-0.pdf
NameResource Function Activation Management and Configuration API

 



Show If
special@anonymous

Image Removed

Image Added


Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.0.0
08-06-2022Resource, Common

Sales Management API

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.

TMF699


Show If
special@authenticated
Trackinglink
TypeRI
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/ri/TMF702_Resource_activation.zip
NameResource Activation Management API

 

Show If
special@anonymous@authenticated
Image Removed
group
show
tmforum-
ifspecial
members
@authenticated


Trackinglink
Type
Postman
Swagger
Licence
RAND
Apache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-
west-1.amazonaws.com/Beta/4.0.0/postman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zipNameResource Activation Management API

 

west-1.amazonaws.com/Beta/4.1.0/swagger/TMF699-Sales-v4.1.0.swagger.json
NameSales Management API

 



Show If
special@anonymous

Image Added

Show If
special@anonymous

Image Removed

21.5.0
v4.0.0
22-Nov-2021Resource, Common

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
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json
NameResource Function Activation and Configuration API

 

-west-1.amazonaws.com/Beta/4.1.0/user_guides/TMF699_Sales_Management_API_REST_Specification_v4.1.0.pdf
NameSales Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.1.0
08-06-2022MarketingSales

Service Activation Management API

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.

TMF640


Show If
special@anonymous

Image Removed

Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/user_guides/TMF664_Resource_Functionswagger/TMF640-Service_Activation_Management_API_REST_Specification_v4-0-0.pdf
NameResource Function Activation and Configuration API

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available 22
and_Configuration-v5.0.0
v4
.
0
oas.
0 08-06-2022Resource, Common

Sales Management API

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.

yaml
NameService Activation Management API

 



Show If
special@anonymous

Image Added

TMF699



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.10.0/swaggeruser_guides/TMF699-Sales-v4.1.0.swagger.jsonTMF640-Service_Activation_and_Configuration-v5.0.0.pdf
NameSales Service Activation Management API

 



Image Removed
Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Common, Service

Service Catalog Management API

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

TMF633


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.10.0/user_guides/TMF699_Sales_Management_API_REST_Specification_v4.1.0.pdf
NameSales Management API

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available 22
swagger/TMF633-Service_Catalog_Management-v5.0.0
v4
.
1
oas.
0 08-06-2022MarketingSales
yaml
NameService
Activation Management API

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.

Catalog Management API

 



Show If
special@anonymous

Image Added

TMF640



Show If
special@authenticated
grouptmforum-members


 
Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swaggeruser_guides/TMF640TMF633-Service_ActivationCatalog_and_ConfigurationManagement-v5.0.0.oas.yaml
NameService Activation Management API
pdf
NameService Catalog Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Service

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@anonymous

Image Removed

Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guidesswagger/TMF640TMF638-Service_ActivationInventory_and_ConfigurationManagement-v5.0.0.pdfoas.yaml
NameService Activation Inventory Management API

 



Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Common, Service

Service Catalog Management API

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

@anonymous

Image Added

TMF633



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swaggeruser_guides/TMF633TMF638-Service_CatalogInventory_Management-v5.0.0.oas.yamlpdf
NameService Catalog Inventory Management API

 



Image Removed
Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Service

Service Ordering Management API

The REST API for Service Order Management provides a standardized mechanism for placing a service order with all the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications.

TMF641


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guidesswagger/TMF633-Service_Catalog_ManagementTMF641-ServiceOrdering-v5.0.0.pdfoas.yaml
NameService Catalog Ordering Management API

 



Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Service

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
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swaggeruser_guides/TMF638-Service_Inventory_ManagementTMF641-ServiceOrdering-v5.0.0.oas.yamlpdf
NameService Inventory Ordering Management API

 



show-if
special@anonymous

Image Removed

if
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Service

Service Test Management API

The Service Test API provides a standardized mechanism for placing a service test with all 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
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/user_guidesswagger/TMF638TMF653-Service_InventoryTest_Management-v5.0.0.pdf
NameService Inventory Management API

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Service

Service Ordering Management API

The REST API for Service Order Management provides a standardized mechanism for placing a service order with all the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications.

TMF641
.0.0.oas.yaml
NameService Test Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF641-ServiceOrdering-user_guides/TMF653-Service_Test_Management-v5.0.0.pdf
NameService Test Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
21.5.0
v5.0.0
.oas.yamlName
10-Dec-2021Service

Service

Ordering

Usage Management API

 

Show If
special@anonymous
Image Removed

No description available yet

TMF727


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/54.0.0/user_guidesswagger/TMF641TMF727-ServiceOrderingServiceUsage-v5v4.0.0.swagger.pdfjson
NameService Ordering Usage Management API

 



Image Removed
Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Service

Service Test Management API

The Service Test API provides a standardized mechanism for placing a service test with all 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.

.0
v4.0.0
08-06-2022

Shipment Management Management API

Shipment Management

TMF711TMF653


Image Removed
Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/54.0.0/swagger/TMF653-Service_Test_Management-v5.0.0.oas.yaml
NameService Test Management API

 

Show If
special@anonymous
TMF711-ShipmentManagement-v4.0.0.swagger.json
NameShipment Management Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
v4.0.0
10-Jan-2022Business Partner

Shipping Order Management API

Provides the necessary functionality to create, update and query Shipping Orders. A Shipping Order is a document used by a business to specify what items are to be transferred from a storage location or warehouse to which person and to which new location. A ShippingOrder typically is sent along with a shipment of goods so that the person receiving them can verify that the document correctly reflects the items that they actually received.

TMF700


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/54.0.0/user_guidesswagger/TMF653-Service_Test_Management-v5TMF700-ShippingOrder-v4.0.0.swagger.pdfjson
NameService Test Shipping Order Management API

 



Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available
21.5.0
v5.0.0
10-Dec-2021Service

Service Usage Management API

TMF727


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerSpecification PDF
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF727-ServiceUsage-v4.0.0.swagger.jsonuser_guides/TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0.pdf
NameShipping Order NameService Usage Management API

 



Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.0.0
08-06-2022

Shipment Management Management API

Shipment Management

TMF711


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwaggerCTK-Conformance
LicenceApache 2.0RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF711-ShipmentManagement-conformance/TMF700_Shipping_Order_v4.0.0_conformance.swagger.jsonpdf
NameShipment Shipping Order Management Management API

 



Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
1022-JanNov-20222021Business Partner

Shipping Order SLA Management API

Provides the necessary functionality to create, update and query Shipping Orders. A Shipping Order is a document used by a business to specify what items are to be transferred from a storage location or warehouse to which person and to which new location. A ShippingOrder typically is sent along with a shipment of goods so that the person receiving them can verify that the document correctly reflects the items that they actually received.a standardized interface for Service Level Agreement (SLA) life-cycle Management (SLA Negotiation, SLA configuration SLA Activation/enforcement, SLA Operations, SLA violation / consequence handling, SLA reporting) between a Customer and a Service Provider which provides offers (product with attached SLA in its catalogue) the customer can discover, browse, trigger and order.

TMF623TMF700


Show If
special@authenticated
grouptmforum-members


 
Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF700-ShippingOrder-v4.0.0.swagger.json
NameShipping Order Management API
.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF623-SLA-v4.0.0.swagger.json
NameSLA Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.0.0
08-06-2022Business Partner

Trouble Ticket Management 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@anonymous

Image Removed

Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/user_guides/TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0.pdfswagger/TMF621-Trouble_Ticket-v5.0.0.oas.yaml
NameTrouble Ticket NameShipping Order Management API

 



Show If
special@anonymous

Image Removed Image Added



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeCTK-ConformanceSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/conformance/TMF700_Shipping_Order_v4user_guides/TMF621-Trouble_Ticket-v5.0.0_conformance.pdf
NameShipping Order Trouble Ticket Management API

 



Image Removed
Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
21 22.5.0
v4 v5.0.0
22-Nov-2021Business PartnerCommon

Usage Consumption Management API

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.

TMF677

SLA Management API

Provides a standardized interface for Service Level Agreement (SLA) life-cycle Management (SLA Negotiation, SLA configuration SLA Activation/enforcement, SLA Operations, SLA violation / consequence handling, SLA reporting) between a Customer and a Service Provider which provides offers (product with attached SLA in its catalogue) the customer can discover, browse, trigger and order.

TMF623


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF623TMF677-SLAUsageConsumption-v4.0.01.swagger.json
NameSLA Usage Consumption Management API

 



Show If
special@anonymous

Not yet available


Not yet available Not yet available Not yet available Not yet available
22.0.0
v4.0.0
08-06-2022Business Partner

Trouble Ticket Management 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).

yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021Product

Warranty Management

No description available yet

TMF715TMF621


Image Removed
Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/54.0.0/swagger/TMF621TMF715-Trouble_TicketWarrantyManagement-v5v4.0.0.oasswagger.yamljson
NameTrouble Ticket Management API

 

Show If
special@anonymous
Warranty Management

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.5.0
v4.0.0
Common

Work Management

No description available yet

TMF713


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDFSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/54.0.0/user_guidesswagger/TMF621TMF713-Trouble_TicketWorkManagement-v5v4.0.0.pdfswagger.json
NameTrouble Ticket Work Management API

 



Image Removed
Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.5.0
v5.0.0
Common
0
v4.0.0
Common

Work Order Management API

The Work Order API performs the following operations on a workOrder resource:

TMF697

Usage Consumption Management API

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.

TMF677


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF677TMF697-UsageConsumptionWorkOrder-v4.0.10.swagger.json
NameUsage Consumption Work Order Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
v4.0.0
22-Nov-2021ProductBusiness Partner

Work Order Qualification Management API

The Work Order API performs the following operations on a workOrder resource:

No description available yet

TMF714TMF697


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF697TMF714-WorkOrderWorkQualification-v4.0.0.swagger.json
NameWork Order Qualification Management API

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
22.5.0
v4.0.0
22-Nov-2021Business PartnerCommon


 Note: Reference/Sample implementation is not an architecture direction but a sample in a sandbox

...