REST WebService /event/export

 

Initializes an existing event export context in the planner and retrieves the data it returns.

Query

 

Method

URL

GET

RACINEVP/ws/rest/event/export

 

Type

Parameters

Values

HEAD

apikey

String

QUERY

export

String

 

apikey

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

export

UID identifier of the event export context to be initialized.

Response

The response is made up of a structure containing an error code (error), an associated message (message) and, in the event of success, a table (entities) of the event attributes returned by the export context.

Error

Message

Entities

0

Chaque item du tableau « entities » aura la structure suivante :

[

{

« entityName » : « name1 »,

« enityValue » : « value1 »

},

{

« entityName » : « name2 »,

« enityValue » : « value2 »

}

]

1

Invalid session : apikey

2

No export context : exportUID

3

Invalid export context : exportUID

4

Fatal Error : errorMessage

5

No entities found

6

Export KO

 

Example:

For the “DEMO API REST” planner, installed on a Visual Planning server with the root http ://127.0.0.1:8906/ip50, with an export context whose internal UID identifier is 00FB-1B12-B887-9142-DCB2-B4CB-51C5-7619 and delivering the attributes Start date, End date, Customer, Project, Phase, Task, task ref internal identifier (UID) and Resources of all the events. 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/export?export=00FB-1B12-B887-9142-DCB2-B4CB-51C5-7619

Response:

{

“error”:0,

“message”:””,

“entities”:

[

[

{“entityName”:”Date de début”,”entityValue”:”12/03/2018 00:00″},

{“entityName”:”Date de fin”,”entityValue”:”15/03/2018 00:00″},

{“entityName”:”Client”,”entityValue”:”Client 1″},

{“entityName”:”Projet”,”entityValue”:”Projet 1″},

{“entityName”:”Phase”,”entityValue”:”Phase 1″},

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

{“entityName”:”ref tâche”,”entityValue”:”0080″},

{“entityName”:”Identifiant interne (UID)”,”entityValue”:”A230-6310-E3A5-A6A0-3278-1758-1FE9-B95C”},

{“entityName”:”Ressources”,”entityValue”:””}

],

……..

[

{“entityName”:”Date de début”,”entityValue”:”19/03/2018 00:00″},

{“entityName”:”Date de fin”,”entityValue”:”24/03/2018 00:00″},

{“entityName”:”Client”,”entityValue”:”Client 1″},

{“entityName”:”Projet”,”entityValue”:”Projet 1″},

{“entityName”:”Phase”,”entityValue”:”Phase 1″},

{“entityName”:”Tâche”,”entityValue”:”Conception”},

{“entityName”:”ref tâche”,”entityValue”:”0083″},

{“entityName”:”Identifiant interne (UID)”,”entityValue”:”9BDA-CA97-501F-4229-81F0-DABF-2DDD-FCFA”},

{“entityName”:”Ressources”,”entityValue”:””}

]

]

}

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

Need training?

Use our consulting services!