Agnostic Guides
...
Developers Guide
SCRUD API’s

CMS_API_UPDATE

1min

Functionality 



Description 

FileNet Notes 

Documentum Notes 

Box Notes 

M365/SharePoint Notes 

IV_CMSPROFILE 

Required: Determines which configured CMS Profile in Link Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.









IV_CMSTAG 

Required: Determine which configured CMS Profile in Link Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination. 









IV_REPOSITORY 

Required: Determines which configured repository in Link Enterprise SAP to utilize 

Object Store 

Docbase 

Default is the only Store/Repository supported since Box currently doesn’t support the notion of different repositories.

Site, site collection 

IV_TYPE 



Optional: what CMS type to update. 

DOCUMENT CLASS 



OBJECT TYPE 



METADATA TEMPLATE 



CONTENT TYPE 



IV_USE_MAPPING 

Optional: use mapping of IV_TYPE to CMS type in Enterprise Connector if CMS. Used if ArchiveLink doctype name to CMS type mapping is required. 









IV_CHECKOUT

Optional: allows you to checkout a document. 

Only available in newer versions. 



Only available in newer versions. 





Not supported 



IV_CANCEL_CHECKOUT 

Optional: allows you to cancel the checkout of a document. This will return an error if the document is already checked out. 









IV_LOCATION 

Optional: (Mandatory for M365/SharePoint only and not used in any other CMS system) Specifies where to document to update resides. 

Not utilized. 

Not utilized. 

Not utilized. 

This is required and is the Document Library. For documents originally created by Link Enterprise, this is stored at the time of create in a Link Enterprise table in the scenario that the config changes and thus can be used for subsequent updates. 

IV_FOLDER_METADATA

Optional: If supported by your CMS, setting this flag to true will apply metadata at the folder level. The ID's located in the IT_IDS table will be folder IDs.





Applied metadata at the top level folder only

Applied metadata at all levels of folders





































IT_IDS

Table of file ID's (or folders ID's if supported by your CMS)









IT_METADATA 

Mandatory: metadata to set during updates. Some metadata cannot be set during update and is only read only (some system properties). Updating some system properties in certain repositories may lead to unknown results. The Link Enterprise username and timestamp properties are automatically set as metadata during update if they are configured on the particular CMS tab in the Link Enterprise Connector. When the same keys are used multi valued properties are set with all of the specified values. The ZMULTI flag is ignored during an update since the same key signifies a multi valued property by default. 

To assist with the date format for FileNet, you may choose to utilize the Link Enterprise helper method ‘/dflow/cl_utilities_helper=>format_date’ to format a system date field to the format desired 

To assist with the date format for Documentum, you may choose to utilize the Link Enterprise helper method ‘/dflow/cl_utilities_helper=>format_date’ to format a system date field to the format desired 

Currently doesn’t support multi valued metadata. Where a date field is part of the metadata being sent, the format must be MM/dd/yyyy hh:mm:ss a z, where a z = the AM/PM and TIMEZONE example: 12/31/9999 12:00:00 PM MST to assist with the date format for Box, you may choose to utilize the Link Enterprise helper method ‘/dflow/cl_utilities_helper=> format_date_plus_sys_timezone’ to format a system date field to the format desired and also appending the system timezone 

Currently doesn’t support multi valued metadata. 

ET_RETURN 

Table that indicates a success of an error. The TYPE field will contain an ‘S’ or ‘E’ respectively and the MESSAGE field will contain information in the case of an error. 









CT_CUSTOM 

Future use