Open APIs

Expand all | Collapse all

TMF639 - Filtering, Limiting and paginating responses

  • 1.  TMF639 - Filtering, Limiting and paginating responses

    TM Forum Member
    Posted Jul 02, 2021 09:30
    Hi,

    I've been unable to find anything in the documentation or examples for this - if this is already covered, a link would be helpful.

    I'm trying to retrieve entities via:

    ../v100/resource/?@type=device

    Unfortunately, the number of returned items is large, so I just get{"code":403,"message":"Too many objects found."}  Question 1: Where is this limit configured?

     
    I was hoping to filter by name with wildcard, i.e

    ../v100/resource/?@type=device&name=devicename*  Question 2: Are wildcard/regex searches allowed?

    This returns no results, only exact name matches seem to work

    From other threads, I tried limits and pagination of results, i.e.

    ../v100/resource/?@type=device&limit=2&offset=2  Question 3: Is this possible under tmf639?

    These attributes are not found, so I'm guessing that this is not possible, or the names are different.

    Thanks in advance,

    Andrew






    ------------------------------
    Andrew Dodds
    Amdocs Management Limited
    ------------------------------


  • 2.  RE: TMF639 - Filtering, Limiting and paginating responses

    TM Forum Member
    Posted Jul 05, 2021 05:33
    I clarified with Andrew that his queries are more related to a specific implementation of the API.
    Having said that, general search patterns for all APIs are described in the Open API design guidelines TMF630, this is recommended reading for API implementers and users.
    Published here: https://projects.tmforum.org/wiki/display/PUB/TMF630+REST+API+Design+Guidelines+v4.2.0

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