Enhance Query API reference guide with terminology explanations

As a low-code developer, I encountered challenges when navigating the API reference guide due to unfamiliar terminology. It would benefit users like myself to have clear explanations provided on how to access and utilize certain features directly on the reference page. For instance, understanding concepts like "node" and where to find the corresponding "node_id" would enhance our use of the API.

  • Hallie Guiseppe
  • Feb 23 2024
Query API
  • Attach files
  • Alex Wong commented
    02 Mar 22:31

    As reference documentation, I do think Query API needs more information, however, as to how to utilize the various API, I think it should more be guide that should be written about them.

    1. use GET Query type list to get a list of query type and the type id

    2. then use GET Available fields tree (Root) to get a list of "node" in the "root" of the provided query type id from step 1

    3. then use GET Available fields tree (Node) to get a list of "field" in the specific "node" of the provided query type id and node id from step 2

    4. then repeat 2 and 3 until you got all the field id for use in an ah-hoc query to build a query JSON

    ×

    Attachments Open full size

Related ideas