a!cmiGetObjectIdByPath() Function

Retrieves the object id of a CMIS object based on the value given as the path parameter.

Syntax

a!cmiGetObjectIdByPath( scsExternalSystemKey, usePerUserCredentials, atomPubUrl, repositoryId, path)

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:

path: (Text) The CMIS path of the object. The meaning of the path is defined by the CMIS server. For example, /folder1/folder2/mydocument3.

Returns

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

If successful, the result field contains the CMIS object id at the given path.

Notes

If called multiple times in the same expression with the same parameters, only one query is made to the data store 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 a CMIS Object ID for a Give Path

This example returns the object id for the given path if the query is successful. Otherwise, it returns a message with the error encountered.

Copy and paste the expression below in an expression rule, replace the <path> text with a valid path in CMIS, e.g. /folderName, and click Test Rule.

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