Web Script: org/alfresco/indexall.get

Generated from /share/service/script/org/alfresco/indexall.get on Jun 13, 2026 9:39:10 PM

Script Properties
Id:	org/alfresco/indexall.get
Short Name:	All Web Scripts Index
Description:	Retrieve an index of all Web Scripts
Authentication:	none
Transaction:	none
Method:	GET
URL Template:	/index/all?package={package?}&url={url?}&family={family?}
URL Template:	/index/all.mediawiki?package={package?}&url={url?}&family={family?}
Format Style:	any
Default Format:	html
Negotiated Formats:	[undefined]
Implementation:	class org.alfresco.web.scripts.bean.IndexAll
Extensions:	[undefined]

Store: classpath:alfresco/site-webscripts

[No implementation files]

Store: classpath:alfresco/webscripts

File: org/alfresco/indexall.get.desc.xml

<webscript>
  <shortname>All Web Scripts Index</shortname>
  <description>Retrieve an index of all Web Scripts</description>
  <url>/index/all?package={package?}&amp;url={url?}&amp;family={family?}</url>
  <url>/index/all.mediawiki?package={package?}&amp;url={url?}&amp;family={family?}</url>
  <lifecycle>internal</lifecycle>
</webscript>

File: org/alfresco/indexall.get.html.ftl

<#import "/org/alfresco/webscripts.lib.html.ftl" as wsLib/>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
   <@wsLib.head>Index of All Web Scripts</@wsLib.head>
   <body>
      <div>
         <@wsLib.indexheader>Index of All Web Scripts</@wsLib.indexheader>
         <br/>
         <@wsLib.home/>
         <br/>
         <#macro recursepackage package>
            <#if package.scripts?size &gt; 0>
            <span class="mainSubTitle">Package: <a href="${url.serviceContext}/index/package${package.path}">${package.path}</a></span>
            <br/><br/>
            <#list package.scripts as webscript>
            <#assign desc = webscript.description>
            <span class="mainSubTitle">${desc.shortName}</span>
            <table>
               <#list desc.URIs as uri>
               <tr><td><a href="${url.serviceContext}${uri?html}">${desc.method?html} ${url.serviceContext}${uri?html}</a></td></tr>
               </#list>
            </table>
            <#if desc.description??>
            <table>
               <tr><td>---</td></tr>
               <tr><td>${desc.description}</td></tr>
               <tr><td>---</td></tr>
            </table>
            </#if>
            <table>
               <tr><td>Authentication:</td><td>${desc.requiredAuthentication}</td></tr>
               <tr><td>Transaction:</td><td>${desc.requiredTransaction}</td></tr>
               <tr><td>Format Style:</td><td>${desc.formatStyle}</td></tr>
               <tr><td>Default Format:</td><td>${desc.defaultFormat!"<i>Determined at run-time</i>"}</td></tr>
      	<#if desc.lifecycle != 'none'>
      	    <tr><td>Lifecycle:</td><td>${desc.lifecycle}</td></tr>
        </#if>
               <tr><td></td></tr>
               <tr><td>Id:</td><td><a href="${url.serviceContext}/script/${desc.id}">${desc.id}</a></td></tr>
               <tr><td>Descriptor:</td><td><a href="${url.serviceContext}/description/${desc.id}">${desc.storePath}/${desc.descPath}</a></td></tr>
            </table>
            <br/>
            </#list>
            </#if>
            <#list package.children as childpath>
            <@recursepackage package=childpath/>
            </#list>  
         </#macro>
         
         <@recursepackage package=rootpackage/>
      </div>
   </body>
</html>

File: org/alfresco/indexall.get.mediawiki.ftl

Back to [[Alfresco Labs 3]].


= Introduction =

Welcome to the reference documentation for the Alfresco Repository <#if description??>${description} </#if>[[RESTful API]] - ${server.edition} v${server.version}.

This document was generated on ${date?datetime} via the Alfresco Repository URI...

 <nowiki>http://</nowiki><host>:<port>${url.full?html}

'''NOTE: This document is under construction and the APIs are subject to change while still in Labs Beta.'''


= Web Script Reference =

This section provides reference information for each [[Web Scripts|Web Script]], organized by Web Script Package. 

Documentation for each Web Script includes:

* Short Name
* Description
* Available URI templates
* Default [[Web Scripts Framework#HTTP Response Formats|response format]]
* How to specify an alternative response
* Authentication requirements
* Transaction requirements
* Location of Web Script description document

<#macro recursepackage package>
<#if package.scripts?size &gt; 0>
== Package: ${package.path} ==
<#list package.scripts as webscript>
<#assign desc = webscript.description>

=== ${desc.shortName} ===

<#if desc.description??><#if desc.description?ends_with(".")>${desc.description}<#else>${desc.description}.</#if><#else><i>[No description supplied]</i></#if>

<#list desc.URIs as uri>
 [http://localhost:8080${url.serviceContext}${uri} ${desc.method} ${url.serviceContext}${uri}]
</#list>

Requirements:
* Default Format: ${desc.defaultFormat!"<i>Determined at run-time</i>"}
* Authentication: ${desc.requiredAuthentication}
* Transaction: ${desc.requiredTransaction}
* Format Style: ${desc.formatStyle}

Definition:
* Id: ${desc.id}
* Description: ${desc.storePath}/${desc.descPath}
</#list>
</#if>
<#list package.children as childpath>
  <@recursepackage package=childpath/>
</#list>
</#macro>
    
<@recursepackage package=rootpackage/>

[[Category:3.0]]