Repository Web Service Version 1.4

[resplin]

Obsolete Pages{{Obsolete}}

The official documentation is at: http://docs.alfresco.com

Web ServicesBack to Repository Web Service.

This service provides read and write operations against a Repository.  The operations are not tied to any particular domain model (i.e. it's generic in nature); other higher-level services will provide domain specific support.

Table of Contents

• 1 Types
  
  
  
  • 1.1 QueryResult
  
  
  • 1.2 Association
  
  
  • 1.3 UpdateResult
  
  


• 2 Methods
  
  
  
  • 2.1 createStore
  
  
  • 2.2 getStores
  
  
  • 2.3 query
  
  
  • 2.4 queryChildren
  
  
  • 2.5 queryParents
  
  
  • 2.6 queryAssociated
  
  
  • 2.7 fetchMore
  
  
  • 2.8 update
  
  
  • 2.9 describe
  
  
  • 2.10 get
  
  

Types

QueryResult

• querySession - string
  
• resultSet - ResultSet
  

Association

• associationType - cms:Name
  
• direction - string (source, target)
  

UpdateResult

• statement - string
  
• updateCount - int
  
• source - Reference[]
  
• destination - Reference[]
  

Methods

createStore

Creates a new store in the repository

Store createStore(xsd:string scheme, xsd:string address)

Parameters:

• scheme - this indicates the type of store being referenced ths most common being 'workspace'. Other valid store schemes include 'versionStore', 'user', 'search' and 'system'.
  
• address - this is the name of the store.
  

Return:

• reference to the newly created store
  

getStores

Retrieve list of stores where content resources are held.

Store[] getStores()

Return:

• a list of the stores held in the repository
  

query

Execute a query against a store (could be a virtual store).

Query results are batched to the number of rows as defined by the SOAP header.  Subsequent batches are retrieved using fetchMore.

QueryResult query(Store store, Query query, boolean includeMetaData)

Parameters:

• store - the store
  
• query - the query details
  
• includeMetaData - indicates whether the query meta data should be included in the query result
  

Return:

• the query result
  

queryChildren

Execute a query to retrieve the children of the specified resource.

QueryResult queryChildren(Reference node)

Parameters:

• node - the reference
  

Return:

• a query result containing the children of the specified reference
  

queryParents

Execute a query to retrieve the parents of the specified resource.

QueryResult queryParents(Reference node)

Parameters:

• node - the reference
  

Return:

• a query result containing the parents of the specified reference
  

queryAssociated

Execute a query to retrieve associated resources of the specified resource.

QueryResult queryAssociated(Reference node, Association[] association)

Parameters:

• node - the reference
  
• associatoin - the association
  

Return:

• a query result containing the references associatied to the specified reference
  

fetchMore

Fetch the next batch of query results.

QueryResult fetchMore(string querySession)

Parameters:

• querySession - the query session id
  

Return:

• a query result containing the next batch of results
  

update

Execute a CML script to manipulate the contents of a Repository store.

UpdateResult[] update(CML statements)

Parameters:

• statements - CML statements
  

Return:

• the results of the CML statements executed
  

describe

Describe a content resource.

NodeDefinition[] describe(Predicate items)

Parameters:

• items - the predicate
  

Return:

• the node defintions of the specified items
  

get

Gets the resource identified.

Node[] get(Predicate[] where)

Parameters:

• where - the predicate
  

Return:

• the node objects of the items referenced