Open APIs

 View Only

  • 1.  Is depth=0 different from not providing depth parameter at all?

    Posted Jul 18, 2025 05:35

    Hi,

    TMF630 part 2 states that: "If depth=0, then all referenced entities just RootEntity objects which contains only ID and @type (may contain name and href)". 

    I do not understand this. Here are my questions:

    • what is "RootEntity"?
    • why only id and @type are required? Sholdn't "href" also be required? 
    • is the behavior any different from not providing depth param at all?

    Thank you for any help! 



    ------------------------------
    Piotr Ledwoń
    Suntech S.A.
    ------------------------------


  • 2.  RE: Is depth=0 different from not providing depth parameter at all?

    Posted Jul 30, 2025 11:12
    Edited by Matthieu Hattab Jul 31, 2025 07:29

    hi,

    honestly, 630 also confused me with the depth. For instance, "If depth=0, then all referenced entities just RootEntity objects which contains only ID and @type (may contain name and href" is probably missing a verb between "entities" and "just".

    The example on page 32, shows depth is set at level 3 in the request, and yet, the response doesn't show the full objects for category, channel, place... which are present at level 1. but only their IDs (and @type and ref).

    If depth was 3, place should show full details, not just id.

    It would have helped if the document had 3 examples, no depth vs level 0 vs level 3.



    ------------------------------
    Kind regards,

    Matthieu Hattab
    Digital Sales Domain Architect
    Lyse Tele AS
    ------------------------------



Related Content