---
title: CMS_API_READ
slug: docuflow-guides/cmsapiread
docTags:
createdAt: 2020-03-10T21:15:16.000Z
---
| **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:
1. 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
2. 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:
::Image[]{src="https://api.archbee.com/api/optimize/1hH4CNQG9tP4YS-TB-TC6/NrcB7kGZUUhV6tpvjTMlI_image.png" size="68" width="698" height="530" position="flex-start" showCaption="false"}