diff --git a/scripts/rest-clients/README b/scripts/rest-clients/README index cd318fe3f..d8823e972 100644 --- a/scripts/rest-clients/README +++ b/scripts/rest-clients/README @@ -5,7 +5,7 @@ Web Services :Author: Manuel Rego Casasnovas :Contact: rego@igalia.com -:Date: 28/06/2011 +:Date: 27/08/2012 :Copyright: Some rights reserved. This document is distributed under the Creative Commons Attribution-ShareAlike 3.0 licence, available in @@ -93,6 +93,8 @@ permissions for web services of LibrePlan. Default credentials are: LibrePlan web services use `HTTP Basic Authentication`_ +.. _`HTTP Basic Authentication`: http://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA + Common parameters ----------------- @@ -147,10 +149,10 @@ read credentials for web services: ``/ws/rest//?_wadl&_type=xml`` Export scripts -------------- -There several scripts to just get information from LibrePlan system. They always -start with ``export-`` prefix. These scripts usually don't need any parameter -(apart from the one to select the environment). They will return a XML output -with the data requested. +There are several scripts to just get information from LibrePlan system. They +alway start with ``export-`` prefix. These scripts usually don't need any +parameter (apart from the one to select the environment). They will return a XML +output with the data requested. Example:: @@ -177,9 +179,6 @@ Example:: $ ./import-resources.sh resources-sample.xml -.. _`HTTP Basic Authentication`: http://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA - - Available web services ---------------------- @@ -206,6 +205,15 @@ For each entity there are the following methods: * No parameters * URL: ``/ws/rest//`` +* Remove entity (only available for work reports): + + * HTTP method: ``DELETE`` + * Parameter: ``entity-code`` + * URL: ``/ws/rest/workreports//`` + + * Special URL for work report lines: + ``/ws/rest/workreports/line//`` + Supported entities: * Exception Days: