Versions Compared

Key

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

...

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


22TMF703TMF675TMF701 21.5.0 PostmanRAND0postman/TMF702_Resource_Activation_and_Configuration_API_postman_21.5.0.zip

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

Digital Identity Account 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

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-
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/TMF720TMF666-DigitalIdentityAccount-v4.01.0.swagger.json
NameDigital Identity Account 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.01.0
2210-NovJan-20212022EngagedPartyBusiness Partner, CommonCustomer

Document Account Management API

TMF667 Document API describes the meta-data of a Document, such as the name, creationDate and lifecycle status. The (typically binary) body of this document (such as a Word.doc, PDF, Video clip, or Image) will be held in the associated Attachment(s) either by Ref or Value. If by value - the binary content is held in the Attachment.content. If by reference, the Attachment.url might point to a (file:) or remote (http:) pointer to the Document media.\n\n A Document may be associated with a DocumentSpecification, which will detail the characteristics of that type of Document (an Image may have a width, height and format; a Video may have a length and format).\n A Document has a collection of RelatedParty's, for roles such as author, reviewer, publisher, and a lifecycle status to take the document through a simple set of production stages.

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/5.0.0/swagger/TMF666-Account_Management-v5.0.0.oas.yaml
NameAccount Management API

 



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

Image Added


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

Image Added


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

Image Added


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

Image Added


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

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-2021Business Partner, Common

Dunning Case Management

No description available yet

TMF728


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/TMF728-DunningCase-v4.0.0.swagger.json
NameDunning Case 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

Entity Inventory Management API

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

TMF703


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/TMF703-EntityInventory-v4.0.0.swagger.json
NameEntity Inventory 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-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


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/TMF688-Event-v4.0.0.swagger.json
NameEvent 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/TMF688_Event_Management_API_user_guides_21.5.0.pdf
NameEvent Management API

 



Show If
special@anonymous

Image Added



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/TMF688_Event_Management_API_conformance_21.5.0.pdf
NameEvent Management API

 



Show If
special@anonymous

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
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF691-FederatedIdentity-v4.0.0.swagger.json
NameFederated ID 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/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).

TMF675


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/TMF675-GeographicLocation-v4.0.0.swagger.json
NameGeographic Location 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-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?”

TMF674


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/TMF674-GeographicSite-v5.0.0.oas.yaml
NameGeographic Site 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/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.5.0
v5.0.0
Common

Incident Management API

The Incident Management API provides a standardized mechanism to report, diagnose and resolve incidents and manages the entire lifecycle of incidents as defined by ITIL. The primary objective of incident management is to restore normal service operation as quickly as possible and minimize the adverse impact on business operations, ensuring that agreed levels of service quality are maintained

TMF724


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/TMF724-Incident-v4.0.0.swagger.json
NameIncident Management API

 



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
19-12-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.2.swagger.json
NameIntent

 



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/TMF921_Intent_Management_API_REST_Specification_v4-0-0v3.pdf
NameIntent

 



Show If
special@anonymous

Image Added


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


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/TMF669-PartyRole-v4.1.0.swagger.json
NameParty Role 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.1.0/user_guides/TMF669_Party_Role_Management_API_REST_Specification_v4.1.0.pdf
NameParty Role Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/conformance/TMF669_Party_Role_v4.1.0_conformance.pdf
NameParty Role Management API

 



Show If
special@anonymous

Image Added


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

Payment Method Management 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
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/swagger/TMF670-PaymentMethod-v4.1.0.swagger.json
NamePayment Method 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.1.0
22-Nov-2021Customer

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

TMF628


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/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

Policy Management API

Policy API is designed from SID Policy description. The Policy API is defined from Event-Condition-ActionECA definition: The Event part specifies the signal that triggers the invocation of the rule. The condition part is a logical test that, if satisfied or evaluates to true, causes the action to becarried out. The action part consists of updates or invocations on the local data

TMF723


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/TMF723-Policy_Management-v5.0.0.oas.yaml
NamePolicy Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
v5.0.0
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


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/TMF701-ProcessFlow-v4.1.0.swagger.json
NameProcess Flow 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.1.0/user_guides/TMF701_Process_Flow_Management_API_Specification_v4.1.0.pdf
NameProcess Flow Management API

 



Show If
special@anonymous

Image Added



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.1.0/conformance/TMF701_Process_Flow_Management_Conformance-v4.1.0.pdf
NameProcess Flow Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available
19.0.1
v4.1.0
22-Nov-2021Common

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


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/TMF701-ProcessFlow_Management-v5.0.0.oas.yaml
NameProcess Flow Management API

 



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

TMF620


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_Management-v5.0.0.oas.yaml
NameProduct Catalog 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/5.0.0/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@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/TMF637-ProductInventory-v5.0.0.oas.yaml
NameProduct Inventory 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/5.0.0/user_guides/TMF637-ProductInventory-v5.0.0.pdf
NameProduct Inventory 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 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


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/TMF679-ProductOfferingQualification-v5.0.0.oas.yaml
NameProduct Offering Qualification 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/5.0.0/user_guides/TMF679-ProductOfferingQualification-v5.0.0.pdf
NameProduct Offering Qualification 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 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


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/TMF622-ProductOrdering-v5.0.0.oas.yaml
NameProduct Ordering 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/5.0.0/user_guides/TMF622-ProductOrdering-v5.0.0.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
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 Added


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
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.

TMF648


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/TMF648-Quote-v5.0.0.oas.yaml
NameQuote 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/5.0.0/user_guides/TMF648-Quote-v5.0.0.pdf
NameQuote 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

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

TMF680


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/TMF680-Recommendation-v4.0.0.swagger.json
NameRecommendation 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/TMF680_Recommendation_API_user_guides_21.5.0.pdf
NameRecommendation Management API

 



Show If
special@anonymous

Image Added



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/TMF680_Recommendation_API_conformance_21.5.0.pdf
NameRecommendation Management API

 



Show If
special@anonymous

Image Added


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

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

TMF664TMF667


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/TMF667-Document-v4.0.0.swagger.json
NameDocument Management API

 

Show If
special@anonymous

Image Removed

Not yet available Not yet available Not yet available Not yet available Not yet available
/Beta/4.0.0
/swagger/TMF664-ResourceFunctionActivation-v4.0.0
05-Jan-2022Common

Entity Inventory Management API

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

.swagger.json
NameResource Function Activation and Configuration 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/4.0.0/swagger/TMF703-EntityInventory-v4.0.0.swagger.jsonuser_guides/TMF664_Resource_Function_Activation_Management_API_REST_Specification_v4-0-0.pdf
NameResource Function Activation and Configuration NameEntity Inventory 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
21.5 22.0.0
v4.0.0
2208-Nov06-20212022Resource, Common

Event Resource 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.intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.

TMF639TMF688


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/TMF688-Event-v4.0.0.swagger.json
NameEvent Management API

 

-1.amazonaws.com/Beta/5.0.0/swagger/TMF639-Resource_Inventory_Management-v5.0.0.oas.yaml
NameResource Inventory Management API

 



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
Resource

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@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/TMF688_Event_Management_API_user_guides_21.5.0.pdfswagger/TMF699-Sales-v4.1.0.swagger.json
NameSales NameEvent 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/4.01.0/conformanceuser_guides/TMF688TMF699_EventSales_Management_API_REST_conformanceSpecification_21v4.51.0.pdf
NameEvent Sales Management API

 



Show If
special@anonymous

Image Added Image Removed


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

Federated Identity Sales 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, …).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.

TMF699TMF691


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/4.0.0/swagger/TMF691-FederatedIdentity-v4.0.0.swagger.json
NameFederated Identity API

 

Show If
special@anonymous
.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF699-Sales-v5.0.0.oas.yaml
NameSales Management API

 



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
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@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/TMF691_Federated_Identity_API_user_guides_21.5.0.pdf
NameFederated Identity 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-2021Common

Geographic Location Management API

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

swagger/TMF640-Service_Activation_and_Configuration-v5.0.0.oas.yaml
NameService Activation 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.0.0/swaggeruser_guides/TMF675-GeographicLocation-v4TMF640-Service_Activation_and_Configuration-v5.0.0.swagger.jsonpdf
NameGeographic Location Service Activation 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
21 22.5.0
v4.0 v5.0
22-Nov-2021
.0
Common, Service

IoT Device Service Catalog Management API Component Suite

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.

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

TMF633TMF908


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/TMF908-IoTAgentAndDevice-v4TMF633-Service_Catalog_Management-v5.0.0.swaggeroas.jsonyaml
NameIoT Device Service Catalog Management API Component Suite

 



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/45.0.0/user_guides/TMF908_IoT_Device_Management_API_Component_Suite_user_guides_21.5TMF633-Service_Catalog_Management-v5.0.0.pdf
NameIoT Device Service Catalog Management API Component Suite

 



Show If
special@anonymous


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

Service Inventory IoT Service Management API Component Suite

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.

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

TMF638TMF914


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/TMF914-IotService-v4TMF638-Service_Inventory_Management-v5.0.0.swaggeroas.jsonyaml
NameIoT Service Inventory Management API Component Suite

 



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/45.0.0/user_guides/TMF914_IoT_Service_Management_API_Component_Suite_user_guides_21.5TMF638-Service_Inventory_Management-v5.0.0.pdf
NameIoT Service Inventory Management API Component Suite

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available
21 22.5.0
v4 v5.0.0
22-Nov-2021Product, Common, Resource, ServiceService

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

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


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.0.0/swagger/TMF670TMF641-PaymentMethodServiceOrdering-v4v5.0.0.swaggeroas.jsonyaml
NamePayment Method Service Ordering 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/45.0.0/user_guides/TMF670_Payment_Method_API_user_guides_21.5TMF641-ServiceOrdering-v5.0.0.pdf
NamePayment Method Service Ordering Management API

 



Show If
special@anonymous


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

Service Test Performance Management API

Provides The Service Test 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.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.

TMF653TMF628


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-v4TMF653-Service_Test_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:

Service 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/4.0.0/swagger/TMF701-ProcessFlow-v4.0.0.swagger.json
NameProcess Flow Management API

 

1.amazonaws.com/Beta/5.0.0/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
10-Dec-2021Service

Service Usage Management API

No description available yet

TMF727


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.0.0/user_guides/TMF701_Process_Flow_Management_API_user_guides_19swagger/TMF727-ServiceUsage-v4.0.0.1swagger.pdfjson
NameProcess Flow Service Usage Management API

 



Show If
special@anonymous

Image Removed Image Added



Show If
special@authenticated
grouptmforum-members@authenticated


Trackinglink
TypeCTK-ConformanceSpecification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/conformanceuser_guides/TMF701TMF727_ProcessService_FlowUsage_Management_API_REST_conformance_19.Specification_v4-0-0.1.pdf
NameProcess Flow Service Usage Management API

 



Show If
special@anonymous

Image Removed Image Added


Not yet available Not yet available Not yet available
19.0.1
v4.0.0
22-Nov-2021CommonNot yet available
22.0.0
v4.0.0
08-06-2022

Shipment Management Management API

Shipment Management

TMF711

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


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

 



Show If
special@anonymous


Not yet available Not yet available Not yet available Not yet available Not yet available
v4.0.0
2210-NovJan-20212022ProductBusiness 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

Recommendation 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 omni-channel.

TMF680


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/TMF680TMF700-RecommendationShippingOrder-v4.0.0.swagger.json
NameRecommendation Shipping Order 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_RecommendationTMF700_Shipping_Order_Management_API_userREST_guides_21.5.Specification_v4-0-0.pdf
NameRecommendation Shipping Order 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/TMF680TMF700_RecommendationShipping_APIOrder_conformance_21v4.50.0_conformance.pdf
NameRecommendation Shipping Order Management API

 



Show If
special@anonymous


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

Resource Activation and Configuration 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.

Business Partner

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.

TMF623TMF702


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/4.0.0/swagger/TMF702TMF623-ResourceActivationSLA-v4.0.0.swagger.json
NameResource Activation and Configuration API

 

Show If
special@anonymous
SLA 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

Stock Management

No description available yet

TMF687


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/TMF702_Resource_Activation_and_Configuration_API_user_guides_21.5.0.pdf
NameResource Activation and Configuration API
swagger/TMF687-Stock-v4.1.0.swagger.json
NameStock Management

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available Not yet available
22.5.2
v4.1.0
16-11-2022Common

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

Image Removed

Not yet available Not yet available Not yet available
Show If
special@authenticated
grouptmforum-members


Trackinglink
Type
Swagger
Licence
Apache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.
1.0/
NameResource Activation and Configuration API

 

swagger/TMF621-TroubleTicket-v4.1.0.swagger.json
NameTrouble Ticket Management API

 



Show If
special@anonymous

Image Added

Show If
special@anonymous

Image Removed

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

Service Test Management API

Service Test Description



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.20.0/swagger/TMF653-ServiceTest-v4.2.0.swagger.json
NameService Test Management API

 

user_guides/TMF621-Trouble_Ticket-v5.0.0.pdf
NameTrouble Ticket Management API

 



Show If
special@anonymous

Image Added


Not yet available Not yet available Not yet available Not yet available
22.5.0
v4.1.0
Common

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@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.2.0/user_guides/TMF653_Service_Test_Management_API_REST_Specification_v4-2-0.pdf.0.0/swagger/TMF677-UsageConsumption-v4.0.1.swagger.json
NameUsage Consumption NameService Test 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
21.5.0
v4.0.0
22-Nov-2021Product

Warranty Management

No description available yet

TMF715


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeCTK-ConformanceSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.20.0/conformance/TMF653_Service_Test_swagger/TMF715-WarrantyManagement-v4.20.0_conformance.swagger.pdfjson
NameService Test Warranty 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
v4.0.0
Common

Work Management

No description available yet

TMF713


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeCTKSwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.20.0/ctkswagger/TMF653-ServiceTest.zipTMF713-WorkManagement-v4.0.0.swagger.json
NameService Test 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
v4.0.0
Common

Work Order Management API

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

TMF697


Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeRISwagger
LicenceRANDApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/45.20.0/riswagger/TMF653_ServiceTest.zipTMF697-Work_Order-v5.0.0.oas.yaml
NameService Test Work Order 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
v4.0.0
22-Nov-2021Business Partner

Work Order Management API

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

TMF697


Show If
special@authenticated
grouptmforum-members


Trackinglink
Type
Swagger
Licence
Apache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.
0.0/
swagger/
TMF697-
WorkOrder-v4.
0.0.
swagger.json
Name
Work Order Management API

 



Show If
special@anonymous

Image Removed

21.5.0
v4.0.0
10-Dec-2021Service Not yet available Not yet available Not yet available Not yet available Not yet available
22.5.0
v4.0.0
22-Nov-2021Business Partner

Work Qualification Management

No description available yet

TMF714

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
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/swagger/TMF700TMF714-ShippingOrderWorkQualification-v4.0.0.swagger.json
NameShipping Order Work Qualification 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-2021EngagedParty

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.

.0.0
Common

Zero Touch Partnering

The ZTP API suite v1 captures the essential suite of APIs required to enable multi-party partnering at scale. These APIs reuse the existing TMF Open APIs however there have been up versions to cater for multi-party partnering which have been incorporated into the baseline APIs. The suite covers key functional areas as captured in the TMF916A ZTP API profile v2, Ecosystem Factory, Partner Onboarding Management, Product Onboarding, Partner Event Management, Partner Problem Management. Additional areas will be covered in the next iteration of the suite, Partner Settlement and Billing, Party Knowledge Management, Campaign Management within the Ecosystem, Front End Partner Management within the Ecosystem. The APIs in this suite are based on V4 TMF Open APIs.

TMF916TMF677


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/TMF677TMF916-UsageConsumptionZeroTouchPartnering-v4.0.10.swagger.json
NameUsage Consumption 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-2021Product
Zero Touch Partnering

 



Show If
special@anonymous

Image Added


Work Order Management API

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

TMF697


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/TMF697-WorkOrder-v4.0.0.swagger.jsonuser_guides/TMF916_Zero_Touch_Partnering_Management_API_REST_Specification_v4-0-0.pdf
NameZero Touch PartneringNameWork Order 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.5.0
v4.0.0
22-Nov-2021EngagedPartyCommon


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

...