REST WebService

 

This WebService can be accessed from the URL ROOTVP/ws/rest.

All the points of access to this WebService must define the apikey attribute with the value provided by the AdminCenter for the corresponding user.

For example, to retrieve the list of the labels of the available attributes, the form of the URL is therefore:

ROOTVP/ws/rest/attributes ?apikey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Where xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx is the key provided.

For all other points of access, the apikey attribute is applied as a parameter of the header of the query and is therefore not specified on the line of the URL.

Example in Java code:

HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();

connection.setRequestProperty (“apikey”, “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx“);

All the exchanges, inputs and outputs of the API are coded in UTF-8.

List of access points

 

Method

EndPoint

Use

Output

GET

/ws/rest/attributes

Gets the labels of the available attributes.

String

GET

/ws/rest/event/export

Provides the characteristics of an event by an event export context.

EntityInfoResult

POST

/ws/rest/event/get

Provides the characteristics of a set of events.

EntityInfoResult

POST

/ws/rest/event/add

Creates a new event.

WSResult

PUT

/ws/rest/event/modify

Edits the characteristics of an event.

WSResult

DELETE

/ws/rest/event/delete

Deletes an event.

WSResult

GET

/ws/rest/resource/export

Provides the characteristics of a resource by a resource export context.

EntityInfoResult

POST

/ws/rest/resource/get

Provides the characteristics of a set of resources.

EntityInfoResult

POST

/ws/rest/resource/add

Creates a new resource.

WSResult

PUT

/ws/rest/resource/modify

Edits the characteristics of a resource.

WSResult

DELETE

/ws/rest/resource/delete

Deletes a resource.

WSResult

POST

/ws/rest/link/create

Creates a link between two events.

WSResult

DELETE

/ws/rest/link/delete

Deletes a link between two events.

WSResult

Print Friendly, PDF & Email
1 Etoile2 Etoiles3 Etoiles4 Etoiles5 Etoiles (No vote)
Loading...
Consulting training

Need training?

Use our consulting services!