Endpoint Pattern

Request & Response Http pattern.

This framework is designed as a UI generator for CRUD operations via Rest API. You need to have a data source from the API for all CRUD processes to function properly. The default endpoint pattern required in your backend application is as follows below.

Overview example endpoint pattern

1. Get Data List http://localhost:7010/demoMahasiswa (GET)

2. Post Data http://localhost:7010/demoMahasiswa (POST)

3. Post Multiple Data http://localhost:7010/demoMahasiswa (POST)

4. Get Data By Id http://localhost:7010/demoMahasiswa/2 (GET)

5. Update Data http://localhost:7010/demoMahasiswa/2 (PUT)

6. Delete Data http://localhost:7010/demoMahasiswa/2 (DELETE)

7. Delete Multiple Data http://localhost:7010/demoMahasiswa (DELETE)

---

1. Get Data List

   • Endpoint example: http://localhost:7010/demoMahasiswa

   • Method: GET

   • Success Response Code: 200

   • Payload Content type: query string (will be added if there is a dynamicColumnsFilter property)

   • Description: This HTTP request will automatically run when the page is opened. If the response is successful, the data will be displayed on the table/grid_card/calendar according to the pageType property.

2. Post Data

   • Endpoint example: http://localhost:7010/demoMahasiswa

   • Method: POST

   • Success Response Code: 200

   • Success Response must have "id" key or custom id key for auto append row in UI.

   • Payload Content Type: JSON (consisting of objects according to the number of inputs filled with values)

   • Description: This HTTP request will be executed when the "submit" button is clicked on the Add page.

3. Post Multiple Data

   • Endpoint example: http://localhost:7010/demoMahasiswa

   • Method: POST

   • Success Response Code: 200

   • Success Response is Array and must have "id" key or custom id key for auto append rows in UI.

   • Payload Content Type: JSON (an array of objects according to the number of inputs filled with values)

   • Description: This HTTP request will be executed when the "submit" button is clicked on the Add page for multiple entries.

4. Get Data By Id

   • Endpoint example: http://localhost:7010/demoMahasiswa/2

   • Method: GET

   • Success Response Code: 200

   • Payload Content Type: path & query string (static)

   • Description: This HTTP request will automatically run when you click the "edit" / "view" button on the table/grid_card/calendar according to the pageType property. This request won't run automatically if the detailFromgrid property is set to false.

5. Update Data

   • Endpoint example: http://localhost:7010/demoMahasiswa/2

   • Method: PUT

   • Success Response Code: 200

   • Payload Content Type: path & JSON (according to the number of inputs edited and filled with values)

   • Description: This HTTP request will be executed when the "submit" button is clicked on the Edit page.

6. Delete Data

   • Endpoint example: http://localhost:7010/demoMahasiswa/2

   • Method: DELETE

   • Success Response Code: 200

   • Payload Content Type: path

   • Description: This HTTP request will be executed when the "delete" button is clicked on the table/grid_card/calendar according to the pageType property.

7. Delete Multiple Data

   • Endpoint example: http://localhost:7010/demoMahasiswa

   • Method: DELETE

   • Success Response Code: 200

   • Payload Content Type: JSON (an array of integers, e.g., [1, 2, 3, 4])

   • Description: This HTTP request will be executed when the "delete selection" button is clicked on the table/grid_card/calendar header according to the pageType property.

If your data source API endpoints differ from the above pattern, you can customize the endpoints for each method. Detail on page Custom Endpoint.