inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-24 17:32:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Web Scripts:

Browse Source 
- addition of extension paths for web script customisations
- updated "delete ticket" web script to return appropriate response on success

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5867 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
David Caruana
2007-06-06 11:57:42 +00:00
parent 6cadd8573a
commit c7fddafa1e
7 changed files with 60 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
config/alfresco/bootstrap/webscripts/readme.html
View File

@@ -1 +1 @@
<h1>Web Scripts &nbsp;</h1><p>Documentation on how to develop a Web Script may be found <a href="http://wiki.alfresco.com/wiki/Web_Scripts">here</a>. </p><p>Web Scripts allow you to bind new Alfresco-based functionality to a HTTP method and custom URL. A library of URLs may be built up to provide a complete API accessible via HTTP.&nbsp; They are ideal for building data access &amp; update APIs and simple UI components such as Portlets.&nbsp; Development of Web Scripts may be performed within Alfresco.&nbsp; Knowledge of Java is <em><strong>not</strong></em> required.<br /> </p><p>For example, you could create the following API for your particular application... </p> <dl><dt><strong>Execute a search</strong> </dt></dl> <p>GET http://&lt;host&gt;:&lt;port&gt;/alfresco/service/blog/category?c=Web20 </p> <dl><dt><strong>Retrieve meta-data for an item in the repository</strong> </dt></dl> <p>GET http://&lt;host&gt;:&lt;port&gt;/alfresco/service/blog/2007/03/04/new-release </p> <dl><dt><strong>Update meta-data for an item in the repository</strong> </dt></dl> <p>POST http://&lt;host&gt;:&lt;port&gt;/alfresco/service/blog/2007/03/04/new-release?status=Draft </p> <dl><dt><strong>Delete an item in the repository</strong> </dt></dl> <p>DELETE http://&lt;host&gt;:&lt;port&gt;/alfresco/service/blog/2007/03/04/new-release </p>
<h1>Web Scripts</h1><p>Documentation on how to develop a Web Script may be found <a href="http://wiki.alfresco.com/wiki/Web_Scripts">here</a>. </p><p>Web Scripts allow you to bind new Alfresco-based functionality to a HTTP method and custom URL. A library of URLs may be built up to provide a complete API accessible via HTTP.&nbsp; They are ideal for building data access &amp; update APIs and simple UI components such as Portlets.&nbsp; Development of Web Scripts may be performed within Alfresco.&nbsp; Knowledge of Java is <em><strong>not</strong></em> required.<br /> </p><p>For example, you could create the following API for your particular application... </p> <dl><dt><strong>Execute a search</strong> </dt></dl> <p>GET http://&lt;host&gt;:&lt;port&gt;/alfresco/service/blog/category?c=Web20 </p> <dl><dt><strong>Retrieve meta-data for an item in the repository</strong> </dt></dl> <p>GET http://&lt;host&gt;:&lt;port&gt;/alfresco/service/blog/2007/03/04/new-release </p> <dl><dt><strong>Update meta-data for an item in the repository</strong> </dt></dl> <p>POST http://&lt;host&gt;:&lt;port&gt;/alfresco/service/blog/2007/03/04/new-release?status=Draft </p> <dl><dt><strong>Delete an item in the repository</strong> </dt></dl> <p>DELETE http://&lt;host&gt;:&lt;port&gt;/alfresco/service/blog/2007/03/04/new-release </p>

1
config/alfresco/bootstrap/webscripts/readmeExtension.html Normal file
View File

@@ -0,0 +1 @@
<h1>How to Customize a Web Script</h1><p>Documentation on how to develop a Web Script may be found <a href="http://wiki.alfresco.com/wiki/Web_Scripts">here</a>.</p><p>Any part of a Web Script (i.e. its description, &quot;execute&quot; javascript, or &quot;response&quot; template) may be overridden.&nbsp;&nbsp; This is achieved by copying the original part to this extension folder.&nbsp; The folder within which the part lives must be replicated in this extension area too.<br /></p><p>e.g. to override the html output of the &quot;Keyword search&quot; script...</p><p>copy</p><p><em>/Data Dictionary/Web Scripts/org/alfresco/repository/keywordsearch.get.html.ftl </em><br /></p><p>to</p><p><em>/Data Dictionary/Web Scripts Extensions/org/alfresco/repository/keywordsearch.get.html.ftl </em><br /> </p><p>Once copied, you can make your changes to the copy.</p><p>To ensure your override is registered, go to <a href="/alfresco/service/">/alfresco/service/</a> and click on the &quot;Refresh List of Web Scripts&quot; button.&nbsp; The next invocation of the web script will include your override.<br /> </p>