Page tree

Versions Compared

Key

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

...

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


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
Show If
special@authenticated
grouptmforum-members
Trackinglink

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.
0
1.0/swagger/
TMF720
TMF666-
DigitalIdentity
Account-v4.
0
1.0.swagger.json
Name
Digital Identity
Account Management API

 



Show If
special@anonymous

Image Modified


Not yet available Not yet available Not yet available Not yet available Not yet available
21.5.0
4
v4.
0Entity Inventory
1.0
EngagedParty, Common
10-Jan-2022Business Partner, Customer

Change Management API

The

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

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/
TMF703
TMF655-
EntityInventory
Change-v4.0.0.swagger.json
Name
Entity Inventory
Change Management API

 



Show If
special@anonymous

Image Modified


Not yet available Not yet available Not yet available Not yet available Not yet available
21
v4.
5
0.0
4.0.0
10-Jan-2022Common
Event TMF688

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

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

 



Show If
special@anonymous

Image Modified

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
05-Jan-2022Customer

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
@anonymous
@authenticated
Image Removed@authenticated
group
Show Ifspecial
tmforum-members


Trackinglink
Type
CTK-Conformance
Swagger
Licence
RAND
Apache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/
conformance/TMF688_Event_Management_API_conformance_21.5
swagger/TMF720-DigitalIdentity-v4.0.0.
pdf
swagger.json
Name
Event
Digital Identity 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
4
v4.0.0
22-Nov-2021Business Partner, Common
Federated Identity

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

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/
TMF691
TMF703-
FederatedIdentity
EntityInventory-v4.0.0.swagger.json
Name
Federated Identity  
Entity Inventory Management API

 



Show If
special@anonymous

Image Modified

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


Show If
special
@anonymous

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

Image Removed

Not yet availableNot yet availableNot yet availableNot yet available
21.5.0
4.0.0
Common
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
TMF688-
GeographicLocation
Event-v4.0.0.swagger.json
Name
Geographic Location Show If
special@authenticated
grouptmforum-members
TrackinglinkTypeSwaggerLicenceApache 2.0
Event Management API

 



Show If
special@anonymous

Image Modified

Not yet availableNot yet availableNot yet availableNot yet availableNot yet available
21.5.0
4.0.0
Common

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

TMF908



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/
swagger/TMF908-IoTAgentAndDevice-v4.0
conformance/TMF688_Event_Management_API_conformance_21.5.0.
swagger.json
pdf
Name
IoT Device
Event Management API
Component Suite

 



Show If
special@anonymous

Image Removed

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 Device Management API Component Suite

 

Show If
special@anonymous

Image Removed

Not yet availableNot yet availableNot yet availableNot yet available
21.5.0
4.0.0
Resource

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.

TMF914 Show If
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/
TMF914
TMF691-
IotService
FederatedIdentity-v4.0.0.swagger.json
Name
IoT Service
Federated ID Management API
Component Suite

 



Show If
special@anonymous

Image Modified



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
TMF691_
IoT
Federated_
Service
Identity_
Management_
API
_Component_Suite
_user_guides_21.5.0.pdf
Name
IoT Service
Federated ID Management API
Component Suite

 



Show If
special@anonymous

Image Modified


Not yet available Not yet available Not yet available Not yet available
21.5.0
4
v4.0.0
Product, Common, Resource, Service

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
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/
TMF670
TMF675-
PaymentMethod
GeographicLocation-v4.0.0.swagger.json
Name
Payment Method
Geographic Location Management API

 



Show If
special@anonymous

Image Modified

Show If
special@authenticated
grouptmforum-members
TrackinglinkTypeSpecification PDFLicenceRANDLinkhttps:


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

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/
user_guides/TMF670_Payment_Method_API_user_guides_21.5.0.pdfNamePayment Method API
swagger/TMF921-Intent-v4.0.0.swagger.json
NameIntent

 



Show If
special@anonymous
Image Removed
Not yet available Not yet available Not yet available Not yet available Not yet available
21
22.
5
0.0
4

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
v4.0.0
Customer
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/
TMF628
TMF908-
Performance
IoTAgentAndDevice-v4.0.0.swagger.json
Name
Performance Show Ifspecial
IoT Agent and Device Management API

 



Show If
special@anonymous

Image Modified

Not yet availableNot yet availableNot yet availableNot yet availableNot yet available
21.5.0
4.0.0
Service, 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
Type
Swagger
Specification PDF
Licence
Apache 2.0
RAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/
swagger/TMF701-ProcessFlow-v4.0.0.swagger.jsonNameProcess Flow
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 Removed

Show If
special@authenticated
grouptmforum-members
TrackinglinkTypeSpecification PDFLicenceRANDLink
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/
user_guides/TMF701_Process_Flow_Management_API_user_guides_19.0.1.pdfNameProcess Flow
swagger/TMF914-IotService-v4.0.0.swagger.json
NameIoT Service Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
grouptmforum-members


Trackinglink
Type
CTK-Conformance
Specification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/
conformance
user_guides/
TMF701
TMF914_
Process
IoT_
Flow
Service_Management_API
_conformance_19
_Component_Suite_user_guides_21.5.0.
1.
pdf
Name
Process Flow
IoT Service Management API

 



Show If
special@anonymous

Image Added

Image Removed


Not yet available Not yet available Not yet available Not yet available
19
21.5.0
.1
4
v4.0.0
22-Nov-2021Product, Common

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
, 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/
TMF671
TMF725-
Promotion
MetadataCatalog-v4.0.0.swagger.json
Name
Promotion
Metadata Catalog Management API

 



Show If
special@anonymous

Image Modified


Not yet available Not yet available Not yet available Not yet available Not yet available
21
v4.
5TMF680
0.0
4.0.0
Product

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.

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
special@authenticated
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.
0
1.0/swagger/
TMF680
TMF669-
Recommendation
PartyRole-v4.
0
1.0.swagger.json
Name
Recommendation Show If
special@anonymous
Image Removed
Party Role Management API

 



Show If
special@anonymous

Image Modified

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 API

 


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

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
Type
CTK-Conformance
Swagger
Licence
RAND
Apache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.0.0/
conformance/TMF680_Recommendation_API_conformance_21.5.0.pdfNameRecommendation
swagger/TMF628-Performance-v4.0.0.swagger.json
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
4
v4.0.0
CustomerResource Activation and Configuration
22-Nov-2021Service, Common

Process Flow 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.TMF702 Show If

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.
0
1.0/swagger/
TMF702
TMF701-
ResourceActivation
ProcessFlow-v4.
0
1.0.swagger.json
Name
Resource Activation and Configuration
Process Flow Management API

 



Show If
special@anonymous

Image Modified



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
1.0/user_guides/
TMF702
TMF701_
Resource
Process_
Activation
Flow_
and_Configuration
Management_API_
user
Specification_
guides_21
v4.
5
1.0.pdf
Name
Resource Activation and Configuration
Process Flow Management API

 



Show If
special@anonymous

Image Modified

Not yet availableNot yet available

Not yet available



Show If
special@authenticated


Trackinglink
Type
Postman
CTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.
0
1.0/
postman
conformance/
TMF702
TMF701_
Resource
Process_
Activation
Flow_
and_Configuration_API_postman_21.5
Management_Conformance-v4.1.0.
zip
pdf
Name
Resource Activation and Configuration
Process Flow Management API

 



Show If
special@anonymous

Image Removed

21.5.0
4.0.0
Resource, Common

Service Test Management API

Service Test Description

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

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.
2
0.0/swagger/
TMF653
TMF671-
ServiceTest
Promotion-v4.
2
0.0.swagger.json
Name
Service Test
Promotion Management API

 



Show If
special@anonymous

Image Modified

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/TMF653_Service_Test_Management_API_REST_Specification_v4-2-0.pdf
NameService Test 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-2021Product

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
@anonymous
@authenticated
Image Removed
group
show
tmforum-
if
members
special@authenticated


Trackinglink
Type
CTK-Conformance
Swagger
Licence
RAND
Apache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.
2
0.0/
conformance/TMF653_Service_Test_
swagger/TMF680-Recommendation-v4.
2
0.0
_conformance
.swagger.
pdfNameService Test Management API 
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 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.

TMF702


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/TMF702-ResourceActivation-v4.0.0.swagger.json
NameResource Activation 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/TMF702_Resource_Activation_and_Configuration_API_user_guides_21.5.0.pdf
NameResource Activation 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/TMF702_Resource_Activation_v4.0.0_conformance.pdf
NameResource Activation Management API

 



Show If
special@anonymous

Image Added



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

 



Show If
special@anonymous

Image Added



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

Image Added



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
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.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


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/TMF664-ResourceFunctionActivation-v4.0.0.swagger.json
NameResource Function Activation and Configuration 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/TMF664_Resource_Function_Activation_Management_API_REST_Specification_v4-0-0.pdf
NameResource Function Activation and Configuration API

 



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


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-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@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/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 Usage Management API

TMF727


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/TMF727-ServiceUsage-v4.0.0.swagger.json
NameService Usage 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-2022

Shipment Management Management API

Shipment Management

TMF711


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/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
@anonymous
@authenticated
Image Removed@authenticated
group
Show Ifspecial
tmforum-members


Trackinglink
Type
CTK
Swagger
Licence
RAND
Apache 2.0
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.
2
0.0/
ctk
swagger/
TMF653-ServiceTest.zip
TMF700-ShippingOrder-v4.0.0.swagger.json
Name
Service Test
Shipping Order Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated
grouptmforum-members


Trackinglink
Type
RI
Specification PDF
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.
2.0/ri/TMF653_ServiceTest.zipNameService Test
0.0/user_guides/TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0.pdf
NameShipping Order Management API

 



Show If
special@anonymous
Image Removed


Show If
special@authenticated


Trackinglink
Type
Postman
CTK-Conformance
LicenceRAND
Linkhttps://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/4.
2
0.0/
postman/TMF653-ServiceTest-
conformance/TMF700_Shipping_Order_v4.
2
0.0
.postman
_
collection
conformance.
json
pdf
Name
Service Test
Shipping Order Management API

 



Show If
special@anonymous
Image Removed
Not yet available Not yet available Not yet available
21.5.0
4
v4.0.0
Service

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
22-Nov-2021Business 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.

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/
TMF700
TMF623-
ShippingOrder
SLA-v4.0.0.swagger.json
Name
Shipping Order
SLA Management API

 



Show If
special@anonymous

Image Modified


Not yet available Not yet available Not yet available Not yet available Not yet available
21
22.
5
0.0
4
v4.0.0
EngagedParty
08-06-2022Business Partner

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/TMF677-UsageConsumption-v4.0.1.swagger.json
NameUsage Consumption Management API

 



Show If
special@anonymous

Image Modified


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

Work Order Management API

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

TMF697


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/TMF697-WorkOrder-v4.0.0.swagger.json
NameWork Order Management API

 



Show If
special@anonymous

Image Modified


Not yet available Not yet available Not yet available Not yet available Not yet available
4
v4.0.0
EngagedParty
22-Nov-2021Business Partner


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

...