Creating New API

CRUD

CRUD is an acronym that comes from the world of computer programming and refers to the four functions that are considered necessary to implement a persistent storage application: create, read, update and delete.

Create

The create function allows users to create a new record in the database. In the SQL relational database application, the Create function is called INSERT.

Read

The read function is similar to a search function. It allows users to search and retrieve specific records in the table and read their values. Users may be able to find desired records using keywords, or by filtering the data based on customized criteria.

Update

The update function is used to modify existing records that exist in the database. To fully change a record, users may have to modify information in multiple fields.

Delete

The delete function allows users to remove records from a database that are no longer needed.A hard delete permanently removes records from the database, while a soft delete might simply update the status of a row to indicate that it has been deleted while leaving the data present and intact.

In BigLedger, when creating a data, the status is set to ACTIVE by default while the sttaus is DELETED when it is deleted.

The components of a CRUD API in BigLedger includes

  • Table

  • Container

  • Controller

  • Service

  • UOW

  • Data Consistency Objects

  • Query Criteria

Depending on the modules of the table, you need to create all the files in its related folder. Example, we have erp, cms, crm, del modules.