... | ... | @@ -17,11 +17,8 @@ Vtiger Application Definition Language (VADL) is based on XML syntax to enable a |
|
|
</api>
|
|
|
```
|
|
|
|
|
|
|
|
|
VADL allows you to
|
|
|
|
|
|
|
|
|
|
|
|
* Define APIs
|
|
|
* CURD (Create, Retrieve, Update, Delete) on entity modules.
|
|
|
* Invoke HTTP based (REST / SOAP) endpoint through (GET/POST/PUT/DELETE) methods
|
... | ... | @@ -30,6 +27,22 @@ VADL allows you to |
|
|
* Bind API inputs to VTAP runtime configuration store.
|
|
|
|
|
|
|
|
|
VADL API definitions
|
|
|
|
|
|
| Name | Description | Example |
|
|
|
| -------- | -------- | --------- |
|
|
|
| api | entire api definition is encapsulated inside api node, method attribute set the type(get,post,put,delete) of http request. | ``<api method='post'></api>`` |
|
|
|
| select | this will let you select the vtiger record data, you can select which fields to be fetched, filter records and sort them | ``<api method='get'><select module='Contacts'></select></api>`` |
|
|
|
| create | this will let you create vtiger record | ``<api method='post'><create module='Contacts'></create></api>`` |
|
|
|
| update | this will let you update vtiger record | ``<api method='put'><update module='Contacts'></update></api>`` |
|
|
|
| delete | this will help you delete vtiger record | ``<api method='delete'><delete module='Contacts'></delete></api>`` |
|
|
|
| rest | this will help you connect with other application | ``<api method='delete'><rest method="get"><url>https://slack.com/api/conversations.list</url></rest></api>`` |
|
|
|
| soap | connect with legacy soap api's | ``<api method='delete'><soap method="get"><auth><basic username="" password=""></basic></auth><url></url></soap></api>`` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### API Endpoint
|
|
|
|
|
|
API defined through API Designer can be access through the [restapi](https://help.vtiger.com/article/147111249-Rest-API-Manual) endpoint as follows:
|
... | ... | |