CMS_API_READ

functionality description filenet notes documentum notes box notes o365/sharepoint notes iv cmsprofile required determines which configured cms profile in docuflow 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 docuflow 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 docuflow 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 create 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 id optional id to use for versioning a document when specified a new version of the existing id is created with the given content guid r object id id versioning not supported iv checkout optional allows you to checkout a document only available in newer versions only available in newer versions not supported iv get content optional indicates whether to pass the content of the document back in table et content multi iv location optional (mandatory for o365/sharepointo only and not used in any other cms system) specifiedswhere to read the document from not utilized not utilized not utilized this is required and is the document library for documents created by docuflow, this is stored at the time of create in a docuflow table in the scenario that the config changes and thus can be used for subsequent reads it metadata filter if specified, only metadata properties indicated will be returned by default of no filter is provided, all metadata for a document is retrieved et metadata contains the metadata retrieved et files table containing the filename, size, and mime type of the files retrieved if get content is enabled 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 general filenet comments for performance considerations it’s best to limit the read to the particular metadata that is necessary for processing and not retrieve all of the available metadata general documentum comments for performance considerations it’s best to limit the read to the particular metadata that is necessary for processing and not retrieve all of the available metadata general box comments for performance considerations it’s best to limit the read to the particular metadata that is necessary for processing and not retrieve all of the available metadata currently versionseries isn’t supported with box since there is currently no unique id that represents all versions of a document foldersfiledin only returns the parent folder for a box document example docuflow has a test hardness that is located under the api gateway you can choose to either single click on a gateway entry and choose the menu path execute >read again this will populate values into the test harness from the line you have selected choose the the menu path execute >read new this provide a blank test harness to set a break point to see how this call is executed, the program the test harness uses for read is program se38 /dflow/zcmsapi read 01 below is a sample call