Create a project in the Jexia Dashboard
After you have created your account, log in to the Jexia Dashboard to create your project. Within a project, you can create datasets, add fields, set up field validation and make relations between your datasets. After login, you can create a project by clicking the "Create Project" button.
After the project is created you will see your project id and the project URL which you can use to interact with your data.
In order to interact and perform CRUD operations on your data, you need to store the data in a dataset. In order to do so, you need to create the dataset first. Click the button "Go to datasets" and on the next screen "Create dataset":
Name your dataset. The name of the dataset is used as an endpoint to allow you to communicate with the API. The name of your dataset can contain only Latin characters and digits. The name of the dataset has to start with a character.
Add fields to your datasets or store your data schemaless
The next step is to add fields to your datasets. In order to create a field, click the "Add field" button. In the same window, you can select name, type, and validation for your field. Field name validation parameters can be changed in the future via the edit field but not the field type. If you want to change the type then you can only delete and create the field again. However, by deleting the field you will also lose the data stored in the field. With the Schema approach in responding, you will get the field in specific type: String, Integer, Float, Date, DateTime, Boolean, JSON or UUID. Data will be validated against the validators added to fields while inserting and updating records.
To apply the schemaless approach just insert your JSON object into JEXIA without creating any fields inside Dataset. Data will be stored automatically with the proper type. Please, note that validations will not applicable to schemaless data. You can convert from Schemaless to Schema when data design for your project is stabilized. Jexia supports String, Integer, Float, Date, DateTime, Boolean, JSON and UUID as field types.
Depends on field-type validation parameters will be available for you. The most validators are available for String type. Such as: Required, UpperCase, LowerCase, Alphanumeric, Numeric, Alpha, Min/ Max length, RegEx.
For Float and Integer, there are: Required, Min/ Max value.
In the future, we plan to add Date range and other validators.
You might admit that when you select some validators, another one might be unavailable. It is due to logical exclusion. For example, it is not logical to have Upper and Lower case validators at the same time. To reduce the possibility for human mistaces we decided to prevent selection for some combinations.
Click the three dots to edit the name of the dataset, copy the API URL or delete the dataset.
There is an opportunity to work with Jexia via REST API. You can find some example of how to use it below, as well as go deeper and check specific part of our documentation