Afin de permettre une bonne interaction entre les différents programmes de votre Système d'Information, des Web Services sont disponibles dans PWM.
Votre licence vous permet, ou non, d'utiliser les web services.
La technologie utilisée est le REST. Les données sont renvoyées en format JSON.
Depuis la version 1.2.1, tous les web services sont accessibles.
Récupérer une clef d'identification
Avant de faire appel à un web service vous devez impérativement récupérer une clef d'authentification.
Un service web est disponible à cet effet sur l'URL :
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/key/[ClefDeDomaine]/[Login]/[MotDePasse]/[DureeDeValidite]
Important Ce service doit être accédé en mode
PUT.
- NomDuServeur : représente le nom du serveur ou son adresse IP
- PortDuServeur : représente le numéro de port du serveur (peut être optionnel en fonction de la configuration)
- ClefDeDomaine : représente la clef du domaine auquel appartient l'utilisateur
- Login : représente la login de l'utilisateur
- MotDePasse : représente le mot de passe de l'utilisateur
- DureeDeValidite : représente le temps pendant lequel la clef d'authentification sera valable en ms
Exemple d'URL (en mode PUT) : https://localhost:8080/pwm/rest/key/1/administrateur/password/600000
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON comme suit :
Vous aurez besoin de la valeur sous la clef key pour faire usage des autres web services, dans cet exemple c'est 151201359.
Web Service Utilisateur
Avant de faire appel à un web service vous devez impérativement récupérer une clef d'authentification (attribut key).
Le service pour la gestion des utilisateurs est disponible sous la racine
/users.
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/users/view/[ClefAuthentification]/[IdUser]
: pour visualiser un utilisateur
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/users/search/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour rechercher des utilisateurs en fonction de critères
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/users/create/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour créer un nouvel utilisateur
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/users/update/[ClefAuthentification]/[IdUser]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour modifier un utilisateur
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/users/forgotpassword/[ClefDomaine]/[login]
: pour recevoir par email les informations de connexion à PWM
- NomDuServeur : représente le nom du serveur ou son adresse IP
- PortDuServeur : représente le numéro de port du serveur (peut être optionnel en fonction de la configuration)
- ClefAuthentification : représente la clef d'authentification obtenue à l'aide du service d'authentification
- ClefDomaine : représente la clef de domaine
- login : représente la login ou l'email de l'utilisateur
- IdUser : représente l'identifiant de l'utilisateur
- clefX : représente le nom d'un paramètre. Pensez à bien respecter les majuscules/minuscules.
- valeurX : représente la valeur du paramètre associé à clefX
Web Service
Utilisateur : Visualiser
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/users/view/[ClefAuthentification]/[IdUser]
Important Ce service doit être accédé en mode
GET.
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/users/view/1975043074/5
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON.
Web Service
Utilisateur : Rechercher
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/users/search/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode GET.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- internalId
- state : 0 pour Ok, 1 pour désactivé, 2 pour supprimé
- sex: 0 pour homme, 1 pour femme
- firstname
- lastname
- email
- phone
- postalcode
- city
- country
- connected : 1 pour uniquement ceux connéctés, 0 pour seulement ceux nons connectés, absent pour les deux
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/users/search/1975043074?sex=1&lastname=bonnet
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service
Utilisateur : créer
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/users/create/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode PUT.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous devez préciser obligatoirement l'ensemble des paramètres (clefs) suivants :
- lastName
- firstName
- login : au moins 6 caractères
- local : la langue (ex: en_US) (Locale)
- email
- sex : 0 pour homme, 1 pour femme
- newPassword : le mot de passe
Vous pouvez compléter avec les paramètres (clefs) suivants :
- address
- dateFormat : le format de la date de naissance (SimpleDateFormat)
- birthDate
- cellularPhone
- city
- country
- office
- phone
- postalCode
- internalId
- isAdmin
- chief_nb : pour indiquer que l'utilisateur sera chef du service ayant comme identifiant nb (ex: chief_5=true)
- member_nb : pour indiquer que l'utilisateur sera membre du service ayant comme identifiant nb (ex: member_3=true)
- cost_nb : pour indiquer que cout de l'utilisateur par défaut dans le service ayant comme identifiant nb (ex: cost_5=3.5)
Exemple d'URL (en mode PUT) :
https://localhost:8080/pwm/rest/users/create/124705338?sex=0&lastName=Bonnet&firstName=François&local=fr_FR&email=fb@totof.fr&newPassword=bonjour33&login=fbonnet
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service
Utilisateur : mettre à jour
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/users/update/[ClefAuthentification]/[UserId]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode PUT.
- Respectez les majuscules et minuscules pour les noms de clefs.
Remarques
- vous ne pourrez pas changer le login ainsi que le fait qu'un utilisateur est administrateur ou non via le web service.
- si vous voulez changer les informations relatives aux rôles qu'a l'utilisateur dans un ou plusieurs services, vous devez modifier le/les services associés.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- lastName
- firstName
- local : la langue (ex: fr_FR) (Locale)
- state : 0 pour Ok, 1 pour désactivé, 2 pour supprimé
- email
- sex : 0 pour homme, 1 pour femme
- newPassword : le nouveau mot de passe
- address
- dateFormat : le format de la date de naissance (SimpleDateFormat)
- birthDate
- cellularPhone
- city
- country
- office
- phone
- postalCode
- internalId
Exemple d'URL (en mode PUT) : https://localhost:8080/pwm/rest/users/update/124705338/131?newPassword=bonjour34
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service
Utilisateur : Récupérer son mot de passe
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/users/forgotpassword/[ClefDomaine]/[login]
Important
- Ce service doit être accédé en mode GET.
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/users/forgotpassword/1/administrator
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service Service
Avant de faire appel à un web service vous devez impérativement récupérer une clef d'authentification.
Le service pour la gestion des services est disponible sous la racine /units l'URL :
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/units/view/[ClefAuthentification]/[IdUnit]
: pour visualiser un service
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/units/search/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour rechercher des service en fonction de critères
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/units/create/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour créer un nouveau service
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/units/update/[ClefAuthentification]/[IdUnit]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour modifier un service
- NomDuServeur : représente le nom du serveur ou son adresse IP
- PortDuServeur : représente le numéro de port du serveur (peut être optionnel en fonction de la configuration)
- ClefAuthentification : représente la clef d'authentification obtenue à l'aide du service d'authentification
- IdUnit : représente l'identifiant du service
- clefX : représente le nom d'un paramètre. Pensez à bien respecter les majuscules/minuscules.
- valeurX : représente la valeur du paramètre associé à clefX
Web Service Service :
Visualiser
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/units/view/[ClefAuthentification]/[IdUnit]
Important Ce service doit être accédé en mode
GET.
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/units/view/124705338/5
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service Service :
Rechercher
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/units/search/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode GET.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- internalId
- state : 0 pour Ok, 1 pour désactivé, 2 pour supprimé
- internalId
- label
- description
- localization
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/units/search/124705338?label=cor
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service Service :
créer
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/units/create/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode PUT.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous devez préciser obligatoirement l'ensemble des paramètres (clefs) suivants :
- label
- chief_nb : un service doit avoir au moins un chef. Ce paramètre permet d'indiquer que l'utilisateur ayant comme identifiant nb sera chef du
service (ex: chief_4=true)
Vous pouvez compléter avec les paramètres (clefs) suivants :
- description
- localization
- internalId
- chief_nb : pour indiquer que l'utilisateur ayant comme identifiant nb sera chef du service (ex: chief_4=true)
- member_nb : pour indiquer que l'utilisateur ayant comme identifiant nb sera membre du service (ex: member_3=true)
- cost_nb : pour indiquer que l'utilisateur ayant comme identifiant nb aura un cout par défaut dans cette unité (ex: cost_3=5.3)
Exemple d'URL (en mode PUT) : https://localhost:8080/pwm/rest/units/create/623649985?label=Service Achat&chief_3=true
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service - Service
: mettre à jour
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/units/update/[ClefAuthentification]/[IdUnit]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode PUT.
- Respectez les majuscules et minuscules pour les noms de clefs.
Remarques
- si vous voulez changer les informations relatives aux rôles vous devrez repréciser l'ensemble des informations et pas uniquement celle que vous voulez
modifier. Toute information absente sera considérée comme à retirer. Si aucune information relative au rôle n'est présente, ils ne seront pas modifiés.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- label
- description
- localization
- state: see IState for values
- internalId
- chief_nb : pour indiquer que l'utilisateur ayant comme identifiant nb sera chef du service (ex: chief_4=true)
- member_nb : pour indiquer que l'utilisateur ayant comme identifiant nb sera membre du service (ex: member_3=true)
- cost_nb : pour indiquer que l'utilisateur ayant comme identifiant nb aura un cout par défaut dans cette unité (ex: cost_3=5.3)
Exemple d'URL (en mode PUT) : https://localhost:8080/pwm/rest/units/update/623649985/40?chief_3=true&cost_3=3.5
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service Projet
Avant de faire appel à un web service vous devez impérativement récupérer une clef d'authentification.
Le service pour la gestion des projets est disponible sous la racine /projects l'URL :
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/view/[ClefAuthentification]/[IdProject]
: pour visualiser un service
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/search/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour rechercher des service en fonction de critères
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/create/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour créer un nouveau service
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/update/[ClefAuthentification]/[IdProjet]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour modifier un service
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/dueBy/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour lister les projets dues
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/assignedTo/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour lister les projets où l'utilisateur a un rôle
- NomDuServeur : représente le nom du serveur ou son adresse IP
- PortDuServeur : représente le numéro de port du serveur (peut être optionnel en fonction de la configuration)
- ClefAuthentification : représente la clef d'authentification obtenue à l'aide du service d'authentification
- IdProjet : représente l'identifiant du projet
- clefX : représente le nom d'un paramètre. Pensez à bien respecter les majuscules/minuscules.
- valeurX : représente la valeur du paramètre associé à clefX
Web Service Projet :
Visualiser
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/view/[ClefAuthentification]/[IdProjet]
Important Ce service doit être accédé en mode
GET.
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/projects/view/1975043074/188
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service Projet :
Rechercher
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/search/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode GET.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- internalId
- state: état du projet
- 0 le projet est disponible. Il n'est pas encore démarré, vous pouvez ajouter des tâches à l'intérieur.
- 1 le projet est désactivé, dans cet état toutes ses tâches sont désactivées.
- 2 le projet est supprimé, il n'existe plus, dans cet état toutes ses tâches sont supprimées.
- 3 le projet est démarré, les tâches qui étaient désactivées passent dans l'état disponible.
- 4 le projet est terminé, il n'y a plus de travail à effectuer dans le projet.
- 5 le projet est en pause, toutes les tâches du projet sont mises en pause.
- 6 le projet est annulé, il ne sera pas à réaliser.
- label
- description
- startDateBegin
- startDateEnd
- endDateBegin
- endDateEnd
- priorityStart
- priorityEnd
- personal: accept,only,reject
- dateFormat : le format pour les dates (SimpleDateFormat)
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/projects/search/1975043074?state=3&personal=reject
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service Projet :
créer
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/create/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode PUT.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous devez préciser obligatoirement l'ensemble des paramètres (clefs) suivants :
- label
- chief_userid_unitid=costvalue : il faut au moins un chef de projet si ce dernier n'est pas personnel
Vous pouvez compléter avec les paramètres (clefs) suivants :
- description
- priority
- internalId
- estimatedTime
- estimatedTimeUnit: 3 pour jours (valeur par defaut), 2 pour heures, 1 pour minutes;
- supposedDateFormat : le format pour les dates (SimpleDateFormat)
- supposedEndDate
- supposedStartDate
- isPersonal : true pour un projet personnel, false pour un projet normal
- sendEvent
- supposedCost
- finalCost
- personalCost: si le projet est personnel
- analyst_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: analyst_4_1=3)
- architect_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: architect_4_1=3)
- chief_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: chief_4_1=3)
- client_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: client_4_1=3)
- developer_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: developer_4_1=3)
- integrator_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: integrator_4_1=3)
Exemple d'URL (en mode PUT) : https://localhost:8080/pwm/rest/projects/create/1873272354?label=Projet Refonte Réseaux v4&chief_2_1=5.3&chief_1_5=8
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service - Projet :
mettre à jour
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/update/[ClefAuthentification]/[ProjectId]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode PUT.
- Respectez les majuscules et minuscules pour les noms de clefs.
Remarques
- vous ne pourrez pas changer le fait qu'un projet est personnel ou non
- si vous voulez changer les informations relatives aux rôles vous devrez repréciser l'ensemble des informations et pas uniquement celle que vous voulez
modifier. Toute information absente sera considérée comme à retirer. Si aucune information relative au rôle n'est présente, ils ne seront pas modifiés.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- label
- description
- priority
- internalId
- estimatedTime
- estimatedTimeUnit: 3 pour jours (valeur par defaut), 2 pour heures, 1 pour minutes;
- supposedDateFormat : le format pour les dates (SimpleDateFormat)
- supposedEndDate
- supposedStartDate
- sendEvent
- supposedCost
- finalCost
- comment: un nouveau commentaire
- personalCost: si le projet est personnel
- analyst_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: analyst_4_1=3)
- architect_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: architect_4_1=3)
- chief_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: chief_4_1=3)
- client_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: client_4_1=3)
- developer_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: developer_4_1=3)
- integrator_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: integrator_4_1=3)
- author_userid_unitid=costvalue : Dans le cas où le projet n'est pas personnel, indique que l'utilisateur ayant comme identifiant userid
associé au service unitid aura le role associé et le cout indiqué (ex: author_4_1=3)
- state: état du projet
- 0 le projet est disponible. Il n'est pas encore démarré, vous pouvez ajouter des tâches à l'intérieur.
- 1 le projet est désactivé, dans cet état toutes ses tâches sont désactivées.
- 2 le projet est supprimé, il n'existe plus, dans cet état toutes ses tâches sont supprimées.
- 3 le projet est démarré, les tâches qui étaient désactivées passent dans l'état disponible.
- 4 le projet est terminé, il n'y a plus de travail à effectuer dans le projet.
- 5 le projet est en pause, toutes les tâches du projet sont mises en pause.
- 6 le projet est annulé, il ne sera pas à réaliser.
Exemple d'URL (en mode PUT) : https://localhost:8080/pwm/rest/projects/update/1873272354/257?state=3
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service - Projets
: dues
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/dueBy/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode GET.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- states: une liste d'états ex: 0 ou 0,1,2,3
- before: un nombre entier, 7 par défaut
- after: un nombre entier, 7 par défaut
- unit: une unité de temps, 3 pour jours (valeur par defaut), 2 pour heures, 1 pour minutes
- personal:
- null/absent :prendra les deux.
- true : ne prendra que les projets personnelles.
- false : ne prendra que les projets nons personnelles.
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/projects/dueBy/418664024?states=0,1,3
En cas de succès, le code HTTP sera 200 et la réponse sera une liste de projets au format JSON.
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service - Projets
: où l'on a un rôle
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/projects/assignedTo/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode GET.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- states: une liste d'états ex: 0 ou 0,1,2,3
- supposedStartDateStart
- supposedStartDateEnd
- supposedEndDateStart
- supposedEndDateEnd
- dateFormat : le format des dates (SimpleDateFormat)
- personal:
- null/absent :prendra les deux.
- true : ne prendra que les projets personnelles.
- false : ne prendra que les projets nons personnelles.
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/projects/assignedTo/418664024?states=0,3
En cas de succès, le code HTTP sera 200 et la réponse sera une liste de tâches au format JSON.
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service Tâche
Avant de faire appel à un web service vous devez impérativement récupérer une clef d'authentification.
Le service pour la gestion des tâches est disponible sous la racine /tasks l'URL :
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/view/[ClefAuthentification]/[IdTache]
: pour visualiser un service
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/search/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour rechercher des service en fonction de critères
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/create/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour créer un nouveau service
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/update/[ClefAuthentification]/[IdTache]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour modifier un service
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/dueBy/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour lister les tâches dues
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/assignedTo/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
: pour lister les tâches assignées à l'utilisateur
- NomDuServeur : représente le nom du serveur ou son adresse IP
- PortDuServeur : représente le numéro de port du serveur (peut être optionnel en fonction de la configuration)
- ClefAuthentification : représente la clef d'authentification obtenue à l'aide du service d'authentification
- IdTache : représente l'identifiant de la tâche
- clefX : représente le nom d'un paramètre. Pensez à bien respecter les majuscules/minuscules.
- valeurX : représente la valeur du paramètre associé à clefX
Web Service Tâche :
Visualiser
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/view/[ClefAuthentification]/[IdTache]
Important Ce service doit être accédé en mode
GET.
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/tasks/view/190772752/5
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service Tâche :
Rechercher
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/search/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode GET.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- state : l'état de la tâche
- 0 la tâche est disponible. Personne ne l'a démarrée, elle est toute nouvelle.
- 1 la tâche est désactivée (Etat par défaut quand le projet n'est pas encore démarré).
- 2 la tâche est supprimée, elle n'existe plus, dans cet état elle ne sera pas visible sur l'affichage Gantt du projet.
- 3 la tâche est démarrée, quelqu'un est en train de travailler dessus.
- 4 la tâche est terminée, il n'y a plus de travail à effectuer sur cette tâche.
- 5 la tâche est en pause, vous pouvez modifier son état d'avancement et son temps écoulé.
- 6 la tâche est annulée, elle ne sera pas à réaliser.
- label
- description
- priorityStart
- priorityEnd
- authorId
- assignedId
- projectId
- personal: accept,only,reject
- type
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/tasks/search/188688276?state=1&personal=reject
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service Tâche :
créer
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/create/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode PUT.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous devez préciser obligatoirement l'ensemble des paramètres (clefs) suivants :
- label
- authorId
- assignedToId
- projectId
- supposedEndDate
- supposedStartDate
Vous pouvez compléter avec les paramètres (clefs) suivants :
- motherTaskId
- completion
- description
- priority
- internalId
- estimatedTime
- supposedDateFormat : le format des dates (SimpleDateFormat)
- isPersonal
- type
- sendEvent
- supposedCost
- finalCost
Exemple d'URL (en mode PUT) : https://localhost:8080/pwm/rest/tasks/create/188688276?label=Exemple de
tache&projectId=1&assignedId=1&authorId=1&supposedStartDate=20/01/2015&supposedEndDate=10/03/2015&supposedDateFormat=dd/MM/yyyy
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service - Tâche :
mettre à jour
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/update/[ClefAuthentification]/[IdTache]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode PUT.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- assignedToId
- projectId
- motherTaskId
- completion
- description
- label
- priority
- state : l'état de la tâche
- 0 la tâche est disponible. Personne ne l'a démarrée, elle est toute nouvelle.
- 1 la tâche est désactivée (Etat par défaut quand le projet n'est pas encore démarré).
- 2 la tâche est supprimée, elle n'existe plus, dans cet état elle ne sera pas visible sur l'affichage Gantt du projet.
- 3 la tâche est démarrée, quelqu'un est en train de travailler dessus.
- 4 la tâche est terminée, il n'y a plus de travail à effectuer sur cette tâche.
- 5 la tâche est en pause, vous pouvez modifier son état d'avancement et son temps écoulé.
- 6 la tâche est annulée, elle ne sera pas à réaliser.
- internalId
- estimatedTime
- supposedDateFormat : le format des dates (SimpleDateFormat)
- supposedEndDate
- supposedStartDate
- isPersonal
- type
- sendEvent
- supposedCost
- finalCost
- comment: un commentaire supplémentaire
- timeLineMap: le temps par utilisateur et par jour
Exemple d'URL (en mode PUT) : https://localhost:8080/pwm/rest/tasks/update/418664024/687?state=3&completion=20
En cas de succès, le code HTTP sera 200 et la réponse sera au format JSON comme suit :
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service - Tâche :
dues
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/dueBy/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode GET.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- states: une liste d'états ex: 0 ou 0,1,2,3
- before: un nombre entier, 7 par défaut
- after: un nombre entier, 7 par défaut
- unit: une unité de temps, 3 pour jours (valeur par defaut), 2 pour heures, 1 pour minutes
- personal:
- null/absent :prendra les deux.
- true : ne prendra que les taches personnelles.
- false : ne prendra que les taches nons personnelles.
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/tasks/dueBy/418664024?states=0,1,3
En cas de succès, le code HTTP sera 200 et la réponse sera une liste de tâches au format JSON.
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.
Web Service - Tâches :
assignées
https://[NomDuServeur]:[PortDuServeur]/pwm/rest/tasks/assignedTo/[ClefAuthentification]?clef1=valeur1&clef2=valeur2&clefn=valeurn
Important
- Ce service doit être accédé en mode GET.
- Respectez les majuscules et minuscules pour les noms de clefs.
Vous pouvez utiliser l'ensemble des paramètres (clefs) suivants :
- states: une liste d'états ex: 0 ou 0,1,2,3
- supposedStartDateStart
- supposedStartDateEnd
- supposedEndDateStart
- supposedEndDateEnd
- dateFormat : le format des dates (SimpleDateFormat)
- personal:
- null/absent :prendra les deux.
- true : ne prendra que les taches personnelles.
- false : ne prendra que les taches nons personnelles.
Exemple d'URL (en mode GET) : https://localhost:8080/pwm/rest/tasks/assignedTo/418664024?states=0,3
En cas de succès, le code HTTP sera 200 et la réponse sera une liste de tâches au format JSON.
En cas de d'erreur, le code HTTP sera 303 et la réponse sera au format JSON standard.