‣
1. Preamble
This document presents all the APIs (Application Programming Interfaces) made available by 
Project Monitor.
Editorial agreement / Glossary
Term | Description |
PM | |
API | Application Programming Interface |
REST | Representation State Transfer |
HTTP | HyperText Transfer Protocol |
Architecture principle
These APIs are based on :
- the principle of REST (Representational State Transfer) architecture,
- HTTP (hyper text transfer protocol),
- JSON (JavaScript Object Notation) data format.
Test tools
To test APIs interactively, we recommend using one of the following plug-ins:
- Postman recommended by
Virage Group: https://www.postman.com/downloads/ - Firefox REST Client : https://addons.mozilla.org/fr/firefox/addon/restclient/
- Chrome Advanced REST Client : https://chrome.google.com/webstore/detail/advanced-rest-client/
Please note that when xls files are returned, the "restclient" plug-in tries to display the downloaded files directly, rather than offering to open them with the dedicated application.
To obtain the correct date format, you can use one of the following converters:
- http://www.ruddwire.com/handy-code/date-to-millisecond-calculators/
- www.timestamp.fr which translates a date into a second or vice versa
2. General information
Syntax
Principle
In accordance with the HTTP protocol, each API is an HTTP request composed of the following elements:
- a URL, e.g. : https://monprojectmonitor/MonitorMakerWeb/api/projects
- an HTTP verb, e.g. :
POST - information in the HTTP header, e.g:
X-PM-LOGIN:myLogin
The request can be completed with elements in JSON (JavaScript Object Notation) format, http://www.json.org/ex : {"libelle":"monProjet","code":"mon_projet"...} By default, the API returns data in JSON format.
Some calls may return ms-excel or csv files.
N.B.: JSON dates are indicated with timestamps. That is, in number of seconds since January 1, 1970. Ex: August 22, 2012 is represented by 1345586400000
Legible date format
Dates can be supplied in a readable format: YYYY-MM-DDT00:00:00 (RFC-1123, ISO-8601 : http://wiki.fasterxml.com/JacksonFAQDateHandling)
Example: "dateDebut": "2016-12-31T00:00:00" is accepted but "attributs": { "ATT_IMPLEMENTATION_END_DATE": "2018-12-31T00:00:00"} is not.
Query parameters
Query parameters can be passed using a variety of syntaxes.
Please follow this documentation carefully, as notations are not interchangeable unless otherwise indicated.
The first two syntaxes are based on the URL standard: http://fr.wikipedia.org/wiki/Uniform_Resource_Locator#URL_absolue
- Parameter integrated into the "path".
Example:
/projects/2012/germanyThe order is important, since the API implicitly expects this parameter in this place. Parameters are not named. - HTTP parameters.
Example:
/projects?country=Germany&year=2012Parameters are named (key = value). They are separated from the "path" by?and separated by&. The order of the parameters is not important. - "Matrix parameter
Example:
/projects/;year=2012;country=germanyParameters are named (key = value). They are not separated from the "path" and are prefixed by;. The order of the parameters is not important. This notation is not linked to the URL standard.
Finally, these different syntaxes are not incompatible within the same query. It is possible to have parameters in one syntax and others in another. On the other hand, a parameter is expected by the API in a particular syntax.
If the following query is possible : /projects/closed;year=2012?country=Germany&login=mdupont
The following query is not its equivalent: /projects/2012;country=Germany?status=closed&login=mdupont
URLS root
Webservices are available from the following URLs:
https://{UrlProjectMonitor}/MonitorMakerWeb/api where UrlProjectMonitor is the DNS name of the Project Monitor Example: https://projectmonitor/MonitorMakerWeb/api
https://{UrlProjectMonitor}/monitorupgrade where UrlProjectMonitor is the DNS name of the Project Monitor Example: https://projectmonitor/monitorupgrade/
Authentication
JWT token
Important! The JWT token authentication mode is deployed on all Saas infrastructure and is strongly recommended for OnPremise installations.
- Acquisition
- Example with cURL
- API Key deactivation
Unlike the api key, the JWT token is generated directly by an acquisition web service (api/auth/jwt/token). This web service takes as parameters the login and password you wish to use to authenticate yourself.
curl --location '' --header 'X-PM-LOGIN: monlogin' --header 'X-PM-PASSWORD: monmotdepasse'Properties can be used to disable api key operation, so token mode is the only authorized mode. If the property is not defined, then either api key or token will be used; the 2 modes can coexist. Unlike the api key, the token has an expiry date, so it's possible to change the token's default lifetime (24h).
API Key (Depreciated)
Each call to a webservice must be accompanied by an apikey. An apikey is a large string of meaningless characters that authenticates the calling service. The apikey can be generated in the platform's administration screen or specified in the parameters file. <XXX>.monitormaker.properties via the com.vc.mm.webservice.apikey
Example:
#/ com.vc.mm.webservice.apikey (replaces com.vc.mm.commande.exec.auth)
#/ authentication string (api key) for executing web services
# since 5.4.1
#/ required: no
#/ default: nothing (execution impossible)
com.vc.mm.webservice.apikey= BkBUlBLMl4y66kW10M1aRdrGiGn1yO3SOr via the administration screen :
The administration screen lets you define several apikey, name them and, above all, restrict their use to a given IP address. In the example above, the apikey can only be used for requests originating from the IP address 192.168.0.80. The apikey must then be sent for each web service call by one of the following means, in order of verification:
- In the specific HTTP header via the key :
X-PM-API-KEY - In the 'BASIC' HTTP Authorization header: the apikey replaces the login and the password field can be filled with any value.
- In the query parameters with the parameter: apikey
Example: https://projectmonitor/MonitorMakerWeb/api/templates?apikey=BkBUlBLMl4y66kW10M1aRdrGiGn1yO3S
The latter method is insecure (the apikey appears in the URL in clear text, and can therefore typically appear in log files that are themselves insecure).
It should only be used in an internal context (behind a DMZ, for example).
Headers
HTTP request header
In addition to the authentication elements described above, you need to add the following header:
Accept: application/jsonHTTP header for responses
Web services systematically return json encoded in UTF-8 :
Content-Type: application/json;charset=UTF-8Cross domain access
It is possible to access the webservices of Project Monitor from HTML + javascript pages from a domain other than that of Project Monitor. There are two techniques for achieving this.
JSON-P
Project Monitor implements the json-p technique (http://en.wikipedia.org/wiki/JSONP) and proposes a global parameter for each webservice: jsoncallback.
This parameter must be supplied as a query parameter. Example:
<!—requête envoyée par une balise ‘script’ -->
<script src="<http://projectmonitor/MonitorMakerWeb/api/templates?login=jdupont&jsoncallback=myCallBack>"></script>
<!— résultat du web service reçues en paramètre de la fonction callback. -->
<script>function myCallBack(data) {console.log(data.value);}</script>Nota Bene: The very principle of JSON-P does not allow information to be supplied to the web service via the http header.
Cross-Origin Resource Sharing
Cross-Origin Resource Sharing (or CORS, http://en.wikipedia.org/wiki/Cross-origin_resource_sharing) is a standard mechanism for sharing information between websites. Project Monitor supports this mechanism on the server side. This mechanism depends on the browser running the calling html page: http://en.wikipedia.org/wiki/Cross-origin_resource_sharing#Browser_support
Errors
Errors are reported via an HTTP status
Code | Description |
400 | Wrong request. The parameters supplied are not correct. In this case, the response body contains functional code and a plain text message , all sent in JSON format.
Note that 400 errors can occur without a functional message . The most common example is a call without passing the expected parameters.
These messages are not generated directly by Project Monitor but by the Wildfly server. The content is usually Content-Type: text/html.
Example: Request to create a project without passing the json parameter as input |
401 | Current user identification problem |
403 | Forbidden - The current user does not have the right to use this API. Example: "Project creation" rights are required to POST the URL https://projectmonitor/MonitorMakerWeb/api/projects/ |
415 | It is certainly missing Content-Type: application/json in the header. |
500 | Internal server error |
3. API (HTTP verb: GET)
/templates: project templates
Description | List of project templates |
Webservice code | /templates |
Management rules | Right ACT_UTILISER_GABARIT  Using templates in projects |
Example | |
Bean Sortie | Bean IdLibelle |
Body Sortie | { "id": 255527, "libelle": "le libellé de mon objet", "description": "une description plus longue souvent facultative", "designation": "éventuellement un libellé alternatif" } |
Results | JSON |
/currentuser : project filters
Description | List of project filters accessible to the current user |
Webservice code | /currentuser/filters |
Management rules | Right ACT_UTILISER_FILTRES_PUB_PROJET Using public project filters in the filter selector |
Example | |
Bean Sortie | Bean IdLibelle |
Body Sortie | { "id": 255527, "libelle": "le libellé de mon objet",
"description": "une description plus longue souvent facultative",
"designation": "éventuellement un libellé alternatif" } |
Results | JSON |
/currentuser : authorization rights
Description | List of user rights codes.
All rights on all hierarchies are considered. In other words, you only need to have the right once somewhere. |
Webservice code | /currentuser/permissions |
Management rules | |
Example | |
Bean Sortie | Channel |
Body Sortie | [ string1, string2.... ] |
Results | JSON |
Description | Returns true/false if the right is authorized or not.
All rights on all hierarchies are considered.
In other words, you only need to have the right once somewhere. |
Webservice code | /currentuser/permissions/{permissionsCode} |
Management rules | |
Example | |
Bean Sortie | True/False |
Body Sortie | True/False |
Results | JSON |
Description | Returns "TRUE" or "FALSE" if the user has a right or not.
The "actionCode" corresponds to the code of the right (e.g. ACT_MODIFY_PROJECT).
id" corresponds to the id of the object (project, user) (e.g. 553615). |
Webservice code | /currentuser/rights/{actionCode}?objectid={id} |
Management rules | |
Example | |
Bean Sortie | True/False |
Body Sortie | True/False |
Results | JSON |
/roles
Description | List project roles |
Webservice code | /roles |
Management rules | Right ACT_CONSULTER_ROLE Consult platform administration roles |
Example | |
Bean Sortie | Bean
RoleValue |
Body Sortie | [{ "id": 123, "libelle": "Chef de projet",
"description": "Responsable de projet", "key": "246703” }, ...] |
Results | JSON |
/roles/hierarchical: user roles on all projects
Description | Lists the " structure profile role" codes and the users making up these roles for all projects.
If no " structure profile role " code is entered for the role, it will not be included in the response. |
Webservice code | /roles/hierarchical |
Management rules | |
Example | |
Bean Sortie | Channel |
Body Sortie | { "ID_PROJET_1": { "CODE_ROLE_1": [userId_1,userId2],
"CODE_ROLE_2": [userId_3,userId4], },
"ID_PROJET_2": { "CODE_ROLE_1": [userId_1,userId2],
"CODE_ROLE_2": [userId_3,userId4], }, } |
Results | JSON |
/users
Description | Lists user information |
Webservice code | /users/{userId} |
Management rules | |
Example | |
Bean Sortie | Bean User file |
Body Sortie | { "id": "12345", "libelle":"test web service 1","description": "", "index": 188534, "login": "adm","nom": "adm", "prenom": "adm","telephoneBureau": "", "mail": "adm@adm.fr","nomP": "adm a.", "actif": true,"formatCalendrier": "fr_FR", "ressourceSuivie": false,"niveauLicence": null, "idSMM": 1225, "idUP": 155245,"motDePasse": "", "sexe": null,"langue": { "id": 1, "libelle": "Français","description": "","code": "fr", "key": "1" }, "titre": "", "societe": "","telephoneAssistance": "", "telephoneStandard": "","telephoneMobile": "", "adresse1": "", "codePostal1": "","ville1": "", "adresse2": "", "codePostal2": "", "ville2": "","region": "", "parametres": { "pageAccueil":{ "id": -1, "libelle": "", "description": "", "key": "-1" },"filtreProjetParDefaut": { "id": -1, "libelle": "", "description": "", "key": "-1" },"filtreRessourceParDefaut": { "id": -1, "libelle": "","description": "", "key": "-1" } },"dateOuverture": 1516662000000, "dateFermeture": null,"dateFermetureOrigine": null, "alertModifParMail": false,"synchroDatesUP": false, "forceLienRessourceParLibelle": false,"image": null, "abonnements": null, "identifiantLDAP": "","ressource": { "id": -1, "libelle": "", "description": "", "key": "-1" }, "dateDerniereModificationMdp": null,"dateCreation": 1516715245593, "invite": false,"cache": false, "roles":[..]"arbreProfilsHierarchies": null,"abonnementsCharges": false, "profilsProjets": null,"motDePasseGereParMM": true, "userLDAP": false,"ligneRoles": "1 - Administrateur<br/>","libelleLong": "adm adm", "codeObjetType": "UTILISATEUR", "key": "315563" } |
Results | JSON |
/users: user details
Description | Returns a paginated list of active users, ordered by first and last name. The result can be filtered using query parameters:
➢ contains filter users by value. This value is searched for in the user's "login", "last name" and "first name".
If the value is found, the user is displayed, otherwise not.
➢ globalRole Possible values: true or false
If true this indicates that we're looking for a user with a role in the "General roles" scope.
If false this perimeter is not taken into account
➢ hierarchicalRole Possible values: true or false
If true this indicates that we're looking for a user with a role in the " structure role " scope.
If false this perimeter is not taken into account
➢ projectRole Possible values: true or false
If true this indicates that we're looking for a user with a role in the "Project roles" scope.
If false this perimeter is not taken into account
➢ roleCodes Role filter: allows you to filter users by role (role code) and scope ("General roles", "Project roles" and " structure roles").
If no perimeter is activated, the role filter does not apply.
Example: /users?projectRole=true&roleCodes=ROL_RESPONSABLE_PROJECT&roleCodes=ROL_TEAM_MEMBER
In this example, we display users with a "global" role who have the role manager projectmanager " OR team member on at least one project. It is also possible to set the pagination:
➢ page specifies the desired page number (starts at 1) default=1
➢ perPage number of items per page (must be less than 200) default=25 The WS returns the list of items corresponding to the requested page.
The header X-PM-TOTAL-COUNT contains the total number of items (excluding pagination). |
Webservice code | /users |
Management rules | |
Example | |
Bean Sortie | Bean
IdLibelle |
Body Sortie | { "id": 255527, "libelle": "le libellé de mon objet",
"description": "une description plus longue souvent facultative",
"designation": "éventuellement un libellé alternatif" } |
Results | JSON |
/lists
Description | List of possible values for the givenattribute of the given object type |
Webservice code | /lists/{objectTypeCode}/{attributeCode} |
Management rules | |
Example | |
Bean Sortie | Bean ListValue |
Body Sortie | { "id": 82418, "libelle": "le libellé de ma valeur de liste",
"description": "une description plus longue souvent facultative",
"couleur": "#FF0000", "defaut": false,
"beanIcone": { "id": 287447, "libelle": "Brouillon.jpg",
"nomFichier": "Brouillon.jpg", "urlFichier": "http://projectmonitor/MonitorMakerWeb
/doc/1225/2204/2012/4/26/287447/term ine16.jpg"}, "ponderation": 0, "code": "STATUT_BROUILLON",
"ordre": 0, "designation": "Brouillon" } |
Results | JSON |
/projects
Description | Project information by ID
Returns the information for the given project. But without the following information: attachments, team, attributes, etc. |
Webservice code | /projects/{projectId} |
Management rules | |
Example | |
Bean Sortie | Bean WSProjet |
Body Sortie | { "id": "12345", "libelle":"test web service 1", "description":"", "code":"test-ws1", "libelleLong":"test web service", "statut": { "id": 246721, "libelle": "En cours", "description": "", "code": "CODE_STATUT" } "idGabarit": -1, "codeGabarit": "CODE_GABARIT" "dateDebut":1072911600000, "dateFin":1167519600000, "loginChefDeProjet": "ngavard", "rattachements": {"CODE_HIERARCHIE1": ["CODE_VN1"], "CODE_HIERARCHIE2": ["CODE_VN2", CODE_VN3]}, "equipe": {"CODE_ROLE1": ["login1", " login2"], "CODE_ROLE2": ["login3"]}, "attributs": {"CODE_ATTRIBUT1_CHAINE": "ma valeur" , " CODE_ATTRIBUT2_VALEUR_NUM": 55.5, "CODE_ATTRIBUT3_VALEUR_LISTE":"CODE_VALEUR_LISTE"} } |
Results | JSON |
/projects attributes : value of a project attribute
Description | Returns the current value of the "codeAttributes"attribute for the project identified by "projectId". |
Webservice code | /projects/{projectId}/attributes/{codeAttributes} |
Management rules | |
Example | |
Bean Sortie | Channel |
Body Sortie | { codeAttribut1:valeurAttribut1 } |
Results | JSON |
/projects forms: value of project form attributes
Description | Returns all values to date of the attributes of the " form on the project identified by "projectId". |
Webservice code | /projects/{projectId}/forms/{codeForm} |
Management rules | |
Example | |
Bean Sortie | Channel |
Body Sortie | { codeAttribut1:valeurAttribut1, codeAttribut2:valeurAttribut2, ...} |
Results | JSON |
/projects: list of projects
Description | Returns a list of projects filtered by the supplied filter "filterId" corresponds to a persistent project filter. |
Webservice code | /projects;filterId={filterId} |
Management rules | Right ACT_CONSULTER_PROJECT_AFFECTE Consultation of a project to which the user is assigned |
Example | |
Bean Sortie | Bean
IDLibelle |
Body Sortie | [{ "id": 255527, "libelle": "le libellé de mon objet", "description": "une description plus longue souvent facultative", "designation": "éventuellement un libellé alternatif" }, { "id": 255523, "libelle": "le libellé de mon objet 3", "description": "une description plus longue souvent facultative", "designation": "éventuellement un libellé alternatif" }] |
Results | JSON |
/projects: identification of the "model" project
Description | Returns the id of the "template" project used to duplicate the "projectId" project. |
Webservice code | /projects/{projectId}/copiedfrom |
Management rules | |
Example | |
Bean Sortie | Channel |
Body Sortie | { "id": 156381, //id du projet « modèle » "libelle": "", "description": "", "key": "156381" } |
Results | JSON |
/projects: retrieve the value of attachments to hierarchies
Description | Returns all hierarchy information and level values to which the project is attached. |
Webservice code | /projects/{projectId}/hierarchies |
Management rules | |
Example | |
Bean Sortie | Channel |
Body Sortie | { "codeOuLibelléHiérarchie 1" : BeanValeurNiveau } |
Results | JSON |
/projects: retrieve the value of attachments to a structure
Description | Returns all information about a defined structure (hierarchyCode) and the level values to which the project is linked. |
Webservice code | /projects/{projectId}/hierarchies/{hierarchyCode} |
Management rules | |
Example | |
Bean Sortie | BeanValueLevel |
Body Sortie | [{ "id": 123, "libelle": "valeurRattachée", "description": "", "code": "", "hierarchiePrincipale": { "id": 456, "libelle": "hiérarchie" }, "niveau": { "id": 789, "libelle": "Niveau 2", "code": "", "dateModification": 1302881673810, "codeObjetType": "NIVEAU" } }, ...] |
Results | JSON |
/hierarchies: project links
Description | Returns the list of hierarchical level values to which the project (code {projectid}) is attached and corresponding to the code {hierarchyCode}. |
Webservice code | /hierarchies/project/{projectId};hierarchyCode={hierarchyCode} |
Management rules | |
Example | |
Bean Sortie | Bean IDLibelle |
Body Sortie | { "id": 255527, "libelle": "le libellé de mon objet", "description": "une description plus longue souvent facultative", "designation": "éventuellement un libellé alternatif" } |
Results | JSON |
/hierarchies values: retrieve levels and level values from a structure
Description | Returns the levels and level values of a structure (codeHierarchy) without taking the project into account |
Webservice code | /hierarchies/values/{Hierarchiecode} |
Management rules | |
Example | |
Bean Sortie | Channel |
Body Sortie | { libelle : "...", code : "...",
niveaux : [ niveau 1 : { libelle : "...", code : "...",
valeursNiveaux : [ ... idNiveaupere : ... , .... ] },
niveau 2 : { libelle : "...", code : "...",
valeursNiveaux : [ ... idNiveaupere : ... , .... ] } ] } |
Results | JSON |
/team
Description | Lists the people making up a project team |
Webservice code | /projects/{projectId}/team |
Management rules | Right ACT_CONSULTER_PROJECT_AFFECTE Consultation of a project to which the user is assigned |
Example | |
Bean Sortie | Bean WSProjet |
Body Sortie | { "id": "12345", "libelle":"test web service 1", "description":"", "code":"test-ws1", "libelleLong":"test web service", "statut": { "id": 246721, "libelle": "En cours", "description": "", "code": "CODE_STATUT", "equipe": {"CODE_ROLE1": ["login1", " login2"] } } |
Results | JSON |
/reports
Description | Runs the selected report with the corresponding view . Applies the specified project filter and period for reports using a period as parameter. The period is defined relative to the current month: if the "from" parameter is specified but without "to", this indicates the number of months to be taken in the past relative to the current date.
Ex: from=5 indicates to take 5 months back Similarly, if the "to" parameter is specified but without "from", this indicates the number of months in the future.
Ex: to=3 indicates 3 months in the future. Finally, if neither the "from" nor the "to" parameters are specified, this indicates project periods. Possible formats are: csv, excel, csvemail and excelemail.
If you use the "csv" or "csvemail" format, please update the "HTTP REQUEST HEADER" header with :
- Accept : text/csv;application/json If you use the "excel" or "excelemail" format, please update the "HTTP REQUEST HEADER" header with :
- Accept : application/vnd.ms-excel;application/json Calling the web service requires one of the two rights: ACT_CONSULTER_STATUS_MULTIPROJECT or ACT_CONSULTER_STATUS_MEASURES.
The reports currently authorized are :
- EXPORT_RESSOURCE_PROJET: Export of project resource data (except planned)
- EXPORT_PHASE: Export of project phases.
- EXPORT_TASK: Export project tasks.
- EXPORT_JALON: Export project milestones.
- EXPORT_RESSOURCE: Export of resource data (label, profile, capacity, code, etc.). This export is not subject to project filters, views or period selection. Indicating them in the query will have no impact.
- EXPORT_ECHANGE: Export project exchanges
- EXPORT_INDICATOR_UP: Export of platform indicators
- EXPORT_INDICATOR: Export of indicators
- EXPORT_PROJET: Export projects
- EXPORT_BUDGET: Export project budget data |
Webservice code | /reports/{format}/{report}/{viewCode};filterCode={filterCode};from={from};to={to} |
Management rules | |
Example | |
Bean Sortie | Excel or CSV file in the requested format |
Results | Excel or CSV file in the requested format |
/phases
Description | Returns the list of phases associated with the project. |
Webservice code | /phases?projectId={projectId} |
Management rules | Right ACT_CONSULTER_OBJET_PLANNING Consultation of a schedule object |
Example | |
Bean Sortie | Bean WSPhase |
Body Sortie | { "id": 520454, "libelle": "Expression des Besoins","description": "", "code": "", "type": {beanValeurListe},"etat": {beanValeurListe}, "message": "","parent": { "id": 520455, "libelle": "Lot 1", "description": "","key": "520455" }, "loginResponsable": "jdupont", "debutEstime": 1521216000000,"finEstime": 1530975600000,"debutCible": 1521216000000,"finCible": 1530975600000,"projet":{"id": 520451} } |
Results | JSON |
/phases: data recovery
Description | Returns the properties of a phase without dependencies. |
Webservice code | /phases/{phaseID} |
Management rules | Right ACT_CONSULTER_OBJET_PLANNING Consultation of a schedule object |
Example | |
Bean Sortie | Bean
WSPhase |
Body Sortie | { "id": 520454, "libelle": "Expression des Besoins","description": "", "code": "", "type": {beanIdOuCode},"etat": {beanIdLibelle}, "dateDebut": null,"message": "", "parent": { "id": 520455, "libelle": "Lot 1","description": "", "key": "520455" },"loginResponsable": "jdupont", "codeStatut": "A_VALIDER","debutEstime": 1521216000000, "finEstime": 1530975600000,"debutCible": 1521216000000, "finCible": 1530975600000 } |
Results | JSON |
/phases: dependency recovery
Description | Returns properties on phase dependencies |
Webservice code | /phases/{phaseID}/dependencies |
Management rules | Right ACT_CONSULTER_OBJET_PLANNING Consultation of a schedule object |
Example | |
Bean Sortie | Bean
WS
Dependency |
Body Sortie | [{ "predecesseur":{ "id": 520453, "libelle": "Conduite du projet","description": null, "key": "520453" },"projetPredecesseur": { "id": 520452,"libelle": "DP - AREA PRE SORT", "description": "","key": "520452" },"type": "REL_TYPE_FINISH_TO_START", "valeur": 0 }, ...] |
Results | JSON |
/phases attributes: value of a phase attribute
Description | Returns the date value of the "codeAttributes"attribute for the phase identified by "phasesId". |
Webservice code | /phases/{phasesId}/attributes/{codeAttributes} |
Management rules | |
Example | |
Bean Sortie | Channel |
Body Sortie | |
Results | JSON |
/admin
Description | Returns information on the version of Project Monitor and database scripts. |
Webservice code | Right ACT_AFFICHER_ETAT_ADMIN Display administration reports |
Management rules | |
Example | /admin/about |
Bean Sortie | Channel |
Body Sortie | { "version": "v5.4.0.3",
"database": { "productName": "SQL server",
"base": "projmon", "userName": "projmon"},
"scripts":[ { "datePassage":1317765600000,
"RCSfile" : "G_libelles_v_5_4_0_1.sql"
"revision" : " 1.1" "commentaire" : ""} ... ] } |
Results | JSON |
Description | Synchronous execution of the batch command supplied as a parameter |
Webservice code | /admin/exec/{commandName} |
Management rules | Law ACT_CONFIG_TECHNIQUE Configure technical application parameters |
Example | |
Bean Entrée | |
Body Entry | |
Bean Sortie | Channel |
Body Sortie | 200 OK |
Results | JSON |
4. API (HTTP verbs: POST/DELETE)
/projects: creation or modification
Description | Creating or modifying one or more projects To modify a project, pass its id to the input BeanWsProject. The web service accepts as input a simple BeanWsProjet or an array of BeanWsProjets (creation/modification).
Notes :
- The "id" field only needs to be filled in when updating a project. When a project is created, an id is automatically generated.
- For attributes of the "List value" type, it is the code of the list value that must be sent, not its label.
- The "idStatus" and "idGabarit" properties have priority over "codeStatus" and "codeGabarit". You can set either one or the other, but if both are present, only the id will be taken into account.
- MOD_INDICATOR" is a fixed value that does not apply to modules other than the indicator module. Multiple categories can be entered by separating blocks with commas.
- Accepted representation codes are : REP_REALISE and REP_PLANIFIE_REPARTI |
Webservice code | /projects |
Management rules | Rights ACT_CONSULTER_PROJET_AFFECTE Consultation of a project to which the user is assigned ACT_CREER_PROJET Project creation ACT_MODIFY_PROJECT Project modification |
Example | |
Bean Entrée | WsProjet bean or array of WsProjet beans |
Body Entry | { "id": "12345", "libelle":"test web service 1", "description":"", "code":"test-ws1", "libelleLong":"test web service",
"statut": { "id": 246721, "libelle": "En cours", "description": "", "code": "CODE_STATUT" }
"idGabarit": -1, "codeGabarit": "CODE_GABARIT" "dateDebut":1072911600000, "dateFin":1167519600000, "loginChefDeProjet": "ngavard", "rattachements": {"CODE_HIERARCHIE1": ["CODE_VN1"], "CODE_HIERARCHIE2": ["CODE_VN2", CODE_VN3]}, "equipe": {"CODE_ROLE1": ["login1", " login2"], "CODE_ROLE2": ["login3"]}, "attributs": {"CODE_ATTRIBUT1_CHAINE": "ma valeur" , " CODE_ATTRIBUT2_VALEUR_NUM": 55.5, " CODE_ATTRIBUT3_VALEUR_LISTE":"CODE_VALEUR_LISTE"} } |
Bean Sortie | Bean WSRetour |
Body Sortie | { "beanWsErreur" : { "code" : "LBL_RATTACHEMENTS_PROJET_HIERARCHIES_INCOMPLETE", "message" : "Toutes les hiérarchies ne sont pas affectées" }, "beanWsItem" : { "id" : 12345, "code" : "test-ws1", "libelle" : "test web service 1" } } |
Results | JSON |
/projects: list of projects
Description | Advanced project search based on filter and json parameter criteria. "filterId" corresponds to a persistent project filter.
NB: For the "codeVue" field, only " dashboard (piloting)" views work. |
Webservice code | /projects/query |
Management rules | Right ACT_CONSULTER_PROJECT_AFFECTE Consultation of a project to which the user is assigned |
Example | |
Bean Entrée | BeanFilterProjectParam |
Body Entry | { "loginUser":"loginUser", "codeRoles":["CODE_ROLE1", "CODE_ROLE2",...], "codeAttributListe":"CODE_ATTRIBUT_LISTE", "idValeurAttributListe":128824, "jalonEnRetard": "false", "idProjets": [244071, 290590, ...], "codeVue": "CODE_VUE", "idProjetPere" : 200115 } |
Bean Sortie | BeanWSCockpit |
Body Sortie | { "projet": {}, "valeurCockpits": { "CODE_COCKPIT1": {"feux": {"code": "VERT"}, "iconeName": "BallGreen.png"}, "CODE_COCKPIT2": {"feux": {"code": "GRIS"}, "iconeName": "BallGrey.png"}, ... } } |
Results | JSON |
/phases: creation or modification
Description | Creating or modifying one or more phase and milestone
If the phase or milestone sent includes an id or code that already exists: we modify the existing object. Otherwise we create a new object, using the information received. |
Webservice code | /phases |
Management rules | |
Example | |
Bean Entrée | beanWsPhaseEntrée |
Body Entry | dans le cas d’une PHASE : { "id": 520454, "libelle": "Expression des Besoins",
//obligatoire en création, facultatif en modification "gabarit": {beanIdOuCode}, "projet" : {beanIdOuCode},//obligatoire en création, facultatif en modification "idPhaseParente" : "",
//si non précisé en création alors la tache devient une tache parente. En modification l’id de la phase parente doit correspondre à une phase du projet indiqué par le paramètre "projet" "etat": {beanIdOuCode},
//si non précisé en création alors état par défaut "type": {beanIdOuCode},
//si non précisé en création alors type par défaut "code" : "", "debutEstime": 1521216000000, "finEstime": 1530975600000, "debutCible": 1521216000000, "finCible": 1530975600000, "attributs": {"CODE_ATTRIBUT1_CHAINE": "ma valeur", "CODE_ATTRIBUT2_VALEUR_NUM": 55.5, "CODE_ATTRIBUT3_VALEUR_LISTE":"CODE_VALEUR_LISTE"} } Ou dans le cas d’un JALON : { "projet": {"id": 457219}, "libelle": "nouveau", "type": {"code":"GENRE_PLANNING_NOUVEAU"}, "jalon": true, "finCible" : "2022-01-13" } En modification : { "projet": {"id": 457219}, "code": "jalonwkf", "fait": true } |
Bean Sortie | BeanWSBack |
Body Sortie | |
Results | JSON |
/tasks
Description | Advanced task search based on json parameter criteria. "filterId" corresponds to a persistent project filter. |
Webservice code | /tasks;filterId={filterId}/query |
Management rules | |
Example | |
Bean Entrée | BeanWsFiltreTacheParam |
Body Entry | { "loginEmetteur": "loginUser1", "loginAssigne": "loginUser2", "dateFinSuperieureA":1072911600000, "dateFinInferieureA":1072911600000, "dateEcheanceSuperieureA":1072911600000, "dateEcheanceInferieureA":1072911600000, "listeIdsStatut": [123, 466], "listeIdsCategorie": [987, ...] "beanFiltreProjetParam": { "idProjets": [244071, 290590, ...] "loginUser":"loginUser", "codeRoles":["CODE_ROLE1", "CODE_ROLE2"] } } |
Bean Sortie | BeanWsTacheOut |
Body Sortie | { "id": 22709, "libelle": "libellé de la tâche", "code": "22709", "dateModification": 1338274295973, "projet": {beanObjet}, "message": "Contenu HTML <b> de la tâche</b>", "saisissable": true, "loginEmetteur": "loginUser1", "loginAssigne": " loginUser2", "dateDebut": null, "dateDebutPrevue": null, "dateFin": null, "dateEcheance": null, "etat": {beanIdLibelle}, "type": {beanIdLibelle}, "urlTache": "http://projectmonitor/MonitorMakerWeb/connexion.jsf?NumEcran=351&IdSMM=12 25&IdUP=2204&IdObjet=22709", "urlProjet": "http:// projectmonitor/MonitorMakerWeb/connexion.jsf?NumEcran=351&IdSMM=1225&IdUP= 2204&IdObjet=290354" } |
Results | JSON |
Description | Creating or modifying a task or set of tasks
If the task sent contains an id or code that already exists: the existing task is modified. Otherwise, a new task is created using the information received. Mandatory fields for creation are : - project: identified by its id or code Mandatory fields for modification are: - id or code (of the task) |
Webservice code | /tasks; |
Verb | POST |
Management rules | |
Example | |
Bean Entrée | Bean WsTacheEntréeOu array[BeanWsTacheEntrée1, BeanWsTacheEntrée2,BeanWsTacheEntrée3 |
Body Entrée (if created) | { "libelle": "Mettre à jour l’univers BO pour CASSIOPEE", "projet": { "id": 573456 }, "message": "Demande du service BCU. Merci de mettre à jour l’univers BO pour <b>cassiopée</b>. <br/> Avertir le service Facturation quand la demande sera realisée.", "loginEmetteur": "blopez", "etat": { "code": "ETAT_A_DEBUTER" }, "categorie": { "code": "CAT_BI" }, "gabarit": { "code": "GAB_TACHE_DSI" }, "priorite": { beanIdOuCode }, "phase": { "code": "CODE_PHASE"}, "loginAssigne": "Severin.prin", "loginsParticipants": ["pierre.visualiseur","julie.cheffep"], "roleAssigne": "ROL_CP_MOE”, "roleParticipants" : "ROL_MEMBRE_EQUIPE”, "envoyerMail" : true, (mail à tous assigné, chef de projet et participants), "envoyerMailChefDeProjet" : true (mail au chef de projet), "envoyerMailAssigne" : true, (mail à assigné) "envoyerMailParticipants" : true (mail à participants) } |
Body Input (if modified) | { "id": 12345, "loginAssigne": "jmchevillot", "statut": { "code": "ETAT_A_FACTURER" }, "attributs": { "NUM_BON_FACTU": "2017_BCU_12345", "NB_HEURES_PASSEES": 10.5 }, "phase": { "code": "CODE_PHASE"}, "loginsParticipants": ["pierre.visualiseur","julie.cheffep"], "roleParticipants" : "ROL_MEMBRE_EQUIPE” } |
Bean Sortie | BeanWSBack |
Body Sortie | Dismissed by Project Monitor : tableau de BeanWsRetour. Un BeanWsRetour est composé d’un BeanWsErreur portant le code et le message de l’erreur (champs vides si pas d’erreur), et un BeanWsItem portant les informations du projet concerné. { "beanWsErreur" :
{ "code" : "LBL_RATTACHEMENTS_PROJET_HIERARCHIES_INCOMPLETE", "message" : "Toutes les hiérarchies ne sont pas affectées" }, "beanWsItem" : { "id" : 12345, "code" : "test-ws1", "libelle" : "test web service 1" } } |
Results | JSON |
/documents
- A document can be associated with an object or an object attribute (in the case of creation AND deletion). If the call concerns an attribute, theattribute code must be supplied.
- If a document is attached to an object, a default structure link type is used. The default structure type is "Attachment" in most cases, and "Deliverable" for phases and milestones.
- You can only add/delete a document on an object if it is attached to a project or is itself a project. Consequently, these webservices do not work with templates.
Description | document creation.
- Id document identifier, used only for deletion.
- idObject / codeObject object: identifier and code of the object to which the document is attached. There's no need to fill in both fields at the same time; one or the other will suffice. By default, idObject will be taken into account if both are indicated.
- codeAttributeattribute code if the document is to be attached to an object attribute (task). If not supplied, the document will be attached directly to the object.
- url URL of the document. Currently only "URL" documents are accepted.
- version : version du document.
• idStatut/codeStatut : statut (état) du document. De même que pour l’objet rattaché, il est inutile d’indiquer les deux. |
Webservice code | /documents |
Management rules | Creation is subject to ACT_MODIFIER_* and ACT_MODIFIER_MES_* rights (depending on the type of object attached, e.g. "ACT_MODIFIER_TACHE"). You must have the right to modify the object attached to the document in order to create the document. In the case of a document attribute , you must also have the "ACT_UTILISER_ATTRIBUT" right. |
Example | |
Bean Entrée | beanWsDocument |
Body Entry | Pour créer un document, il faut au minimum les paramètres suivants dans le beanWsProjet en entrée :
• idObjet OU codeObjet
• url
• [codeAttribut] (si le document est rattaché à un attribut)
Les autres propriétés du BeanWsDocument sont optionnelles.
Ex de BeanWsDocument en entrée :
{ « IdObjet » : 12345,“Url” : “https://upload.wikimedia.org/wikipedia/commons/2C_Scotland.jpg” }
{ "id":333417, "idObjet":45338, "codeObjet":"THE_CODE", "codeAttribut":"DOC_CONTRAT", "url":"http://exemple.icone.fr", "version":"VERSION 1.2", "idStatut":3432, "codeStatut":"EST_ACTIF" } |
Bean Sortie | Channel |
Body Sortie | New document identifier |
Results |
Description | document information retrieval |
Webservice code | /documents/idDocument |
Management rules | |
Example | |
Bean Entrée | IDDocument |
Body Entry | |
Bean Sortie | |
Body Sortie | - ID + Physical document path + Size + Extension + document status (ID + Code + status label) + document
version
- ID + Code + Project label on which the document
is located
- ID + Code + Container label + Container typeattribute, task, exchange, phase, milestone, financial document) |
Results | JSON |
Description | document deletion |
Webservice code | /documents |
Management rules | Deletion is subject to ACT_MODIFY_* and ACT_MODIFY_MES_* rights (depending on the type of object attached, e.g. "ACT_MODIFY_TACHE"). You must have the right to modify the object attached to the document in order to delete the document. In the case of a document attribute , you must also have the "ACT_UTILISER_ATTRIBUT" right. |
Example | |
Bean Entrée | beanWsDocument |
Body Entry | Pour supprimer un document, il faut au minimum les paramètres suivants dans le beanWsProjet en entrée :
• id
• [codeAttribut] (si le document est rattaché à un attribut) OU
• idObjet OU codeObjet
• url
• [codeAttribut] (si le document est rattaché à un attribut) Ex de BeanWsDocument en entrée : { « id » : 12346, « codeAttribut » : « ICONE_TACHE » } { "id":333417, "idObjet":45338, "codeObjet":"THE_CODE", "codeAttribut":"DOC_CONTRAT", "url":"http://exemple.icone.fr", "version":"VERSION 1.2", "idStatut":3432, "codeStatut":"EST_ACTIF" } |
Bean Sortie | Channel |
Body Sortie | true if successful, otherwise an error is returned |
Results | JSON |
/echange : creation or modification
Description | Creation or modification of one or moreexchange If theexchange sent contains an id or code that already exists: we modify the existingexchange . Otherwise, we create a new exchange with the information received. |
Webservice code | /exchanges |
Management rules | |
Example | |
Bean Entrée | BeanWsExchangeInputOor array[BeanWsExchangeInput1,BeanWsExchangeInput2,BeanWsExchangeInput3] |
Body Entry | Les champs obligatoires en création sont :
- libellé : sujet de l’échange
- projet : identifié par son id ou son code Le champ obligatoire en modification est :
- id (de l’échange) { "libelle": "libellé de l’échange", //obligatoire en création, facultatif en modification "id": 22709,
//uniquement en modification "projet": {beanIdOuCode}, //obligatoire en création, facultatif en modification "message": "Contenu HTML <b> de la tâche</b>", "loginEmetteur": "loginUser1",
//facultatif en création, ignoré en modification "loginAssigne": "loginUser2", "type": { beanIdOuCode },
//si non précisé en création alors type par défut "gabarit": { beanIdOuCode }, "echangePrecedent": { beanIdOuCode }, "gabarit": { beanIdOuCode }, "dateEdition": 1338274295973, "dateDeclare": 1338274295973, "envoiParMailAlAssigne":{"true" or "false"},
//obligatoire si le champ LoginAssigne est renseigné "attributs": {"CODE_ATTRIBUT1_CHAINE": "ma valeur", "CODE_ATTRIBUT2_VALEUR_NUM": 55.5, "CODE_ATTRIBUT3_VALEUR_LISTE":"CODE_VALEUR_LISTE"} } |
Bean Sortie | BeanWSBack |
Body Sortie | |
Results | JSON |
4. API (HTTP Verbs: PUT)
/resources/{id} : modification d’une ressource
Description | Allows you to update information about a resource |
Webservice code | /monitorupgrade/resources/{id} (Note that the endpoint is /monitorupgrade/resources/{id} and not /MonitorMakerWeb/api/resources/{id}) |
Management rules | Droits ACT_MODIFIER_RESSOURCE “Modifier les ressources”.
Le paramètre d’URL {id} correspond à l’identifiant de la ressource
Champs modifiables
code : code de la ressource
label : libellé de la ressources
longLabel : libellé long de la ressource
description : description de la ressource
hierarchiesValues: rattachements hiérarchiques de la ressource (ajouté en v7.7)
category : identifiant de la catégorie
type : identifiant du type de ressource
profil : identifiant du type de profil
Avertissement
Il est recommandé de récupérer initialement le flux en appelant au préalable les service de récupération de ressource /monitorupgrade/ressources/{id} (où {id} est l’identifiant de la ressource.
Chaque clé-valeur d’un utilisateur qui ne sera pas renvoyée dans son état original sera supprimée. |
Example | |
Body Entry | { "id": 899895, "code": "Maeva.cdp", "label": "Maëva CDP", "longLabel": nulldescription": null, "order": -1, "hierarchiesValues": [ { "hierarchy": { "id": 88878, "code": "string", "label": "string", "longLabel": "string", "description": "string", "order": 0 }, "values": [ { "id": 987678, "code": "string", "label": "string", "longLabel": "string", "description": "string", "order": 0 } ] } ],"category": { "id": 700627, "code": "CAT_JH", "label": "Ress.", "longLabel": nulldescription": null, "order": -1 }, "type": { "id": 700686, "code": "TYP_RESS_INTERNE", "label": "Interne", "longLabel": nulldescription": null, "order": 0 }, "profile": null} |
Body Sortie | { "id": 899895, "code": "Maeva.cdp", "label": "Maëva CDP", "longLabel": nulldescription": null, "order": -1, "hierarchiesValues": [ { "hierarchy": { "id": 88878, "code": "string", "label": "string", "longLabel": "string", "description": "string", "order": 0 }, "values": [ { "id": 987678, "code": "string", "label": "string", "longLabel": "string", "description": "string", "order": 0 } ] } ],"category": { "id": 700627, "code": "CAT_JH", "label": "Ress.", "longLabel": nulldescription": null, "order": -1 }, "type": { "id": 700686, "code": "TYP_RESS_INTERNE", "label": "Interne", "longLabel": nulldescription": null, "order": 0 }, "profile": null} |
/users/{id} (added in v7.7)
Description | Allows user information to be updated |
Webservice code | /users/{userId} |
Management rules | Droit ACT_MODIFIER_UTILISATEUR Pour modifier des informations concernant un utilisateur
Pour modifier les rôle hiérarchiques, le paramètre du Webservice saveAssignment doit être à true
Le paramètre d’URL {id} correspond à l’identifiant de l’utilisateur.
Champs modifiables
Tous les champs d’une fiche utilisateur sont modifiables hormis Identifiant, Photo de profil, Page d'atterrissage, Utilisateur invité, Mot de passe, Authentification locale possible, Licence, Synchro des calendriers et Abonnements.
hierarchicalRoles : rôles hiérarchiques de l’utilisateur. L’extrait doit comprendre impérativement l’id de la hiérarchie avec l’id de la valeur de niveau associé (values) ainsi que l’id du rôle accordé.
hierarchiesValues : rattachements hiérarchiques de l’utilisateur
ressourceSuivie : rattachement ou non d’une ressource à l’utilisateur. Le code ressource sera basé sur l’identifiant utilisateur.
Avertissement
Il est indispensable de récupérer initialement le flux en appelant au préalable les service de récupération de ressource /monitormaker/user/{id} (où {id} est l’identifiant de l’utilisateur. Chaque clé-valeur d’un utilisateur qui ne sera pas renvoyée dans son état original sera supprimée. |
Example | |
Bean Sortie | Bean User file |
Body Sortie | { "id": "12345", "libelle":"test web service 1","description": "", "index": 188534, "login": "adm","nom": "adm", "prenom": "adm","telephoneBureau": "", "mail": "adm@adm.fr","nomP": "adm a.", "actif": true,"formatCalendrier": "fr_FR", "ressourceSuivie": false,"niveauLicence": null, "idSMM": 1225, "idUP": 155245,"motDePasse": "", "sexe": null,"langue": { "id": 1, "libelle": "Français","description": "","code": "fr", "key": "1" }, "titre": "", "societe": "","telephoneAssistance": "", "telephoneStandard": "","telephoneMobile": "", "adresse1": "", "codePostal1": "","ville1": "", "adresse2": "", "codePostal2": "", "ville2": "","region": "", "parametres": { "pageAccueil":{ "id": -1, "libelle": "", "description": "", "key": "-1" },"filtreProjetParDefaut": { "id": -1, "libelle": "", "description": "", "key": "-1" },"filtreRessourceParDefaut": { "id": -1, "libelle": "","description": "", "key": "-1" } },"dateOuverture": 1516662000000, "dateFermeture": null,"dateFermetureOrigine": null, "alertModifParMail": false,"synchroDatesUP": false, "forceLienRessourceParLibelle": false,"image": null, "abonnements": null, "identifiantLDAP": "","ressource": { "id": -1, "libelle": "", "description": "", "key": "-1" }, "dateDerniereModificationMdp": null,"dateCreation": 1516715245593, "invite": false,"cache": false, "roles":[..]"arbreProfilsHierarchies": null, "hierarchicalRoles": [{"hierarchy": {"id": 700821,"code": "HIER_DIRECTION_METIER","label": "Direction(s) bénéficiaire(s)","longLabel": null,"description":null,"order": 2},"values": [{"id": 701784,"code": "701784","label": "Direction Générale","longLabel": "Direction GénéraleDirection Générale","description": "Direction GénéraleDirection Générale",
"order": -1}],"role": {"id": 701430,"code": "ROL_DIRECTEUR","label": "Directeur","longLabel": null,"description": "Directeur","order": -1}}],"hierarchiesValues": [{
"hierarchy": {"id": 894224,"code": "HIER_INTERNEPARCOURS","label": "INTERNE - Parcours","longLabel": null,"description": null,"order": 99},"values": [{"id": 901449,"code": null,
"label": "English","longLabel": null,"description": null,"order": -1}]}],"abonnementsCharges": false, "profilsProjets": null,"motDePasseGereParMM": true, "userLDAP": false,"ligneRoles": "1 - Administrateur<br/>","libelleLong": "adm adm", "codeObjetType": "UTILISATEUR", "key": "315563" } |
Results | JSON |
5. cURL import method
Presentation
These Webservices can be used to send import or synchronization files. Their syntax is specific and not based on what has been seen previously. The cURL tool is supplied in p-monitor's "install" directory. It calls p-monitor via HTTP and transmits a CSV file to be imported. If the platform is to import data via its HTTP interface, a platform-specific user must exist and have the right rights to execute the import.
Import ID
Identifier | PM rights | Note |
TEST | #NA | This special import is used to test the technical chain. It simply mails the file sent by cURL back to the authenticated user. |
IMPORT_PROJET | #NA | Import via Excel import files (see Import memo for expected file syntax). |
IMPORT_INVOICE | ACT_EXECUTE_SYNCHROFACTURE
Synchronize invoices | |
IMPORT_DEVIS | ACT_EXECUTE_SYNCHRODEVIS
Synchronize quotes | |
IMPORT_TACHE | ACT_CREER_TACHE
Add a task | Import via Excel import files (see Import memo for expected file syntax). |
ACTIVITY_ENTRY | ACT_EXECUTE_SYNCHROACTIVITY
Synchronize timesheet | |
ENTRY_ACTIVITY_RAF | ACT_EXECUTE_SYNCHROACTIVITY
Synchronize timesheet | |
ACTIVITY_ENTRY_RAF_DETAIL | ACT_EXECUTE_SYNCHROACTIVITY
Synchronize timesheet | |
MEASURES_UP | #NA | |
SYNCHROPROJET | ACT_EXECUTE_SYNCHROPROJECT
Synchronize projects | |
SYNCHROENVELOPPE | #NA | |
SYNCHROFINANCIERE (2) | #NA | This import represents the generic import of financial documents: you must specify the type code of the financial document in the query parameter |
SYNCHROAFFECTATION | #NA | |
SYNCHROENGAGEMENT | #NA | |
SYNCHROMANDATTING | #NA | |
SYNCHROBUDGET | #NA | |
ENTRY_PROVISIONAL_REPARTITIONED_BUDGET_1 | #NA | Import of forecast total distributed 1 |
ENTRY_PROVISIONAL_REPARTIED_BUDGET_2 | #NA | Import of forecast total distributed 2 |
ENTRY_PROVISIONAL_REPARED_BUDGET_3 | #NA | Import of forecast total distributed 3 |
New cURL launch method
To launch a cURL import, use the following syntax in a batch : curl -H "Accept:application/json" -H "Authorization: montoken" -silent -F
Accept :application/json | header to connect to Project Monitor |
LOGINUSERPM | Login of the specific user of Project Monitor |
APIKEYSERVEUR | (if authentication by apikey only): server or up api key, configured in administration Project Monitor or in the configuration FILE (*.properties) |
fileSend.txt | name of the file to be sent to p-monitor. This must be in the current directory |
url.de.projectmonitor | The URL of the Project Monitor which is to receive the file. |
IMPORT_ID | import type identifier. See list above. |
Please refer to http://curl.haxx.se/ for more precise use of the cURL tool.
To wait for the end of the command and continue processing in your batch file once the import is complete, use the wait option:
curl -H "Accept:application/json" -H "Authorization: montoken" -silent -F wait=true -F attachment=@fichierAEnvoyer.txt
"http://url.de.projectmonitor/MonitorMakerWeb/api/import/IDENTIFIANT_IMPORT?login=LOGINUSERPM"To find out whether a cURL import is in progress, use the isrunning option:
curl -H "Accept:application/json" -H "Authorization: montoken" -silent -F isrunning=true -F attachment=@fichierAEnvoyer.txt
"http://url.de.projectmonitor/MonitorMakerWeb/api/import/IDENTIFIANT_IMPORT?login=LOGINUSERPM"Warning: if isrunning is passed as a parameter with a value other than "true", the webservice will return a 400 error code.
To specify the type of financial document when importing SYNCHROFINANCIERE, use the mandatory importType option:
curl -H "Accept:application/json" -H "Authorization: montoken" -silent -F attachment=@fichierAEnvoyer.txt
"http://url.de.projectmonitor/MonitorMakerWeb/api/import/SYNCHROFINANCIERE/importType/TYPE_PIECE_FINANC_REALISE?login=LOGINUSERPM"Please note: to correctly interpret the "&" character used to specify the two options in the URL, you must enclose the URL in quotation marks. Otherwise, the request will be launched with the first parameter only.
Please note that an incompatibility has been detected when calling this web service via PowerShell. If this command interface is used, then the Curl process should be called directly and not via the "Invoke-WebRequest" keyword, as in the example below:
The user specified by the login parameter receives an e-mail summarizing the import process.
The http return codes visible to curl are :
200 | OK |
204 | no import in progress (isrunning) |
302 | an import is in progress (isrunning) |
400 | functional error: refer to the e-mail sent OR if isrunning option requested, parameter other than "true". |
401 | user specified by "login" parameter does not exist or password is incorrect |
403 | the user specified by the "login" parameter does not have sufficient rights to launch the import. |
405 | the application server rejects the HTTP method used in the request sent |
500 | a technical error has occurred. Contact your administrator |
503 | command interrupted by a user |