...
Request Config Group | Config Name | Description | ||
|---|---|---|---|---|
Request Parameters | Method | Different HTTP methods such as GET, POST, PATCH, etc. are used to perform specific operations on resources. You can explore more about methods here. | ||
URL | Add the relevant URL that corresponds to the connection from which you wish to perform CRUD. | |||
Record Count | Set the record count to either Multirecord or Single, depending on whether you are dealing with multiple records or a single record in the data operation. | |||
Query Params | It is way to pass information to an API in a flexible and simple manner. They are added to the end of the API endpoint URL as a series of key-value pairs. It can be used for filtering, sorting, pagination, formatting or searching the data. | |||
Headers | It is used to provide additional information about the request, such as the format of the request body, the client's preferred language, authentication credentials, and more. | |||
Request Body | Generate Schema | It can define fields using JSON format.
| ||
Create New Field | It can create fields using the create field Model.
|
Response
...
Response Config Group | Config Name | Description | ||
|---|---|---|---|---|
Response Parameters | Status Code | It indicates whether a specific HTTP request has been successfully completed. | ||
New Button | It allows to specify new Status Code as per one's business need. | |||
Record Count | Set the record count to either Multirecord or Single, depending on whether you are dealing with multiple records or a single record in the data operation. | |||
Response Body | Generate Schema | It can define fields using JSON format.
| ||
Create New Field | It can create fields using the create field Model.
|
Schema Designer
...
Generate Schema
...
Button | Description | ||
|---|---|---|---|
Cancel | It allows the user to exit the "Generate Schema" process. If any changes were made in the modal, they will be discarded, and no new schema will be generated. | ||
Recreate | It is used to reset the schema creation form within the modal. All fields will be cleared or set to their default values, enabling the user to begin the process of defining a new schema from scratch. | ||
Merge | It allows the user to merge the newly generated schema with an existing schema. This is useful when the user wants to integrate new schema elements into a pre-existing schema without completely overwriting it.
|
Create New Field
In cases where a user does not have data in XML format but has it in JSON format, the application allows the user to create a schema by adding new fields directly.
This feature is particularly useful for users who need to generate or modify schemas based on their JSON data structure.
...
Field Config | Description | ||
|---|---|---|---|
Name | The identifier for the field within the schema. This is the name that will be used to reference the field in the data structure. | ||
Type | It specifies the data type of the field.
| ||
Required | It indicates whether the field is mandatory. | ||
Minimum Length | It defines the minimum number of characters or elements that the field must contain. | ||
Maximum Length | It defines the maximum number of characters or elements that the field must contain. | ||
Pattern | It is a regular expression that the field’s value must match. This is typically used for validating formats like email addresses, phone numbers, etc. | ||
Help Text | It provides additional information or guidance on what the field represents and how it should be used. This is often displayed in the UI to assist users. | ||
Default Value | It is a predefined value that the field will take if no other value is provided. This helps in setting initial values. |
...