Appendix B. 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 34 web scripts.

B.1. Package Webscript Global

Package /org/springframework/extensions

Global Webscripts.

B.1.1. Resource Webscript Message

Webscripts for managing Spring webscript messages.

B.1.1.1. Web Script Global messages bundle

Web Scripts global messages bundle as a JavaScript response

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/messages.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : none

  • Buffer Size : 4096

  • Transaction Required : none

  • Transaction Capability : readwrite

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

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /messages?locale={locale}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.1.2. Resource Others

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

B.1.2.1. Web Script Global messages bundle

Web Scripts global messages bundle as a JavaScript response

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/messages.post

  • Kind : undefined

  • Method : POST

  • Run As : undefined

  • Script Path : org/springframework/extensions

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • Cache Public : false

  • Cache Must Validate : true

  • Never Cache : true

  • Transaction : none

  • Buffer Size : 4096

  • Transaction Required : none

  • Transaction Capability : readwrite

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

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /messages?locale={locale}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.2. Package Spring Surf Core

Package /org/springframework/extensions/surf

Spring Surf Core Webscripts.

B.2.1. Resource Web Framework

Webscripts for Spring Surf Web Framework console and maintenance.

B.2.1.1. Web Script Web Framework Console

Web Framework Console

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/console.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf

  • Store Path : classpath:surf/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/surf/console.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /console

  • Life Cycle : internal

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.2.1.2. Web Script Web Framework Maintenance

Web Framework Maintenance

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/console.post

  • Kind : undefined

  • Method : POST

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf

  • Store Path : classpath:surf/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/surf/console.post.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : any

  • Default Format : html

  • URLs

    • /console?reset={reset?}

  • Life Cycle : internal

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.2.2. Resource Surf Object

Webscripts for Spring Surf Object CRUD operations.

B.2.2.1. Web Script Surf API - Delete an object

Surf API - Delete an object

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/object.delete

  • Kind : undefined

  • Method : DELETE

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/object.delete.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/object/{type}/{id}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.2.2.2. Web Script Surf API - Get an object

Surf API - Get an object

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/object.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/object.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/object/{type}/{id}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.2.2.3. Web Script Surf API - Create an object

Surf API - Create an object

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/object.post

  • Kind : undefined

  • Method : POST

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/object.post.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/object/{type}?id={id?}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.2.2.4. Web Script Surf API - Update an object

Surf API - Update an object

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/object.put

  • Kind : undefined

  • Method : PUT

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/object.put.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/object/{type}/{id}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.2.2.5. Web Script Surf API - Retrieve list of objects

Surf API - Retrieve list of objects

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/objects.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/objects.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/objects/{type}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.3. Package Spring Surf Client

Package /org/springframework/extensions/surf/client

Spring Surf Client Webscripts.

B.3.1. Resource Client

Spring Surf Client Webscripts.

B.3.1.1. Web Script Surf - Client JS API

Surf - Client JS API

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/client/client.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf/client

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/client/client.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : html

  • URLs

    • /surf/js

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.4. Package Spring Surf Format

Package /org/springframework/extensions/surf/format

Spring Surf Format Webscripts.

B.4.1. Resource Format

Spring Surf Format Webscripts.

B.4.1.1. Web Script Surf API - list of configured formats

Surf API - list of configured formats

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/format/formats.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf/format

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/format/formats.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : html

  • URLs

    • /api/surf/formats

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.5. Package Spring Surf Model Content

Package /org/springframework/extensions/surf/model/content

Spring Surf Model Content related Webscripts.

B.5.1. Resource Content Association

Webscripts for managing Spring Surf content association.

B.5.1.1. Web Script Surf API - removes a content association

Surf API - removes a content association

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/model/content/association.delete

  • Kind : undefined

  • Method : DELETE

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf/model/content

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/model/content/association.delete.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/content/type/{type}/association?dest={dest}&assocType={assocType?}&f={format?}
    • /api/surf/content/instance/{id}/association?dest={dest}&assocType={assocType?}&f={format?}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.5.1.2. Web Script Surf API - Adds a content association

Surf API - Adds a content association

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/model/content/association.post

  • Kind : undefined

  • Method : POST

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf/model/content

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/model/content/association.post.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/content/type/{type}/association?dest={dest}&assocType={assocType?}&f={format?}
    • /api/surf/content/instance/{id}/association?dest={dest}&assocType={assocType?}&f={format?}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.5.2. Resource Others

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

B.5.2.1. Web Script Surf API - Retrieves Content Associations

Surf API - Retrieves Content Associations

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/model/content/associations.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf/model/content

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/model/content/associations.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/content/associations?dest={dest?}&assocType={assocType?}&f={format?}
    • /api/surf/content/type/associations?dest={dest?}&assocType={assocType?}&f={format?}
    • /api/surf/content/type/{type}/associations?dest={dest?}&assocType={assocType?}&f={format?}
    • /api/surf/content/instance/associations?dest={dest?}&assocType={assocType?}&f={format?}
    • /api/surf/content/instance/{id}/associations?dest={dest?}&assocType={assocType?}&f={format?}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.6. Package Spring Surf Model Page

Package /org/springframework/extensions/surf/model/page

Spring Surf Model Page related Webscripts.

B.6.1. Resource Page Template

Webscripts for managing Spring Surf page templates.

B.6.1.1. Web Script Surf API - Removes a page's template association

Surf API - Removes a page's template association

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/model/page/template.delete

  • Kind : undefined

  • Method : DELETE

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf/model/page

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/model/page/template.delete.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/page/{id}/template?format={formatId?}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.6.1.2. Web Script Surf API - Adds a page to template association

Surf API - Adds a page to template association

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/model/page/template.post

  • Kind : undefined

  • Method : POST

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf/model/page

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/model/page/template.post.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/page/{id}/template/{templateId}?f={formatId?}

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.6.1.3. Web Script Surf API - Retrieves Page Templates

Surf API - Retrieves Page Templates

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/model/page/templates.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf/model/page

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/model/page/templates.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : html

  • URLs

    • /api/surf/page/{id}/templates

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.7. Package Spring Surf Model Site

Package /org/springframework/extensions/surf/model/site

Spring Surf Model Site related Webscripts.

B.7.1. Resource Site Configuration

Webscripts for managing Spring Surf site configuration.

B.7.1.1. Web Script Surf API - Retrieves Site Configuration

Surf API - Retrieves Site Configuration

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/model/site/configuration.get

  • Kind : undefined

  • Method : GET

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf/model/site

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/model/site/configuration.get.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/site/config

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.7.1.2. Web Script Surf API - Updates Site Configuration

Surf API - Updates Site Configuration

The Web script description document specifies the following options:

  • Id : org/springframework/extensions/surf/model/site/configuration.put

  • Kind : undefined

  • Method : PUT

  • Run As : undefined

  • Script Path : org/springframework/extensions/surf/model/site

  • Store Path : classpath:surf/webscripts

  • Authentication : none

  • 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/surf/model/site/configuration.put.desc.xml

  • Extensions : undefined

  • Familys : none

  • Format Style : argument

  • Default Format : json

  • URLs

    • /api/surf/site/config

  • Life Cycle : none

  • Multipart Processing : true

  • Negotiated Formats : undefined

B.8. Package Webscript Core

Package /org/springframework/extensions/webscripts

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

B.8.1. Resource Index

Index related webscripts.

B.8.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

B.8.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

B.8.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

B.8.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

B.8.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

B.8.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

B.8.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

B.8.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

B.8.2. Resource Javascript Debugger

Webscripts for managing Javascript Debugger.

B.8.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

B.8.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

B.8.3. Resource Tools

Tools for Webscript inspection, display, installation etc.

B.8.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

B.8.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

B.8.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

B.8.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

B.8.4. Resource Others

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

B.8.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