Properties
Each entity consists of properties that define its structure. Properties are essentially the attributes or fields of an entity, similar to columns in a database table.
Last updated
Each entity consists of properties that define its structure. Properties are essentially the attributes or fields of an entity, similar to columns in a database table.
Last updated
How to create Property
In API Builder, properties define the characteristics or attributes of your entities, akin to fields in a database table. To enhance an entity with additional attributes, follow these steps to add a property:
Select the Entity: Navigate to the main dashboard where your entities are listed. Identify and click on the entity to which you wish to add a property. This action takes you to the entity's detail page.
Access the Properties Tab: On the entity's detail page, locate the "Properties" tab on the left-hand side of the interface. This tab houses all the information related to the properties of your selected entity.
Add a New Property: Within the "Properties" tab, find and click on the "Add a Property" button. This action will open a form or dialog box prompting you to enter details for the new property.
When adding a new property, you will be asked to provide several pieces of information, including:
Name: The name of the property, which should be unique within the entity and adhere to any naming conventions your project follows.
Data Type: The type of data this property will hold (e.g., String, Number, Boolean, Date). Choose the data type that best represents the nature of the data to be stored in this property.
Validation Rules : a) Set any validation rules that apply to this property, such as minimum or maximum values for numbers, or specific formats for strings. b)Properties are written in singular form, with lower case letters, instead of space use underscore. example : client_category
After filling in the necessary information, save the changes to add the property to your entity.
How to update Property
Select the Entity: Begin by navigating to your project's dashboard where all your entities are listed. Identify and select the entity containing the property you wish to update. This will direct you to the detail page of the selected entity.
Navigate to the Properties Tab: Once on the entity's detail page, look for the "Properties" tab located on the left side of the interface. This tab displays all properties associated with the selected entity.
Locate the Property to Update: Scroll through the list of properties until you find the one you want to update. Properties are typically listed by name, making it easier to locate the specific one you're interested in modifying.
Access Property Options: To the right of the property name, you'll see an options menu represented by three vertical dots (⋮). Click on these dots to open a dropdown menu with various options.
Choose 'Update' from the Dropdown: From the dropdown menu, select the "Update" option. This action will open a form or dialog box where you can edit the property's details.
In the update form, you can modify the following details of the property:
Name: Change the property's name if needed. Ensure the new name follows any project-specific naming conventions and is unique within the entity.
Data Type: Adjust the data type of the property to reflect the kind of data it should store (e.g., String, Integer, Boolean, Date). Choose the most appropriate data type based on the property's role within your entity.
After making the necessary changes, save your updates. The property will be immediately updated within your entity, and these changes will be reflected in your API's structure.
