Authoring Web Service

[resplin]

Obsolete Pages{{Obsolete}}

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

Web Services
Back to Alfresco Content Management Web Services.

This service provides support for collaborative editing of content.

Table of Contents

• 1 Change Log


• 2 Types
  
  
  
  • 2.1 CheckoutResult
  
  
  • 2.2 CheckinResult
  
  
  • 2.3 CancelCheckoutResult
  
  
  • 2.4 LockTypeEnum
  
  
  • 2.5 LockStatus
  
  
  • 2.6 VersionResult
  
  


• 3 Methods
  
  
  
  • 3.1 checkout
  
  
  • 3.2 checkin
  
  
  • 3.3 checkinExternal
  
  
  • 3.4 cancelCheckout
  
  
  • 3.5 lock
  
  
  • 3.6 unlock
  
  
  • 3.7 getLockStatus
  
  
  • 3.8 createVersion
  
  
  • 3.9 getVersionHistory
  
  
  • 3.10 revertVersion
  
  
  • 3.11 deleteAllVersions
  
  

Change Log

• Authoring Web Service Future Additions
  

Types

CheckoutResult

Contains the results of a checkout.

• Reference[] originals - the checked out references
  
• Reference[] workingCopies - the working copy references
  

CheckinResult

Contains the results of a checkin.

• Reference[] workingCopies - the working copies checked in
  
• Reference[] checkedIn - the checked in references
  

CancelCheckoutResult

Contains the results of a canceled checkout

• Reference[] workingCopies - the working copy references
  
• Reference[] originals - the origional references
  

LockTypeEnum

The lock types enum.

• Read-Only
  
• Write
  

LockStatus

The current status of a lock.

• Reference node - the reference
  
• LockTypeEnum lockType - the lock types
  
• String lockOwner - the lock owner
  

VersionResult

Contains version details for a collection of references.

• Reference[] nodes - the references
  
• Version[] versions - the versions
  

Methods

checkout

Checkout a content resource for exclusive (or possbily shared) editing.

CheckoutResult checkout(Predicate items, ParentReference destination)

checkin

Checkin a content resource.

CheckinResult checkin(Predicate items, NamedValue[] comments, boolean keepCheckedOut)

checkinExternal

Checkin an external content resource thus replacing the existing working content.

Reference checkinExternal(Reference node, NamedValue[] comments, boolean keepCheckedOut, ContentFormat format, xsd:base64Binary content)

cancelCheckout

Cancels the checkout.

CancelCheckoutResult cancelCheckout(Predicate items)

lock

Locks the reference.

Reference[] lock(Predicate items, boolean lockChildren, LockTypeEnum lockTypeEnum)

unlock

Removes all locks on the specified nodes.

Reference[] unlock(Predicate items, boolean unlockChildren)

getLockStatus

Gets the lock status of the specified nodes.

LockStatus[] getLockStatus(Predicate items)

createVersion

Create a snapshot of the specified node(s) in the version store.

VersionResult createVersion(Predicate items, NamedValue[] comments, boolean versionChildren)

getVersionHistory

Gets the version history of the specified node.

VersionHistory getVersionHistory(Reference node)

revertVersion

Revert a node to the snapshot of the specified version.

void revertVersion(Reference node, string versionLabel)

deleteAllVersions

Delete all snapshot versions of the specified node.

VersionHistory deleteAllVersions(Reference node)