API function overview
Structured APIs allow customer applications in CICS®, IMS,
TSO or batch environments the ability to invoke the server functions
described in Table 1.
| Function | Description |
|---|---|
| LOGON | Establishes a connection to the Content Manager OnDemand library server. After a successful logon, the server returns a list of authorized folders that can be accessed by a specific user. |
| FOLDER OPEN | Identifies the folder name to be processed by subsequent search and retrieve requests. |
| HIT LIST | Requests that the Content Manager OnDemand server return a list of items matching the user supplied search criteria. |
| RETRIEVE | Retrieves a document from a Content Manager OnDemand archive. If a RETRIEVE request with the implicit logoff flag set to Y is processed, a LOGOFF call is made and invokes a RELEASE request after the document is retrieved. The RELEASE request then frees all storage areas except the document structure. When the document structure is no longer needed, you need to make a separate RELEASED request to release the document structure. |
| BULK RTRIEV | Requests multiple documents to be identified
with an appropriate WHERE clause, and retrieves all
identified documents. |
| ANNOTATIONS | Requests that the Content Manager OnDemand server return the annotations for the selected document. |
| LOGOFF | Allows users to log off a Content Manager OnDemand server. LOGOFF also frees all storage areas that are used by the LOGON, FOLDER OPEN, HIT LIST, and RETRIEVE functions. |
| RELEASE | Frees all storage areas that are used by the LOGON, FOLDER OPEN, HIT LIST, and RETRIEVE functions. |
| RELEASEA | Frees the Annotations List Structure created by ANNOTATIONS |
| RELEASEC | Frees the FolderCriteriaStructure created by FOLDER OPEN |
| RELEASED | Frees the Document Structure created by RETRIEVE (The Document Structure must be freed by using RELEASED) |
| RELEASEH | Frees the HitListStructure created by HIT LIST |
| RELEASEL | Frees the FolderListStructure created by LOGON |