| **Name** | **Description** | **Parameters** | **Response** |
| **create** | Create a record of the specified module | elementType (String)element (Encoded) | Return all fields and values of the created record |
| Ex: **Url**: VTE\_URL/restapi/v1/vtews/create
**Parameters**:
{"elementType":"Accounts", "element":"{\\"accountname\\":\\"account1\\", \\"assigned\_user\_id\\":\\"19x1\\"}"}
|
| **update** | Update the specified record | id (String)columns (Encoded) | Return all fields and values of the updated record |
| Ex: **Url**: VTE\_URL/restapi/v1/vtews/update
**Parameters**:
{"id":"3x310", "columns":"{\\"accountname\\":\\"test fede postman\\"}"}
|
| **revise** | Update the specified record. It’s different only for parameters, the result is the same | element (Encoded) | Return all fields and updated values |
| Ex: **Url**: VTE\_URL/restapi/v1/vtews/revise
**Parameters**:
{"element":"{\\"id\\":\\"3x27\\",\\"employees\\":\\"5\\",\\"industry\\":\\"Banking\\"}"}
|
| **retrieve** | Illustrate the fields of the specified record and their relative values | id (String) | Return all fields and values of the specified record |
| Ex: **Url**: VTE\_URL/restapi/v1/vtews/retrieve
**Parameters**:
{"id":"3x310"}
|
| **retrieveinventory** | Illustrate the fields of the specified inventory record, their relative values and the product block’s information | id (String) | Return all fields and values of the specified record and product’s block information |
| Ex:
**Url**: VTE\_URL/restapi/v1/vtews/retrieveinventory
**Parameters**:
{"id":"16x104"}
|
| **delete** | Delete the specified record | id (String) | Return the request status (successful or not) |
| Ex: **Url**: VTE\_URL/restapi/v1/vtews/delete
**Parameters**:
{"id":"3x306"}
|
| **query** | Execute a query and return the result’s rows | query (String) | Return all rows of the executed query |
| Ex: **Url**: VTE\_URL/restapi/v1/vtews/query
**Parameters**:
{"query":"SELECT \* FROM Accounts WHERE accountname like '%vte%';"}
|
| **listtypes** | Describe each one module which contains uitype of the specified format | fieldTypeList (Encoded) | Return module information of the specified fieldtypes |
| Ex: **Url**: VTE\_URL/restapi/v1/vtews/listtypes
**Parameters**:
{"fieldTypeList":"\[\\"integer\\",\\"file\\"\]"}
|
| **describe** | Describe the specified module and their relative fields | elementType (String) | Return all module information and its fields properties(no hidden fields) |
| Ex: **Url**: VTE\_URL/restapi/v1/vtews/describe
**Parameters**:
{"elementType":"Accounts"}
|
| **describeall** | The describeall method is different from describe one because it shows hidden fields too | ElementType (Encoded) | Return all module information and its fields properties(hidden fields too) |
| Ex: **Url**: VTE\_URL/restapi/v1/vtews/describeall
**Parameters**:
{"elementType":"Accounts"}
|
| **getlabels** | Return all labels and translated ones of the specified module,language | username (String)language (String)module (String) | Return labels and translated ones of the specified module, language |
| Ex:**Url**: VTE\_URL/restapi/v1/vtews/getlabels
**Parameters**:
{"username":"admin", "language":"it\_it", "module":"Accounts"}
|
| **getlangs** | Return all languages installed into the CRM | | Return all CRM languages |
| **loginpwd** | Return user webservice access key if username and password are valid | username (String)password (String) | Return user webservice access key |
| Ex:**Url**: VTE\_URL/restapi/v1/vtews/loginpwd
**Parameters**:
{"username":"admin","password":"123456789"}
|
| **getmenulist** | Return all modules information (visibility, tabid, name, sequence, ...) | | Return modules information and properties |
| **oldoquery** | Return records that contain the searched value into specified module’s fields | module (String)search\_fields (Encoded)search\_value (String) | Return some record basic information where searched value is contained into the specified module’s fields |
| Ex: **Url**: VTE\_URL/restapi/v1/vtews/oldoquery
**Parameters**:
{"module":"Accounts", "search\_fields":"\[\\"accountname\\", \\"website\\"\]", "search\_value":"vtenext"}
|