a!cmiGetProperties() Function

Retrieves the properties of the CMIS object given as the objectId parameter.

Syntax

a!cmiGetProperties( scsExternalSystemKey, usePerUserCredentials, atomPubUrl, repositoryId, objectId)

Common Parameters:

scsExternalSystemKey: (Text) The key from the Third Party Credentials admin console page that corresponds to the set of credentials that should be used to authenticate.

usePerUserCredentials: (Boolean) If true the credentials set in the Third-Party Credentials settings page by the current user running the expression will be used. If false the site-wide credential values will be used.

atomPubUrl: (Text) The Atom Pub URL of the CMIS target system.

repositoryId: (Text) The repository id on the CMIS target system.

Specific Parameters:

objectId: (Text) The object id of the CMIS object whose properties will be retrieved.

Returns

The function returns the standard connector result dictionary described in the main Connectors page.

If successful, the result field contains the dictionary representation of the CMIS object properties.

Notes

If called multiple times in the same expression with the same parameters, only one query is made when the expression is evaluated and the result is reused for each identical call. This caching only applies within a single expression evaluation. Return values are not cached in separate expressions, or in separate evaluations of the same expression.

Examples

Get CMIS Object Properties Given an ID

This example returns the CMIS object properties for the given object id. Otherwise, it returns a message with the error encountered.

Copy and paste the expression below in an expression rule, replace the <objectId> text with a valid object id in CMIS, e.g. workspace://SpacesStore/7fe9f7a8-f2db-4e01-8499-acaa8aa92675, and click Test Rule.

1
2
3
4
5
6
7
8
9
10
11
12
13
=with(
  local!cmisResult: a!cmiGetProperties(
    scsExternalSystemKey: cons!CMIS_SCS_KEY,
    usePerUserCredentials: true,
    atomPubUrl: cons!CMIS_URL,
    repositoryId: cons!CMIS_REPO_ID,
    objectId: "<objectId>"
  ), 
  if(local!cmisResult.success,
    local!cmisResult.result,
    local!cmisResult.error
  )
)
FEEDBACK