Administration Web Service Future Enhancements

Document created by resplin Employee on Jun 6, 2015
Version 1Show Document
  • View in full screen mode

Obsolete Pages{{Obsolete}}

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



Web Services
Back to Administration Web Service.




The administration web service future enhancements.


Data Types


Descriptor


Provides meta-data for the Alfresco stack.


  • string name - the name of the item being described, e.g 'server' or 'repository'
  • string versionMajor - the major version number, e.g. 1.2.3
  • string versionMinor - the minor version number, e.g. 1.2.3
  • string versionRevision - the version revision number, e.g. 1.2.3
  • string versionLabel - the full version label
  • string edition - the edition
  • int schema - the schema number
  • NamedValue[] descriptors - the description names and values




ImportDataType


Enum containing the different types of import data that can be imported.


  • ACP - an acp file
  • VIEW_XML - a file containing import view XML

UUIDBinding


Enum containing the different id binding that cab be applied when importing data.


  • CREATE_NEW
  • REMOVE_EXISTING
  • REPLACE_EXISTING
  • UPDATE_EXISTING
  • THROW_ON_COLLISION

ExportParameters


Type encapsulating the various parameters that can be passed to an export that influence the way the data is exported.


  • boolean followChildren - indicates whether to follow and export children or not
  • boolean followAssociations - indicates whether to follow and export associations or not
  • boolean exportContent - indicates whether to export content or not
  • boolean exportSelf - indicates whether to export the root reference or not
  • boolean exportNullProperties - indicates whether to export null properties or not
  • string[] excludedNamespaceURIs - a list of namespace URI's not to export

Methods


getDescriptors


Gets the list of descriptors that describe the repository and server.

Descriptor[] getDescriptors()

Return:


  • a list of descriptors

import


void import(ImportDataType type, byte[] data, ParentReference parentReference, UUIDBinding binding)


importFromReference


void importFromReference(Reference reference, ParentReferenceparentReference, UUIDBinding binding)


exportToReference


Reference exportToReference(ParentReference parentReference, Reference exportRoot, ExportParameters exportParameters)

Attachments

    Outcomes