Rest Interface Guide

Change Log

Changes in v14.0

Changes
  • The publishAsset  API has been enhanced to support publishing previous versions of an asset, by adding two parameters:

    • majorversion

    • minorversion

  • A correction was made to the example URL for the createRepositories method.

Changes in v13.2

Changes in version 13.2 included the following:

Additions

The following additions were made to the REST API in version 13.2.

Service

Method Name

Function

Reference

Asset facade

reIndex

Re-index an asset using the asset id or the asset path.

"Asset management"

 

Changes
  • The getSearchResultsForQuery  API has been enhanced to support returning results in a paginated manner.

  • The search  API has been enhanced to support returning results in a paginated manner.

  • The search, count  API have been modified  to accomodate a large amount of returning results.

Changes in v13.1

Changes in version 13.1 included the following:

Additions

The following additions were made to the REST API in version 13.1.

Service

Method Name

Function

Reference

Clipboard facade

promoteClipboardDataToAsset

Promote clipboard data to asset.

"Clipboard"

Changes in v13.0

Changes in version 13.0 included the following:

The PublishingFacade bean API has been updated which could result in a compile error if using this as a Spring bean.

The method signatures in PublishFacade and PublishByPathFacade were modified by adding the httpServletResponse argument. This affects the following REST calls:

  • publishAsset

  • publishBasedOnStreamContext

  • publishBasedOnURI

  • executeDatadocChannel

This argument sets the appropriate content-type header values in the http response for publishing requests.

Although this change impacts no REST URLs, any custom code using these methods by injecting PublishFacade and PublishByPathFacade as a Spring bean will encounter compile errors. These errors can be avoided by passing the argument as null.

Additions

The following additions were made to the REST API in version 13.0.

Service

Method Name

Function

Reference

Office facade

getExcelChart

 

Get Microsoft Excel chart

"Office"

getExcelChartBasedOnStream

 

Get Microsoft Excel chart based on stream

getExcelChartBasedOnURI

 

Get Microsoft Excel chart based on URI

getExcelTable

Get Microsoft Excel table

getExcelTableBasedOnStream

 

Get Microsoft Excel table based on stream

getExcelTableBasedOnURI

Get Microsoft Excel table based on URI

Clipboard facade

addClipboardData

Add data to clipboard

"Clipboard"

addFormattedData

Add formatted data

getAllClipboardChannelsMapping

Get all clipboard format to channel mappings

getAllClipboardDataInfos

Get all clipboard data information.

getAllClipboardFormats

Get all clipboard formats

getClipboardDataInfo

Get clipboard data information

getClipboardChannelsMappings

Get clipboard channel mappings for content type

getFormattedData

Get formatted data

getLatestClipboardData

Get latest clipboard data

getLatestClipboardDataInfo

Get latest clipboard data information

getLatestFormattedData

Get latest formatted data

Changes in v12.0

Changes in version 12.0 included the following:

Additions

The following additions were made to the REST API in version 12.0.

Service

Method Name

Function

Reference

Asset facade

generateTextIndexesOfAllAssets

Generate text indexes for all assets.

"Asset Management"

generateTextIndexes

Generate text indexes for a specified asset.

Office facade

getVisioPagesInfo

Get metadata of all pages of a Visio asset.

"Office"

getVisioPagesInfoBasedOnURI

Get metadata of all pages of a Visio asset based on URI.

getVisioPagesInfoBasedOnStreamContext

Get metadata of all pages of a Visio asset based on stream.

getVisioPageOutput

Get page output of a Visio asset.

getVisioPageOutputBasedOnURI

Get metadata of all pages of a Visio asset based on URI.

getVisioPageOutputBasedOnStreamContext

Get page output of a Visio asset based on stream.

getPowerPointSlidesInfo

Get metadata of all slided of a PowerPoint asset.

getPowerPointSlidesInfoBasedOnURI

Get metadata of all slides of a PowerPoint asset based on URI.

getPowerPointSlidesInfoBasedOnStreamContext

Get metadata of all slides of a PowerPoint asset based on file stream.

getPowerPointSlideOutput

Get slide output of a PowerPoint asset.

getPowerPointSlideOutputBasedOnURI

Get slide output of a PowerPoint asset based on URI.

getPowerPointSlideOutputBasedOnStreamContext

Get slide output of a PowerPoint asset based on file stream.

getPowerPointSlideRangeOutput

Get slide range output of a PowerPoint asset.

getPowerPointSlideRangeOutputBasedOnURI

Get slide range output of a PowerPoint asset based on URI.

getPowerPointSlideRangeOutputBasedOnStreamContext

Get slide range output of a PowerPoint asset based on file stream.

Configuration facade

getAllXmlMimeTypes

Get XML MimeTypes

"Configuration"

getXmlMimeType

Get XML MimeType

createXmlMimeType

Create a custom XML MimeType.

getMappedMimeTypes

Get mapped MimeTypes

mapMimeTypes

Map custom XML MimeType with ContentType.

unmapMimeTypes

Unmap custom XML MimeType with ContentType.

deleteXmlMimeType

Delete custom XML MimeType.

getPublishingProcess

Get publishing process

createPublishingProcess

Create publishing process

deletePublishingProcess

Delete publishing process.

getAllPublishingChannelDefinitions

Get all publishing channels

getPublishingChannelDefinition

Get publishing channel

getPublishingChannelDefinitions

Get the publishing channel of a specific content type.

createpublishingChannels

Create new publishing channels

createContentChannelMappings

Map publishing channel with content type for publishing.

deleteContentChannelMappings

Delete publishing channel and content type mapping.

createIndexingChannelMapping

Map publishing channel with content type for indexing.

getMappedIndexingChannel

Get mapped indexing channels for a given content type.

deleteIndexingChannelMapping

Delete publishing channel and content type mapping for indexing.

deletePublishingChannels

Delete publishing channel.

getDeploymentProperties

Get deployment properties

getDeploymentVersion

Get deployment version

reInitialize

ReIntialize the MimeType

Changes in v11.2

Changes
  • Added support for JSON format.

Changes in v11.0

Changes in version 11.0 included the following:

Additions

The following additions were made to the REST API in version 11.0.

Service

Method Name

Function

Reference

Collection facade

getApplicablePrivileges

Get applicable privileges for the logged in user.

"Collection Management"

getApplicableRoutingGroups

Get applicable routing groups for the logged in user.

 

getApplicableAttributeConstraints

Get applicable attribute constraints for the logged in user.

getApplicableStatusTransition

Get applicable status transitions for the logged in user.

getApplicableWorkflowInitialStatuses

Get applicable workflow initial statuses.

 

Admin facade

updateUserEnabled

Enables/disables the Platform Server Logon for the given user.

"Administration"

getGroupsWithGivenUserClass

Get groups with the given role.

getUserGroups

Get groups of a user.

getLdapGroups

Get LDAP groups.

importGroupsFromLdap

Get LDAP groups.

synchonizeLdapUsesrGroups

Synchronize all LDAP users and groups.

synchronizeLdapUsersGroupsBasedOnProfile

Synchronize all LDAP users and groups.

createLdapSearches

Create LDAP search definitions.

getLdapSearch

Get LDAP search definition.

getAllLdapSearches

Get all saved LDAP search definitions.

updateLdapSearches

Update LDAP search definitions.

deleteLdapSearch

Delet an LDAP search definition.

updateTrusteeRule

Update role for the given trustee.

getApplicableApplicationPrivileges

Get applicable application privileges for the logged in user.

getApplicablecontentPrivileges

Get applicable content privileges for the logged in user.

Changes
  • The userInfo XML has been modified to support LDAP groups functionality.

  • The groupInfo XML has been modified to support LDAP groups functionality.

  • The trusteeInfo XML has been modified to support LDAP groups functionality.

  • The domainValue XML has been modified to populate a new element, valueHierarchy referring to the hierarchy of a domain value.

    Population of this unique domain value hierarchy is helpful in asset metadata update when the domain value id is not known and there exists multiple domain values with the same name.

     

  • The ldapProfileInfo XML has been modified to support LDAP groups functionality.

  • In order to set the attribute value of a domain type attribute during check in of an asset: asset metadata update, asset checkout etc., the attributeValue XML has been enhanced to support the following options in priority:

    • Specify domain value via hierarchy:

       

      <attributeValueList>
        <attributeValue name="Departments">Enterprise;Server</attributeValue>
      </attributeValueList>
    • Specify domain value via name:

      <attributeValueList>
        <attributeValue name="Departments">Server</attributeValue>
      </attributeValueList>
    • Specify domain value via id:

      <attributeValueList>
        <attributeValue name="Departments" valueId="1"></attributeValue>
      </attributeValueList>

       

    If the CDATA has a value mentioned, it will be assumed to be a domain value hierarchy first and if not resolved, then a domain value name. The valueId attribute will only be considered if the CDATA is empty for that <attributeValue> node for a domain type attribute.

Deletions
  • The getOverriddenUserClass(long collectionId) request has been removed.

    In the current model, a users privileges is a union of the following roles:

    • Role of the logged in user in the given collection, only if the user is mapped to the given collection.

    • Role of collection mapped groups of which the logged in user is a member.

    The getApplicablePrivileges request should be used to get applicable privileges for the logged in user for the given collection.