Appendix A. RESTful API Reference

This document displays list of available Web Scripts of this project. Web Scripts are grouped in the heirachy of Package, Resource and Web Script.

Within each package, web Scripts that don't belong to any resource will be placed under the default 'Others' resource.

This project has total 15 web scripts.

A.1. Package Webscript Core

Package /org/springframework/extensions/webscripts

Core webscripts for index page, js debugger, installation etc.

A.1.1. Resource Index

Index related webscripts.

A.1.1.1. Web Script Web Scripts Home

Web Scripts Home

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/index.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/index.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /index

  • Life Cycle : internal

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.1.2. Web Script Web Script Maintenance

Maintain index of Web Scripts

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/index.post

  • Kind : undefined

  • Method : POST

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/index.post.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /index?reset={reset?}
    • /?reset={reset?}

  • Life Cycle : internal

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.1.3. Web Script All Web Scripts Index

Retrieve an index of all Web Scripts

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/indexall.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/indexall.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /index/all?package={package?}&url={url?}&family={family?}
    • /index/all.mediawiki?package={package?}&url={url?}&family={family?}

  • Life Cycle : internal

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.1.4. Web Script Failed Web Scripts Index

Retrieve an index of all failed Web Scripts

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/indexfailures.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/indexfailures.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /index/failures

  • Life Cycle : internal

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.1.5. Web Script Web Script Family Index

Provide an index of Web Scripts for the specified family

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/indexfamily.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/indexfamily.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /index/family/{family}

  • Life Cycle : internal

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.1.6. Web Script Web Script Lifecycle Index

Provide an index of Web Scripts in the various lifecycle states
  
none   : This web script is not part of a lifecycle.
sample : This web script is a sample and is not intended for production use.
draft  : This method may be incomplete, experimental or still subject to change.
public_api : This method is part of the Alfresco public api and should be stable and well tested.
draft_public_api : This method is intended to eventually become part of the public api but is 
                   incomplete or still subject to change.
deprecated : This method should be avoided.  It may be removed in future versions of Alfresco.
internal   : This script is for Alfresco use only. This script should not be relied upon between 
             versions.It is likely to change.

  

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/indexlifecycle.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/indexlifecycle.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /index/lifecycle/{lifecycle}

  • Life Cycle : internal

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.1.7. Web Script Web Script Package Index

Provide an index of Web Scripts for the specified Web Script package

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/indexpackage.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/indexpackage.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /index/package/{package}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.1.8. Web Script Web Script URI Index

Provide an index of Web Scripts for the specified Web Script URI

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/indexuri.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/indexuri.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : html

  • URLs

    • /index/uri/{uri}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.2. Resource Javascript Debugger

Webscripts for managing Javascript Debugger.

A.1.2.1. Web Script Javascript Debugger

Javascript Debugger

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/jsdebugger.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/jsdebugger.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /api/javascript/debugger

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.2.2. Web Script Javascript Debugger Maintenance

Javascript Debugger Maintenance

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/jsdebugger.post

  • Kind : undefined

  • Method : POST

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/jsdebugger.post.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /api/javascript/debugger?active={active?}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.3. Resource Tools

Tools for Webscript inspection, display, installation etc.

A.1.3.1. Web Script Web Script Description

Retrieve description document for identified Web Script

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/scriptdescription.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/scriptdescription.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : html

  • URLs

    • /description/{serviceId}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.3.2. Web Script Display Web Script

Full inspection of Web Script implementation - useful for diagnostics and download/upload

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/scriptdump.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/scriptdump.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : html

  • URLs

    • /script/{serviceId}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.3.3. Web Script Web Script Installer Form

Web Script Installer Form

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/scriptinstall.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/scriptinstall.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /installer

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.3.4. Web Script Install Web Script

Install Web Script

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/scriptinstall.post

  • Kind : undefined

  • Method : POST

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/scriptinstall.post.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /installer

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

A.1.4. Resource Others

This is the resource for all Web Scripts which don't belong to any resouce.

A.1.4.1. Web Script Web Script Package Documentation

Provides reference documentation for the specified Web Script package

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/webscripts/indexpackagedoc.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/webscripts

  • Store Path : classpath:webscripts

  • Authentication : admin

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : required

  • Buffer Size : 4096

  • Transaction Required : required

  • Transaction Capability : readwrite

  • Web Script Descriptor : org/springframework/extensions/webscripts/indexpackagedoc.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /index/package/{package}/doc

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

Prev Home Next
Part II. Appendices Sponsored by SpringSource  Appendix B. JavaScript Root Object Reference