Open APIs

Expand all | Collapse all

TMF640 4.0.1 User Guide does not tell which field is mandatory

  • 1.  TMF640 4.0.1 User Guide does not tell which field is mandatory

    TM Forum Member
    Posted 28 days ago
    Hi all,
    I'm building a data model based on TMF 640 version 4.0.1.

    Batching API service --- TMF640 ---> Single API service

    We have 1 POST API to provide 1 telco's Value Added Service, the batching API service receives this batch request which contains a list of the mobile numbers ask for the value added service. The batching service will break down the request into many single request in TMF 640 data model and send to Single API service. We need to consolidate all the single response using the batch size and correlation ID and the TMF 640 request send from Batching API service to Single API service need to have that 2 fields. So, I have several questions:
    1. Can I put 2 fields batch size and correlation ID in RelatedServiceOrderItem or RelatedEntityRefOrValue.
    2. The only document I have for version 4.0.1 is this https://www.tmforum.org/resources/specification/tmf640-service-activation-and-configuration-api-user-guide-v4-0/. But this document does not have the detail about which field is mandatory. Where can I find that?


    ------------------------------
    Esca Tran

    ------------------------------


  • 2.  RE: TMF640 4.0.1 User Guide does not tell which field is mandatory

    TM Forum Member
    Posted 27 days ago
    Hi Esca
    Regarding 1 - you can extend the Open API model using the @ fields, as described in the TMF630 design guidelines.
    Regarding 2 - each API user guide should state which fields are mandatory in the context of operations (POST and PATCH). Which fields do you think should be mandatory that are not documented in the user guide?​
    Hope it helps

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 3.  RE: TMF640 4.0.1 User Guide does not tell which field is mandatory

    TM Forum Member
    Posted 27 days ago
    Hi Jonathan,
    Thank for your response.
    Regarding to 1 - do you think I should put the batchSize and the correlation ID into RelatedServiceOrderItem  or RelatedEntityRefOrValue or subclass of them? Or other entities?
    Regarding to the question 2, I don't see any document list out the mandatory fields of RelatedServiceOrderItem or RelatedEntityRefOrValue or any model.

    ------------------------------
    Esca Tran
    SingTel Optus
    ------------------------------



  • 4.  RE: TMF640 4.0.1 User Guide does not tell which field is mandatory

    TM Forum Member
    Posted 27 days ago
    Q1 Probably into relatedServiceOrderitem, since that's stronger semantically, unless you need to correlate across multiple entities of different types.
    Q2 Regarding mandatory, take a look at the conformance profile, that sometimes has more information, especially for sub-entities, than the user guide.

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 5.  RE: TMF640 4.0.1 User Guide does not tell which field is mandatory

    TM Forum Member
    Posted 26 days ago
    Thank you, Jonathan.
    That helps a lot.

    ------------------------------
    Esca Tran
    SingTel Optus
    ------------------------------