REST WebService /event/modify

 

Edits the characteristics of an event.

Query

Method

URL

PUT

RACINEVP/ws/rest/event/modify

 

Type

Parameters

Values

HEAD

apikey

String

DATA

attributes

String

DATA

keys

String

DATA

parentKeys

String

DATA

forceCreate

String

apikey

The user’s API key (must be sent in all the queries). Accesses the WebService for a given user and planner.

attributes

List of the attributes to be edited:

[{« entityName » : « attr1 », « entityValue » : « value1 },…]

keys

List of the identification attributes of the event:

[{« entityName » : « attr2 », « entityValue » : « value2 },…]

parentKeys [optional]

List of the identification attributes of the parent event:

[{« entityName » : « attr3 », « entityValue » : « value3 },…]

forceCreate [optional]

Accepts the values true or false. If the value is true, an event is created if no matching key exists in the planner.

Response

Status

Message

0

1

Invalid session : apikey

2

Invalid attribute : entityName

3

Update KO

Example:

For the planner “DEMO API REST”, installed on a Visual Planning server with the root http://127.0.0.1:8906/ip50, containing an event identified by the attributes Customer, Project, Phase, Task and for which we want to change the End date to 30/03/2018. With a user whose access key to the API is: d9f79618-59e4-a710-8203-a39bab9ad09b, we have:

URL:

http://127.0.0.1:8906/ip50/ws/rest/event/modify

Posted data:

{

“keys”:

[

{“entityName”:”Tâches-Client”,”entityValue”:”Client 1″},

{“entityName”:”Tâches-Projet”,”entityValue”:”Projet 1″},

{“entityName”:”Tâches-Phase”,”entityValue”:”Phase 1″},

{“entityName”:”Tâches-Tâche”,”entityValue”:”Analyse”},

],

“attributes”:

[

{“entityName”:”Evénement-Date de fin”,”entityValue”:”30/03/2018 00:00″},

]

}

Response:

{

“error”:0,

“message”:””

}

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

Need training?

Use our consulting services!