Lutece workflow rest module

Utilisation

JSP de test

Il existe une JSP permettant de faire des tests sur le module-workflow-rest. Elle est accessible par l'URL suivante :

jsp/admin/plugins/workflow/modules/rest/TestWorkflowRest.jsp

Note : Pour accéder à cette JSP, il faut être authentifié dans le Back-Office. Il faut également commenter dans le fichier workflow-rest.xml les filtres de façon à ce qu'il n'utilise pas la sécurité, sinon une réponse HTTP 401 sera renvoyée.

Syntaxe des URLs pour les workflows

Récupérer les informations d'un ou plusieurs workflows au format XML ou JSON

Syntaxe XML :

Pour obtenir tous les workflows :

http://myhost/mywebapp/rest/workflow
ou
http://myhost/mywebapp/rest/workflow.xml

Pour obtenir un workflow :

http://myhost/mywebapp/rest/workflow/{id_workflow}
ou
http://myhost/mywebapp/rest/workflow/{id_workflow}.xml

Syntaxe JSON :

Pour obtenir tous les workflows :

http://myhost/mywebapp/rest/workflow.json

Pour obtenir un workflow :

http://myhost/mywebapp/rest/workflow/{id_workflow}.json

Syntaxe des URLs pour les états

Récupérer les informations d'un ou plusieurs états au format XML ou JSON

Syntaxe XML :

Pour obtenir tous les états :

http://myhost/mywebapp/rest/workflow/state
ou
http://myhost/mywebapp/rest/workflow/state.xml

Pour obtenir un états :

http://myhost/mywebapp/rest/workflow/state/{id_state}
ou
http://myhost/mywebapp/rest/workflow/state/{id_state}.xml

Syntaxe JSON :

Pour obtenir tous les états :

http://myhost/mywebapp/rest/workflow/state.json

Pour obtenir un états :

http://myhost/mywebapp/rest/workflow/state/{id_state}.json

Syntaxe des URLs pour les actions

Récupérer les informations d'une ou plusieurs actions au format XML ou JSON

Syntaxe XML :

Pour obtenir tous les actions :

http://myhost/mywebapp/rest/workflow/action
ou
http://myhost/mywebapp/rest/workflow/action.xml

Pour obtenir une action :

http://myhost/mywebapp/rest/workflow/action/{id_action}
ou
http://myhost/mywebapp/rest/workflow/action/{id_action}.xml

Syntaxe JSON :

Pour obtenir toutes les actions :

http://myhost/mywebapp/rest/workflow/action.json

Pour obtenir une action :

http://myhost/mywebapp/rest/workflow/action/{id_action}.json

Exécuter une action de workflow

Pour exécuter une action de workflow, il faut faire un formulaire de type POST, et avoir les paramètres suivants :

Nom du paramètre	Type du paramètre	Description du paramètre
id_action	entier	Correspond à l'ID de l'action (obligatoire)
id_resource	entier	Correspond à l'ID de la ressource (obligatoire)
resource_type	texte	Correspond au type de ressource (obligatoire)

Pour obtenir une réponse en XML :

http://myhost/mywebapps/rest/workflow/action/do

Pour obtenir une réponse en JSON :

http://myhost/mywebapps/rest/workflow/action/do.json

Syntaxe des URLs pour les ressources

Récupérer les informations d'une ressource au format XML ou JSON

Syntaxe XML :

Pour obtenir une ressource :

http://myhost/mywebapp/rest/workflow/resource_workflow/{id_workflow}/{resource_type}/{id_resource}
ou
http://myhost/mywebapp/rest/workflow/resource_workflow/{id_workflow}/{resource_type}/{id_resource}.xml

Syntaxe JSON :

Pour obtenir une ressource :

http://myhost/mywebapp/rest/workflow/resource_workflow/{id_workflow}/{resource_type}/{id_resource}.json