- Print
Purpose
This Article summarizes how the Tulip API is structured and built.
What purposes does the Tulip API Unit test serve?
It enables testing some of the most frequently used Tulip API functions.
Functions included in the application:
- Sign URLs
- List Tulip Tables
- List records of a Tulip Table
- Create a Tulip Table record
- Count records of a Tulip Table
- Delete a record of a Tulip Table
- Update a record of a Tulip Table
- Delete all records of a Tulip Table
Table used in the unit test
To test the Tulip Table API functions the user needs a test table, namely the Tulip API sample table.
App structure
There is a menu on the left side of each step.
In the Introduction and the Configure connection steps, the user can read about the purpose of the application and also find instructions on how to configure the connection between the Tulip API connector and their instance.
In the Sign URL step, the user can enter a URL and sign it. When the URL is signed, the signed URL can be viewed on the right pane.
In the Get Tables step, the connector function runs at step enter, so all the tables in the instance are listed. The user can select a table from the interactive table on the left and view its details on the right.
In the List records step, the records of the Tulip API Sample table are listed. The user can select a record from the interactive table on the left and view its details on the right.
In the Create record step, the user can create a new record by filling in the input fields on the right. When the Create record button is clicked, the new record can be viewed in the interactive table on the left.
In the Count records step, the connector function is run on step enter, and the number of records can be seen on the right.
In the Delete record step. The user needs to select a record from the interactive table on the left. When the Delete record button is clicked, the record is deleted from the table.
In the Update record step, the user can update a record by filling in the input fields on the right. As soon as the Update record button is clicked, the updated record can be viewed in the interactive table on the left.
In the Delete all records step, when the Delete all records button is clicked, all records are deleted from the table.