Open APIs

Expand all | Collapse all

TMF667 Document Management API - refreshment?

  • 1.  TMF667 Document Management API - refreshment?

    TM Forum Member
    Posted Mar 08, 2021 12:47
    Hi,

    Do you think is it possible to refresh a bit TMF667 Document Management API?
    • paging with offset, limit, to solve potential timeout issues,
    • POST in place of GET for document searching with document attributes. With GET method all searched attribute values with potential personal data goes to the server logs and are transferred unencrypted which is definitely not GDPR friendly,
    • single characteristic.name, characteristic.value limit in GET /document,
    • maybe, possibility to POST /document message as a multipart/form-data to enable to include a document into a message.
    Maybe you have other points to improve. Maybe I'm wrong and above points are not an issues.
    Kind regards

    ------------------------------
    Marek Niewiadomski
    Polkomtel S.A. (PLUS)
    ------------------------------


  • 2.  RE: TMF667 Document Management API - refreshment?

    TM Forum Member
    Posted Mar 08, 2021 15:17
    Hi Marek
    Paging is part of all APIs, as described in the design guidelines TMF630.
    POST as against GET, would need discussion since it affects all APIs, not just Document
    Not sure I understand your third point about characteristics, can you give a concrete use case with specific example.
    Your fourth point needs further discussion within the Open API team.
    Thanks for bringing this to our attention.

    ------------------------------
    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: TMF667 Document Management API - refreshment?

    TM Forum Member
    Posted Mar 09, 2021 08:09
    Hi Jonathan,

    Thank you for quick answer.
    Regarding point 3: documents can be described by number of characteristic items. lets assume we have  documents type="Order" with characteristic e.g.
    "characteristic": [
      {"name": "ApprovalState", "value": "CANCELLED"}
     {"name": "Delivery", "value": "ABCourier"}
    ],

    Later, I want to find the documents by characteristics: ApprovalState and Delivery. As I understand the filtering criteria allow you to use only one of characteristic at a time. We have filtering fields in the query: characteristic.name and characteristic.value.

    There is another issue with the filtering I suppose. How to find documents which are CANCELLED or REFUSED. This one maybe can be managed by parsing the filtering value. I'm not sure if such usage is ok. Maybe API supports only concrete values.





    ------------------------------
    Marek Niewiadomski
    Polkomtel S.A. (PLUS)
    ------------------------------



  • 4.  RE: TMF667 Document Management API - refreshment?

    TM Forum Member
    Posted Mar 10, 2021 00:53
    Hi Marek
    I suggest you take a look at the design guidelines part 6, where we discuss JSON Path as an alternative to plain filtering. I suspect that this will answer your use case.
    Of course the actual implementation of the API needs to support this.
    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.
    ------------------------------