Page tree
Skip to end of metadata
Go to start of metadata

  

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

In order to meet these challenges, TM Forum members including the world’s largest service providers and suppliers, have been working to develop APIs that enable the open digital ecosystem and provide critical management functionality to digital services.

This table contains links to both Release and Beta versions of the Open APIs.

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

Please note that Comments are no longer permitted on this page. If you have any questions regarding the content of the Open API Table please post them as discussion topics on the Open API Community Forum.


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

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

Login

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

Register

TM Forum Open APIs

 

Start adding filters for your table either in the macro settings or on the filtration pane.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

TM Forum Open APIs

_____________________________________

Document Number

Swagger

(Apache 2.0 or RAND)

API Specification

(RAND)

Conformance Profile

(RAND)

CTK

Reference Implementation Code

Postman CollectionReleaseLifecycle Status

Account Management API

Provides standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts

TMF666

R18.0 Refresh in progress

R18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

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

Not yet availableNot yet available

15.5.1 

Agreement Management API

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

TMF651

R18.0 Refresh in progress

R18.0 Refresh in progress

R18.0 Refresh in progress

18.0.0Updated

Alarm Management API

The Alarm Management API applies lessons that were learned in previous generations of similar APIs that were implemented in the Telecommunication industry, starting from ITU recommendations,, TM Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment initiative between 3GPP and TM Forum interfaces, and the more recent ETSI work on requirements for NFV interfaces.

TMF642

Not yet availableNot yet availableNot yet available17.0.1 

Appointment API

The appointment API provides a standardized mechanism to book an appointment with all the necessary appointment characteristics. The API allows searching of free slots based on parameters, as for example a party, then creating the appointment. The appointment has characteristics such as nature of appointment, place of appointment.

TMF646

R18.0 Refresh in progress

R18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

Change Management API

The Change Management API provides standard integration capabilities between external applications and Change Management Application. The API consists of a simple set of operations that interact with a Change Request in a consistent manner.

TMF655

R18.0 Refresh in progress

R18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

Communication API

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

TMF681

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

Customer Bill Management API

This API allows operations to find and retrieve one or several customer bills (also called invoices) produced for a customer also allows operations to find and retrieve the details of applied customer billing rates presented on a customer bill.

TMF678

Not yet availableNot yet availableNot yet available17.5.0 

Customer Management API

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

TMF629

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

Document Management API

Provides the operations to synchronize documents and document versions across systems. It also provides operations for uploading documents by Users as well as for viewing of documents online

TMF667

Not yet availableNot yet available17.0.1 

Entity Catalog Management API

The entity catalog is intended to provide any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. The API provides management of the entity specifications and their associations thru CRUD operations.

TMF662

Not yet availableNot yet availableNot yet available17.0.1 

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

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0New

Geographic Address Management API

Provides a standardized client interface to an Address management system. It allows looking for worldwide addresses. It can also be used to validate geographic address data, to be sure that it corresponds to a real geographic address. Finally, it can be used to look for a geographic address by: searching an area as a start (city, town ...), then zooming on the streets of this area, and finally listing all the street segments (numbers) in a street.

TMF673

Not yet availableNot yet availableNot yet available17.5.0 

Geographic Location Management API

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

TMF675

Not yet availableNot yet availableNot yet available17.5.0 

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

Not yet availableNot yet availableNot yet available17.5.0 

Loyalty Management API

Supports the management of loyalty program specifications, loyalty program members, their associated products and loyalty accounts with loyalty balances

TMF658

Not yet availableNot yet available

17.0.1 

Partnership Type Management API

Standardized mechanisms for creating partnership types. It is one of the APIs involved in an onboarding process. Identifies a type of a partnership between parties, including the list of role types that are permitted (i.e Buyer, Seller, Developer). Role types may refer to agreement specifications to be signed by parties playing the role.
The API allows the retrieval, creation, update, and deletion of partnership type and its owned sub-resources.

TMF668

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

Party Interaction Management API

A User Interaction captures information about past interactions in order to re-use it in future ones. This allows agents to serve users better by knowing the steps they went through. It also allows customers to see better the actions they have performed and how they interacted with us.

TMF683

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0New

Party Management API

Provides a standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events.
Party can be an individual or an organization that has any kind of relationship with the enterprise.

TMF632

Not yet availableNot yet available

14.5.0 

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

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0 Updated

Payment Management API

The Payments API provides the standardized client interface to Payment Systems for notifying about performed payments or refunds. Examples of Payment API originators (clients) include Web servers, mobile app servers, Contact center dashboards or retail store systems. 

TMF676

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.1Updated

Payment Methods API

This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer.

TMF670

Not yet available

Not yet available

17.5.0 

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. 

TMF628Not yet available

Not yet availableNot yet available

Not yet available14.5.1 

Performance Management Threshold API

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

TMF649

Not yet availableNot yet availableNot yet availableNot yet available17.0.1 

Prepay Balance Management API

REST API for Balance Management. It includes the model definition as well as all available operations for prepay balance management. Prepaid subscribers pay fees before using services. Therefore, the subscribers must have sufficient balances. Operators can provide multiple recharge channels for subscribers. Subscribers can pass credit between different subscriptions, therefore transferring the balance from one account to another.

TMF654

Not yet available

 

Not yet available

17.0.1 

Privacy Management API

The Privacy management APIprovidesstandardizedmechanismfor privacy profile types, privacy profiles and privacy agreements such as creation, update, retrieval, deletion and notification of events..

TMF644

Not yet availableNot yet available

16.0.1 

Product Catalog Management API

Provides a standardized solution for rapidly adding partners’ products to an existing Catalog. It brings the capability for Service Providers to directly feed partners systems with the technical description of the products they propose to them. 

TMF620

17.5.1 

Product Inventory Management API

Provides standardized mechanism for product inventory management such as creation, partial or full update and retrieval of the representation of a product in the inventory. It also allows the notification of events related to product lifecycle.

TMF637

R18.0 Refresh in progress

R18.0 Refresh in progress

R18.0 Refresh in progress

18.0.0Updated

Product Offering Qualification 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

Not yet availableNot yet availableNot yet available17.5.1 

Product Ordering API

Provides a standardized mechanism for placing a product order with all of the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order negotiation systems in a consistent manner. A product order is created based on a product offering that is defined in a catalog. The product offering identifies the product or set of products that are available to a customer and includes characteristics such as pricing, product options and market.

TMF622

Not yet available

17.5.0 

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

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

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

TMF648

Not yet available

17.5.0 

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

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

Resource Catalog Management API

The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering process.

TMF634

Not yet availableNot yet availableNot yet available17.0.1 

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

Not yet availableNot yet availableNot yet available17.5.0 

Resource Inventory Management API

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

TMF639

Not yet availableNot yet available17.0.1 

Resource Ordering Management API

The REST API for Resource Order Management. It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Resource Orders (including filtering). A Resource Order API provides a standard mechanism for placing a Resource Order with all necessary order parameters.

TMF652

Not yet availableNot yet availableNot yet availableNot yet available16.5.1 

Resource Pool Management API

Resource Pool management API provides a feature of resource reservation at pre-order phase. In order to reserve a physical product, logical product, and virtual product, the API uses the idea of a resource pool.

TMF685

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0New

Service Catalog API

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

TMF633

Not yet availableNot yet availableNot yet available17.5.0 

Service Inventory Management API

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

TMF638

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.1Updated

Service Ordering Management API

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

TMF641

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.1Updated

Service Qualification API

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

TMF645

R18.0 Refresh in progress

R18.0 Refresh in progress

R18.0 Refresh in progress

 

18.0.1Updated

Service Quality Management API

Through this API, any Enterprise is able to access a Service Quality Management application and extract Service Level Specifications and associated Service Level Objectives (SLO) and their thresholds.

TMF657

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

Service Test Management API  

The Service Test API provides a standardized mechanism for placing a service test with all of the necessary test parameters. The API consists of a simple set of operations that interact with CRM/Service Management systems in a consistent manner. A service test is a procedure intended to check the quality, performance, or reliability of a service.

TMF653

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

Shipment Tracking API

Shipment Tracking captures information about the current status of the shipment, the past checkpoints and the estimated arrival date. Via this API, tracking information can be retrieved by providing an order Id or the shipping company’s tracking id.

TMF684

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.1New

Shopping Cart API

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

TMF663

R18.0 Refresh in progressR18.0 Refresh in progressR18.0 Refresh in progress18.0.0Updated

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

Not yet availableNot yet available

14.5.1 

Trouble Ticket API

Provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets among partners as a result of an issue or problem identified by a customer or another system. Examples of Trouble Ticket API clients include CRM applications, network management or fault management systems, or other trouble ticket management systems (e.g. B2B).

TMF621

R18.0 Refresh in progress

 

R18.0 Refresh in progress

 

R18.0 Refresh in progress

 

18.0.0Updated

Usage Consumption Management API

This API should allow viewing in real-time the balance of the various buckets (SMS, Voice, Data for example) that a user consumes with each of his devices and the usages done out of the bucket. A usage report retrieves the data related to these balances. This API should also allow performing a direct top-up on the balance of a prepaid bucket with voucher references or with a given credit value after a payment done by a credit card or with a credit value transfer.

TMF677

Not yet availableNot yet availableNot yet available17.5.0 

Usage Management API

 Provides standardized mechanism for usage management such as creation, update, retrieval, import and export of a collection of usages. The API manages both rated and non-rated usage. For example, it allows a service provider to 1) retrieve usage generated by a partner service platform in order to rate it and 2) to provide rated usage to a partner for consumption follow up purposes.

TMF635

Not yet availableNot yet available

14.5.1 

User Roles & Permissions API

A user role is defined as the entity that defines a set of privileges covering various functions and/or manageable assets. When a user is assigned a given role then it is actually allocated all the privileges defined for that role type and the corresponding permissions are created for that user.

TMF672

Not yet availableNot yet availableNot yet available17.0.1 

TM Forum Open APIs Early Adopters

_____________________________________

Document Number

Swagger

(Apache 2.0 or RAND)

API Specification

(RAND)

Conformance Profile

(RAND)

CTK

Reference Implementation Code

Postman CollectionReleaseLifecycle Status

Service Problem Management

The SPM API is used to manage service problems. Service problems are generated based on the information declared by a partner or the event information notified from infrastructure providers. The event information includes alarm information, performance anomaly information, trouble ticket information, SLA violation, maintenance information, and prediction information.

TMF656

Not yet availableNot yet availableNot yet availableNot yet availableR18.0 compatibleBeta

 

 

 

 

  • No labels

82 Comments

  1. Hi,

    This is related to "Activation and Configuration API" Swagger. The basePath is not as per TMF630 (Rest API Design Principle).

    The TMF630 suggests (Release 17.5.0, REST API Design Guidelines Part 1) to use a camel case nomenclature and hence instead of "ActivationAndConfiguration" it should be "activationAndConfiguration"

    1. Hi Abdul,

      We are enforcing the rule that the API reosurce and task names are camel case as per API Design Guidelines V3.

      "Names in URI (tasks, individual resources, etc.) MUST be camel case or lower case"

      What you are asking for is to make the API name itself follow the camelCase convention (at least for our Swagger definitions) which I concur evidently with. However we can't enforce strict rules for how other piece of the URI will be presented i.e host name and domain information.

      Regard Pierre

  2. Speaking of inconsistencies, I've pulled down all the swagger files, and this is the list of the base urls for the APIs:

    • Account Management API /tmf-api/accountManagement
    • Activation and Configuration API /DSEntityProvisioning/api/ActivationAndConfiguration/v2
    • Address API /
    • Agreement Management API /tmf-api/agreementManagement
    • Alarm Management API /DSPerformancealarm/api/alarm/v1
    • Appointment API /
    • Billing Management API /DSBillingManagement/api/billingManagement/v2
    • Change Management API /tmf-api/changeManagement
    • Customer Management API /tmf-api/customerManagement
    • Document Management API /tmf-api/documentManagement
    • Entity Catalog Management API /tmf-api/entityCatalogManagement
    • Loyalty Management API /loyaltyManagement
    • NFV Entity Provisioning API /DSEntityProvisioning/api/EntityProvisioning/v2
    • Onboarding Management API /tmf-api/onboardingManagement
    • Partnership Type Management API /tmf-api/partnershipTypeManagement
    • Party Management API /DSPartyManagement/api/partyManagement/v2
    • Party Role Management API /tmf-api/partyRoleManagement
    • Payment Methods API /paymentMethods/v0
    • Performance Management Threshold API undefined
    • Prepay Balance Management API /tmf-api/PrepayBalanceManagement
    • Privacy Management API /
    • Product Catalog Management API /DSProductCatalog/api/catalogManagement/v2
    • Product Inventory Management API /DSProductInventory/api/productInventory/v2
    • Product Ordering API /DSProductOrdering/api/productOrdering/v2
    • Promotion API /tmf-api/promotion
    • Quote API /tmf-api/quoteManagement
    • Resource Catalog Management API /tmf-api/resourceCatalogManagement
    • Resource Function Activation and Configuration API /DSResourceFunctionCA/api/ResourceFunctionCA/v1
    • Resource Inventory Management API /tmf-api/resourceInventoryManagement
    • SLA Management API /DSLAManagement/api/slaManagement/v2
    • Service Catalog API /ServiceCatalog/api/catalogManagement/v2
    • Service Qualification API /DSServiceQualification/api/serviceQualification/v1
    • Service Quality Management API /tmf-api/serviceQualityManagement
    • Service Test Management API /tmf-api/serviceTestManagement
    • Shopping Cart API /tmf-api/shoppingCartManagement
    • Trouble Ticket API /DSTroubleTicket/api/troubleTicketManagement/v2
    • Usage Management API /DSUsageManagement/api/usageManagement/v2
    • User Roles and Permissions API /usersandroles/v1

     

    The below APIs would fail the camel case nomenclature, either it contains DS prefix, or is missing a base url property, or is using the root api namespace or it is using tmf-api as a prefix, finally other inconsistency is versioning of the APIs, some are versioned in the url (v1, v2) while others are missing.

    • Activation and Configuration API /DSEntityProvisioning/api/ActivationAndConfiguration/v2
    • Address API /
    • Alarm Management API /DSPerformancealarm/api/alarm/v1
    • Appointment API /
    • Billing Management API /DSBillingManagement/api/billingManagement/v2
    • Loyalty Management API /loyaltyManagement
    • NFV Entity Provisioning API /DSEntityProvisioning/api/EntityProvisioning/v2
    • Party Management API /DSPartyManagement/api/partyManagement/v2
    • Party Role Management API /tmf-api/partyRoleManagement
    • Payment Methods API /paymentMethods/v0
    • Performance Management Threshold API undefined
    • Prepay Balance Management API /tmf-api/PrepayBalanceManagement
    • Privacy Management API /
    • Product Catalog Management API /DSProductCatalog/api/catalogManagement/v2
    • Product Inventory Management API /DSProductInventory/api/productInventory/v2
    • Product Ordering API /DSProductOrdering/api/productOrdering/v2
    • Resource Function Activation and Configuration API /DSResourceFunctionCA/api/ResourceFunctionCA/v1
    • Resource Inventory Management API /tmf-api/resourceInventoryManagement
    • SLA Management API /DSLAManagement/api/slaManagement/v2
    • Service Catalog API /ServiceCatalog/api/catalogManagement/v2
    • Service Qualification API /DSServiceQualification/api/serviceQualification/v1
    • Trouble Ticket API /DSTroubleTicket/api/troubleTicketManagement/v2
    • Usage Management API /DSUsageManagement/api/usageManagement/v2
    • User Roles and Permissions API /usersandroles/v1


    1. Hi Bill,
      Thanks for looking at this.
      The issues you raise are related to consistency of some of the element of the URI:
      1- API Name should use camelCase i.e the API Name being the token in the URI identifying the API i.e alarmManagement instead of AlarmManagement. Consequence is that we normalize the API Name and not only the resource name in our APIs (I agree with that).
      2- Versioning some of the APIs use a Version Number some of them dont however the presence of a version number is not mandatory for the first version of an API. So some of the Swagger show presence of v1 and some of them don’t. Note that if we have a minor version then the version 1.x must be present. For the sake of simplicity we could mandate the presence of a version number no matter what.
      3-We can’t normalize all the elements of the basePath since some of that information is endpoint configuration dependant. My endpoint is running under that host but it is configured under a domain xyzzy
      I suggest that you raise a CR on that topic or that you comunicate with the API Program leads stephen.harrop@vodafone.com and andreas.polz@bearingpoint.com
  3. Hi 

    Suggest to inlude TMF# in above table to majke it more readable.

  4. Hi,

    I am getting errors when I am trying to access Geographic Location Management API.

    Seems like access issue even though I am from TMF member company.

    1. The swagger hub link is broken, but you should be able to access the swagger file and then view it in a swagger viewer.

  5. Prateek,

    Please join the API Project at https://www.tmforum.org/collaboration/current-projects/ and wait for project membership confirmation before trying to access the Geographic Location Management API again.

    Regards,

    Alan

  6. Hi Alan,

    I am also not able to access Geographic Location Management API.

    However, whenever I click on "Join" on the API Project, I am being asked to login even though I am already logged in. Furthermore, when i login again nothing happens.

    Please suggest.

    Regards,

    Anant

  7. G’day, I can’t access the API table either. It asks me to login, which I already have done. There is also a lot of “macro” errors shown. I’m using Chrome. Cheers, /JF
  8. I cannot access "Geographic Address API" despite having already joined the API project. Looking at the link, I'm wondering if it's a problem with the naming structure of the link...  

    The link is to TMF647_Address_API_REST_Specification_R17.0.0.pdf where I would have expected the file name of the PDF to be TMF647_Geographic_Address_Management_API_REST_Specification_R17.5.pdf

  9. Hi Andrew,

    Apologies for the confusion. TMF673 Geographic Address API REST Specification R17.5.0 has recently been published for Member Evaluation and can be found here.

    Regards,

    Alan

  10. Hi,

     

    I am planning to use TMF638 Service Inventory Management API, but there is no Swagger yet. Is there a Swagger coming soon?

    Would it make sense to build a Swagger based on the model and samples defined in the PDF API Specs? Or it is better not to implement until a Swagger is ready?

     

    Thanks

    Sheriff

  11. Hi Sheriff,

    Good news. The R18.0 version of TMF638, including the Swagger, will be available via the Open API Table next Monday (February 26th).

    Regards,

    Alan

  12. Thanks Alan. That is great to know. Appreciate the quick attention to this.

  13. HI All,

    I have been looking at the inventory APIs and have 2 questions:

    1. With polymorphic APIs are we going to see a reduction in the number of inventory APIs as there seems be a high degree of duplication?
    2. I could not see anything about notification or event streaming in the API specs for Inventory. Is there any plan to support this?

     

    Tony

  14. Unfortunately we find the content and its directory positioning is really intricate to follow and more difficult to probe in . Its better to provide more details may be link with Gitlab etc to make it complete or if someone can provide more specific details specially for NFV Entity management part will be nice

  15. The NFV Entity Provisioning API has been superseded by the Resource Function Activation and Configuration API (TMF664). Details (including the Swagger file in GitHub) can be found by clicking on the relevant Icons.

  16. does anyone have a recommendation on which API to use for order notifications?

  17. Am proposing the need for a Data-as-a-Service API that can drive platform ecosystem business models, especially for CSPs seeking to become Digital Enablers. I think it will take on similar lines like the Location API, but this time provide a means to generalize the 'response' payload in order to fit different use cases. 

  18. I'm looking at the Geographic Address API release in 17.5 (TMF673). The conformance document (Pg. 14) references a geographic validation API for fetching a list of geographic address validation entities, though I cannot find any reference to it in the REST API document. Is it an issue with the conformance document or a missing API?

  19. Hi,

    We are in the mid of implementing TMF633 - Service catalog API, and we noticed that API specification was changed a little bit between R 16.5 and R 17.5, and Swagger API specification was not reflected to R 17.5. Do you have a plan to update Swagger one?


    Thanks,

    Charlie

  20. Hi,

    The Conformance Profile link of Product Inventory Management API seems like navigating to incorrect document. It navigates to "Open API Conformance" document. Where can I find Conformance doc for Product Inventory Management API?

    Thank you.

  21. Account Management API ... page 12. can an account move from active through suspention to suspended and then be closed, wihout the cancellation of the offers and dunning process?

  22. Hi,

    The Project L1 API is in the poster but not in the table above - is there a target date for this API?

    Thank you.

  23. Hi Peter,  quick suggestion on API table: could we add the PDF icon/link for API spec on the "API Spec" column beside the HTML icon?  Those links go together really,  and you can then remove the "Download PDF specification" column. cheers, Kevin

  24. Hello Team,

    We need to develop an API which will reserve the stock in inventory, please share any specification regarding the stock management which can provide details regarding the implementation of Stock availability and stock reservation in inventory.

    1. Suggest you take a look at the Resource-related APIs. In particular the not-yet published Resource Pool API (this is a link to the team review assets), and you might want to reach out to Takayuki Nakamura the team leader for that API.

  25. Hi Team,

    TMF656 Swagger file is not listed. Can someone please upload?

    Pierre Gauthier can you please help?

    1. Pierre Gauthier We need inputs here. appreciate if someone picks and responds.

  26. In TMF653 - Service Test Management, as per Service Test resource model and API Spec document, the related service is identified by "relatedServiceRef" , however swagger is wrongly created with "relatedService".

    Missing "Ref" in swagger file. Can someone corrcet and upload swagger file for allignment please?

  27. HI Team,

    We have implemented the Service Test Management API and put into production. During the development we identified a number of recommendations/enhancements that can be possibly considered for the API. What is the best way forward to discuss and possibly include these enhancements in the API spec?

    1. Hi Brian Cohen

      I am interested in understanding the proposed enhancement for TMF653 - Service Test Management API. Can you please share if possible,

  28. The best approach would be to document the issues in one or more JIRA entries, at https://projects.tmforum.org/jira/.

  29. Hi!

    It's unclear to me which API I should use in the following case.

    We need to expose an API that will receive some SNMP command to push/get to/from a specific device.

    The API need to expose a GET on multiple SNMP oids; expose an SNMP walk to specific root oid; expose a SNMP SET for specific oid.

    I hesitate between "Resource Inventory" and "Activation and Configuration". It's unclear to me where the request should be handle and how the answer should be return.

    Should it include in the "resourceCharacteristic"?

    ex.: 

    "resourceCharacteristic": [{

    name:oidList

    value:{

    oid1 = oid1,

    oid2 = oid2,

    oid3 = oid3

    }

    }]

    or

    "resourceCharacteristic": [{

    name:oid1

    value:{

    oid1 = oid1

    type = string (or something else)

    }

    }]

    where oid1 could be = 1.4.6.1.1.n..... and so on.

    What do you guys think?

     

    Tx

     

     

  30. How to get open API for 'Customer Order Management' and 'Resource Order Management'.

  31. Which API is used for user authentication?

    1. There is an API planned for release 18.0 (mid-year), 691 Federated Identity. The team leader for this API is Luis Velarde, you might want to contact Luis to find out the content and scope of the API and to see if it meets your needs.

  32. We are exposing TMF Open apis as the Northbound resource from our API gateway. In case of any error from backend or gateway, should we return error code defined in TMF Open api swagger or in API gateway?

    Please note that API gateway has added security definitions in TMF Open api and shared with consumer.

  33. I need to use Prepay Balance Managemtent in order to inquiry all details reflecting in main balance of subscriber (whether debit or credit).

    Displayed Fields:

    • Date of change
    • Amount +/-
    • Adjustment Description
    • Amount Before
    • Amount After

    Search Criteria:

    • From Date
    • To Date
    • SubscriberId”MSISDN”

     

    problem that prepay has only 4 implemented operations inswagger and required resrouce "BALANCEADJUSTMENTREQUEST RESOURCE" not implemented

    1. I suggest you reach out to Luis Velarde, the leader of this API, to discuss your question.

  34. TMF 629 Customer Management API has TMF 659 Conformance Profile.
    TMF659B_Customer_Management_API_Conformance_Profile_R17.0

    1. Andrei,

      Thank you for your feedback.

      When the Customer Management Conformance Profile was first published, it was assigned a different document number from the Customer Management API Specification:

      TMF629 Customer Management API REST Specification R17.0.1

      TMF659 Customer Management API Conformance Profile R16.5.1

      So the current API table does link to the correct documents.

      The revised process now assigns the same document number with a ‘B’ suffix for the Conformance Profile, so this anomaly will be resolved in the R18.0 refresh of the API Table:

      TMF629 Customer Management API REST Specification R18.0.0

      TMF629B Customer Management API Conformance Profile R18.0.0

  35. The Open API Table has been updated with the latest published information.

  36. Hi,
    I couldn't find the link to the Topology API. I remember sometime there was Topology REST API .. Can anyone help to point me to the link.
    Thanks

    1. To my best understanding, there has never been a release of this API. It has a line in the internal API project master list and is assigned number 686, but I don't recall any review and approval process. If you have access to the internal project confluence you can find the most recent work at TMF686 Topology (R17.0 Never Released) (dating from early 2017).

  37. Hi, can anyone tell me what is the intended use of the chanel entity of the resource mode in the 18.0.0 release of the Trouble Ticket API ???

    1. Hi Marcel, my understanding is it is the channel where the service or product is sold. Examples are web site, physical store or customer service. So the tickets can be filtered or routed according to channel.

    2. Hi Marcel,

      Take a look at the Json representation sample, "Self Service" channel. It is critical in an automated tickiting process to know from which channels(IVR, Portal, USSD or service desk) a ticket was loged, for authentication purpose and status report if neccessary.

      ID is provided which will be different for each channel in an organisation where there are many selfservice channels or service desk.

      Remember we are dealing with a trouble ticket(Assurance), so it is not necessarily where the product is sold rather it is where the product is assured.

      Json representation sample:  

      "channel": {

      "id": "8774",

      "name": "Self Service",

      "@type": "Channel"},

      ref: Trouble tocket API REST Specification, TMF621, Release 18.0.0, June 2018

  38. Hi!

    Most of Postman collection are not available now by the reason of update to new version. We can we expect to get them? Is it possible to get access to previous version?

    Yury

    1. Per my recent email, previous versions are now listed as a sub-page to the Open API Table.

      1. Thanks, Alan!

        When do you plan to finish update for the last version?

  39. Hello,

    We are looking for a TMForum specification for Carrier Maintenance feature. Carrier MAintenance should have endpoints for maintenance creation, updation and view etc.

    Do let me know if there is any standard format being formulated for such task.

     

    1. Carrier is a specialisation of Resource. 

      Use whatever you can from the resource domain, and only in neccessary, limit it to only one type of resource.  I suspect even within such a narrow field as carrier maintenance, there will still be a wide veriety of resource types to include.

      1. There was a Service Test Management API . Can this API be used for implementing such features.

  40. Hello,

    TMF 641 spec Release 18.0.1 defines 'value' field for ServiceCharacteristic as "An object. A link to a value description structure." (see page 16).

    In previous version of specification (Release 16.5.1) value was a string.

    Does it mean TMF 641 of Release 18.0.1 is not backward compatible?

     

  41. Dear Alan,

    Could you please explain why the models of Product entity are so different in SID and OpenAPI?

    Yury

    1. Yury, hi. We are in the process of mapping each API against SID, please look at the resources page to see the mappings that have been published - https://www.tmforum.org/?s=api+sid+mapping&post_type=product

       

    2. Hi Yury,

      In addition, you can find general principals used for mappings that highlights the logical differences between the Information model (SID) and the Resource model used in the APIs HERE (in the mapping rules and guideline document).

      If you are interested in the mapping between SID and APIs, you are welcome to participate in the "SID / Open API mapping" weekly meeting on Thursday.

      See you,

      Cécile

  42. Hi Cecile

    Is there a data model of the Resource model used? 

    It would be a major enabler of integration solution architecture if there was one available to members.

    1. There is a data model for the resources, the API team use this model internally to create API designs and generate Swagger files, but currently it is not published. If you are member of the API project, you will be able to download a copy (it is an Enterprise Architect UML model file - .eap) from the internal project page at https://projects.tmforum.org/wiki/display/AP/API+Data+Model.

      1. Thanks, much appreciated.

  43. I get a 'Page Not Found' error when following that link

     

    1. Hi Cliff,

      Please log in and join the Core Project Area using your current email address.

  44. Could you please recommend the right way to query specific customer having only his (or one of his) MSISDNs?

    Should we use for this the sequence of calls?

    1) query Resource with given MSISDN, and get reference of product in product inventory

    2) query Product from product inventory and get reference to customer

    3) query Customer with given ID

    Looks like it is very long way. What is the best way of implementation to make it more easy for consuming applications?

    1. Hi Yury,

      An axisting cutomer with with an MSISDN will be related to an existing product.

      So maybe five table table:

      MSISDN table

      Customer table

      Product table

       one to many(Customer can have many MSISDN, an MSISDN belong to one Customer ), e.g CustomerMSISDN relationship table

      many to many (Customer can have many Products) e.g CustomerProduct relationship table

      query Customer table to get customer details where MSISDN in CustomerMSISDN table is equal to the provided MSISD. **Highlevel query**

      Same as for product details

       

       

      1. Thanks, Oscar!

        I already found that Federated Identity API (TMF691) is the proper API for this task.

        GET https://{serverRoot}/openid/v1/userinfo?fields=userAssets

        Authorization: Bearer <token associated to user u123>

        The required data will be returned in the "userAsset" entity.

  45. Hi ,

    I have the question about TMforum API version and version in path variable. I can see in swagger documentation version is mentioned v2 and path is like : "Billing Management API /DSBillingManagement/api/billingManagement/v2" But in matrix version is 17.5.0. 

    Question:

    1) Which version we need to follow while creating TMforum API? v2 or v17.5.0

    2) What will be path in the case 17.5.0 version needed

    /DSBillingManagement/api/billingManagement/v17 or /DSBillingManagement/api/billingManagement/v17_5

     

    1. Hi Surabhi

      The TMF deliverables (not just Open API but also SID and other Frameworx stuff) have a twice-yearly release cycle, with releases being denoted as xx.0 and xx.5, where xx.0 is the mid-year release for year 20xx and xx.5 is the end-year release. So each assets that is updated in (for example) release 17.5.0 will be marked as dating from that release, even in subsequent releases, until the asset is next updated.

      But this numbering scheme has no relation to the executable parts of the API (swagger file etc.). Each API starts at v1.0, and the API designer is responsible for incrementing the version number according to the versioning rules defined in the API design guidelines. It is this version that will appear in the endpoint path, so v2 in your example.

  46. Dear TMForum,

    Could you please advice which API could be used for customer feedback and TNPS?

  47. Hi to all people posting general queries on Open API usage.

    Can I suggest that you consider using the community forum for posting queries, at https://engage.tmforum.org/communities/community-home?CommunityKey=d543b8ba-9d3a-4121-85ce-5b68e6c31ce5

    I think that the forum framework is more suited than this Confluence page for such queries, for example each conversation can be given a title.

  48. Hi.

    Wondering why the TMF 636 Billing Management API is no longer present in the Open API table.  It is only available in Billing Management API REST Specification (TMF636) R14.5.1

    TMF 678 ()TMF678 Customer Bill Management API REST Specification R17.5.0 is available, but they are not the same.

    thanks

    1. Hi Serge

      The 636 specification was retired and divided into two specifications:

      • TMF 678 for bill management 

        This API allows operations to find and retrieve one or several customer bills (also called invoices) produced for a customer also allows operations to find and retrieve the details of applied customer billing rates presented on a customer bill.
      • TMF 666 for account management

        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

       

      Hope this helps.

      1. Thank you Jonathan.

        I was starting to suspect that it might have been the case. What was I looking for in the TMF636 is the /appliedCustomerBillingCharge sub resource which covered further had links to serviceIds, productSpecification, period.

        The TMF678 seems to introduce the concept of appliedCustomerBillingRate (or align closer to SID objects...) which can have charges & fees includign credits/promos, etc but it seems to delegate all but the AppliedBillingTaxRate to the Characteristic VS having explit refenrce to serivce and productSpec.

        Most of our billing events fit squarely into the previous version: they consist of serviceId, ProductSpec, Time period.  Was the intent to move these 3 object into the AppliedBillingRateCharacteristic?


        "id""25"
        "href""http://serverlocation:port/BillingManagement/appliedCustomerBillingCharge/25"
        "date""2013-04-19T16:42:23.0Z"
        "description""Partner Premium monthly fee"
        "type""Recurring"
        "currencyCode""USD"
        "taxIncludedAmount"2.4
        "taxExcludedAmount"2
        "appliedCustomerBillingTaxRate": [ 

        "amount"0.4
        "taxCategory""VAT" 

        ], 
        "serviceId": [ 

        "id""0601020304"
        "type""Mobile number" 

        ], 
        "productSpecification": [ 

        "name""Partner Premium"
        "productNumber""P001" 

        ], 
        "period": [ 

        "startPeriod""2013-10-01T00:00:00.0Z"
        "endPeriod""2013-10-31T00:00:00.0Z" 


        }

         

         

  49. Hi guys, any idea on how to pass the catalog if i want an offering from a particular catalog (TMF620 Product Catalog Management); the api seems not to allow that as part of the request paramaters ?

  50. Hi,

    Which is the API which has provision for (mobile) number portability?

    1. Hi Amol

      As per my comment above, please use the community forum for posting queries, at https://engage.tmforum.org/communities/community-home?CommunityKey=d543b8ba-9d3a-4121-85ce-5b68e6c31ce5

      Specifically for your question, number portability (in and out) is a complex business process and not handled by a single API. Candidate APIs that might be involved in the process would include Resource Inventory Management, Product Order Management, and more. My recommendation to approach this would be draw out the port-in and port-out processes for your business, end-to-end, as sequence diagrams, and thus identify the business operations that would be needed. These could then be mapped into APIs from the Open API suite.

  51. Hi 

    Which is the API for  get and reserve the stock in inventory, is there anything available regarding the stock management which can provide details regarding the implementation of Stock availability and stock reservation in inventory.

    1. Hi Thuso

      As per my comment above, please use the community forum for posting queries, at https://engage.tmforum.org/communities/community-home?CommunityKey=d543b8ba-9d3a-4121-85ce-5b68e6c31ce5

      Specifically for your question, the API team is considering possible creation of a new API for stock management for tangible goods, based on work done by Vodafone - please reach out to Stephen Harrop for more details.