It is now possible to interact with certain entities of Visual Planning from third party applications thanks to the possibilities offered by the WebServices of the SOAP or REST implementations.
These WebServices provide functionalities to read/create/edit/delete events and resources. They can also be used to create and delete links between events.
Throughout this document, ROOTVP refers to the root of the URL that provides access to the Visual Planning server in question (i.e. before /index.jsp in the URL used to access the home page of the VP server).
Access to these WebServices is protected by an API key. This key is dedicated to one user who must be explicitly declared in the AdminCenter as having the rights to use these services. The declaration of the user and the creation of the API key are specific to each planner.
Generating an API Key
To generate an API Key, start the Admin Center, then edit the properties of a planner using the « Modify » option in its contextual menu in order to display the edition window for the planner properties.
In the “WebService” heading of the edition panel for planner properties, click on the Edit button of the field “Authorized users”.
Add a User using the dedicated button (for instance “user1”). The API Key is automatically generated as follows:
Click OK to confirm that the new user is added. Then, click on Validate in the edition panel for planner properties in order to save changes made.