Skip to content

ndi.cloud.api.documents.ndiqueryAll

 NDIQUERYALL User-facing wrapper to execute an NDI query repeatedly to obtain all matches.

    [B, ANSWER, APIRESPONSE, APIURL] = ndi.cloud.api.documents.ndiqueryAll(SCOPE, QUERY_OBJ, 'pageSize', PS)

    Executes an NDI query repeatedly, paginating through results to return all matching documents.

    Inputs:
        scope       - The scope of the search ('public', 'private', 'all').
        query_obj   - An ndi.query or did.query object defining the search criteria.
    Name-Value Inputs:
        pageSize    - (Optional) The number of results per page. Default is 1000.

    Outputs:
        b            - True if the call succeeded, false otherwise.
        answer       - A struct array of all matching document summaries on success.
        apiResponse  - An array of matlab.net.http.ResponseMessage objects from all page calls.
        apiURL       - An array of URLs that were called.

    Example:
        q = ndi.query('base.name', 'contains_string', 'Data');
        [success, all_docs] = ndi.cloud.api.documents.ndiqueryAll('private', q);

    See also: ndi.cloud.api.documents.ndiquery, ndi.query