Web Service Data Types Version 1.3

[resplin]

Obsolete Pages{{Obsolete}}

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

Web Services
Back to Web Service Data Types.

Table of Contents

• 1 Introduction


• 2 Identifiers & Locators
  
  
  
  • 2.1 Store
  
  
  • 2.2 Reference
  
  
  • 2.3 ParentReference
  
  


• 3 Content Representation
  
  
  
  • 3.1 ContentFormat
  
  
  • 3.2 NamedValue
  
  
  • 3.3 Node
  
  


• 4 Queries
  
  
  
  • 4.1 Query
  
  
  • 4.2 ResultSet
  
  
  • 4.3 Predicate
  
  


• 5 Meta Data
  
  
  
  • 5.1 ClassDefinition
  
  
  • 5.2 NodeDefinition
  
  


• 6 Versioning
  
  
  
  • 6.1 VersionHistory
  
  


• 7 Classification & Categorisation

Introduction

Alfresco's Web Services use the following data types within input and output messages.

The definitive XML schema representation can be found here.

Identifiers & Locators

Store

The store data type uniquely identifies a store in a repository.

It is made up of two parts:

• 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.
  

The most common example is the store used by the main web UI this has scheme 'workspace' and address 'SpacesStore'.

datatype_store.jpg

Reference

A reference data type is a reference to a single node within a given store.

A reference is made up of three parts:

• store: the details of the store that this reference is scoped by.
  
• uuid: the unique identifier of a node.  This part is optional.
  
• path: the query path to a single node.  This part is optional.
  

A reference which has only the store set is referring to the root node of that store.

A reference which has only the uuid set is referring to the node that has that uuid.  If no match is found then that is considered an error.

A reference which has only the path set is referring to a node that results from the execution of the given query on the store.  The query language expected is XPath.  For example to find the company home node is the 'SpacesStore' you would use the path /app:company_home.  If the result from the path query is nore than one node then this is considered an error.

In the case where both uuid and path are set then the path query will be executed in the context of the node referenced by the uuid.

datatype_reference.jpg

ParentReference

A parent reference is used to describe how a node may be associated to a child.  Parent references are usually used when an operation creates a new node, for example create content, move, etc.

A parent reference is made up of three parts:

• reference: a reference to the node that is the parent.
  
• associationType: the string form of the associations type QName.  For example:

  {http://www.alfresco.org/model/content/1.0}contains

  
  
• childName: the string form of the associations QName. For example:

  {http://www.alfresco.org/model/content/1.0}mydocs

  
  

datatype_parentreference.jpg

Content Representation

ContentFormat

The content format data type is made up of two parts:

• mimetype:  the mime type of the content
  
• encoding: the character encoding of the content
  

This is used to encapsulate the content format information about a content node.

datatype_contentformat.jpg

NamedValue

The named value data type contains the name and value(s) of an attribtue of the Alfresco repository:

• name: the string representation of values QName
  
• isMultiValue: indicates whether we are dealing with a multi-values attribute.  If set to false then the values attribute is used, otherwise the values attribute is used.  If this attribute is not set then it is interpreted as false.
  
• value: the single value as a string
  
• values: a string array of values 
  

The named value data type is most commonly used to prepresent the name and value of a node property.

Support for multi-valued attributes was added since 1.3.

datatype_namedvalue.jpg

Node

The Node data type represents the details of a node held within the repository.  It includes the type, aspect and property details and values.

The Node data type is made up of four parts:

• reference: the reference to the node
  
• type: the string representation of the QName of the type of the node
  
• aspect: the string representation of the QName's of the aspect applied to the node
  
• properties: the names and values of the properties of this node
  

datatype_node.jpg

Queries

Query

The query data type is made up of two parts:

• language: the query language
  
• statement: the query statement
  

The query data type is used to encapsulate information about a query.

datatype_query.jpg

ResultSet

datatype_queryresult.jpg

Predicate

datatype_predicate.jpg

Meta Data

ClassDefinition

datatype_classdefinition.jpg

NodeDefinition

datatype_nodedefinition.jpg

Versioning

VersionHistory

datatype_versionhistory.jpg

Classification & Categorisation

These types have been moved into the scope of the classification web service as of version 1.3