Datatabledata Tutorial

This tutorial will help you to learn how to interact with the Buzzy API endpoint for Datatable - the endpoint is called "microappdata"

For the canonical explanation of row metadata and embeddingRowID, see Row Metadata and Relationships.

Please note: Datatable were Previously called "Microapps", the name of the endpoint is thus microappdata.

Prerequisites

To work with this tutorial you will need a version of postman. In addition a user with password that has access to a Buzzy server is required.

Steps

1. Begin by creating a new request in postman. Set the request to POST and the url to yourserver/api/login. Set the body:

   {
    "email":"[e-mail]",
    "password":"my-password"
   }

   Click Send. The result should be a user id and token.

tutorial-microappdata-postman1

1. Now lets create a request to get the records from a Datatable. Create a new request in postman. Set the request to post and the url to yourserver/api/microappdata. Set two header key value pairs: X-User-Id and X-Auth-Token to the values returned in step 1.

Add the Datatable id to the body:

{
	"microAppID":"<insert Datatable id here>"
} 

The DatatableId can be found by opening the Datatable in a browser and viewing the properties.

tutorial-microappdata-postman3

Click Send, the result should be records from the Datatable best viewed as JSON.

tutorial-microappdata-postman4

Note that embedded Datatables are queried using this same endpoint. The body of the request contains the association:

{
    "microAppID": "<insert Datatable id here>",
    "searchFilter": [
        {
            "resourceID": "<insert Datatable id here>",
            "embeddingRowID": "<insert parent row id here>"
        }
    ]
}

The embeddingRowID stores the parent row ID for the child row relationship. Use it whenever you need to query the child rows that belong to one parent row.

---