Public
Documentation Settings
No Environment
Double Column
cURL - cURL
VTENEXT restapi
Introduction
Overview
Authentication
Error Codes
Rate limit
POST
create
POST
delete
POST
describe
POST
describeall
POST
getlabels
POST
getlangs
POST
getmenulist
POST
listtypes
POST
loginpwd
POST
query
POST
retrieve
POST
relate
POST
retrieveinventory
POST
revise
POST
update

VTENEXT restapi

These Web services allow you to do HTTP requests to the specified endpoint. These REST webservice are aviable on VTE 18.12 endpoint and further.

Overview

Initial release provides ALL request in POST

Authentication

The requests need Basic authentication. In Postman, you must set Username and Webservice Access Key under "Authorization" tab after setted "Basic Auth" in "TYPE" dropdown field for each request or define this directly in the Collection.

Error Codes

403 , 500

Rate limit

None

AUTHORIZATIONBasic Auth
Username

<username>

Password

<password>

POSTcreate

http://my.vtenext.url/restapi/v1/vtews/create

Create a record of the specified module

AUTHORIZATIONBasic Auth
This request is using Basic Auth from collectionVTENEXT restapi
HEADERS
Content-Type

application/json

Bodyraw 
{"elementType":"Quotes",
"element":"{\"subject\":\"This is a test from Postman\",\"assigned_user_id\":\"19x1\",\"quotestage\":\"Created\",\"account_id\":\"3x26\",\"bill_street\":\"Street 1\",\"ship_street\":\"Street 2\",\"product_block\":{\"products\":{\"0\":{\"hdnProductId\":{\"crmid\":\"75\"},\"qty\":\"2\",\"listPrice\":\"200\",\"taxes\":[{\"taxname\":\"tax1\",\"percentage\":\"22\"}]}},\"final_details\":{\"taxtype\":\"individual\"}}}"
}
Example Request
upload document attach
curl
curl --location 'http://my.vtenext.url/restapi/v1/vtews/create' \
--header 'Content-Type: application/json' \
--form 'elementType="Documents"' \
--form 'filename=@"/path/to/file"' \
--form 'element="{\"notes_title\": \"test WS\",\"assigned_user_id\": \"19x7\",\"folderid\": \"49x21\",\"filelocationtype\": \"B\",\"backend_name\": \"file\",\"filestatus\": \"1\"}"'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTdelete

http://my.vtenext.url/restapi/v1/vtews/delete

Delete the specified record.

AUTHORIZATIONBasic Auth
This request is using Basic Auth from collectionVTENEXT restapi
HEADERS
Content-Type

application/json

Bodyraw 
{"id":"13x149"}
Example Request
delete
curl
curl --location 'http://my.vtenext.url/restapi/v1/vtews/delete' \
--header 'Content-Type: application/json' \
--data '{"id":"13x149"}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTdescribe

http://my.vtenext.url/restapi/v1/vtews/describe

Describe the specified module and their relative fields.

AUTHORIZATIONBasic Auth
This request is using Basic Auth from collectionVTENEXT restapi
HEADERS
Content-Type

application/json

Bodyraw 
{"elementType":"Leads"}
Example Request
describe
curl
curl --location 'http://my.vtenext.url/restapi/v1/vtews/describe' \
--header 'Content-Type: application/json' \
--data '{"elementType":"Leads"}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers