This document covers the following topics:
Return information about a reference document.
When you return information for a reference document which is currently stored in the Inbasket file New, the corresponding address list is updated so that the reception status of the reference document indicates that it has been read. Additionally, the reference document is moved from the file New to file Opened. In this case, END TRANSACTION is automatically issued.
| Parameter | Format | In | Out | Remarks |
|---|---|---|---|---|
| Return-code | N2 | O | X | Input -1: no ET. |
| Cabinet | A8 | R | The cabinet in which the reference document is stored. | |
| Password | A8 | R | The password of the above cabinet. | |
| Ref-document-name | A32 | R* | The name of the reference document for which you want to return information. Either Ref-document-name or ISN, not both. | |
| ISN | P8 | R* | The ISN of the reference document for which you want to return information. Either ISN or Ref-document-name, not both. | |
| Description | A60/1:4 | X | The description of the reference document. | |
| Keywords | A15/1:6 | X | Keywords are helpful later when you search for an object. | |
| Title | A60 | X | The title of the work. | |
| Writer | A60 | X | The writer of the work. | |
| Private-flag | A1 | X | If marked, the reference document is a private object. | |
| Security-flags | A4 | X | The security levels for Read, Modify and Copy. Values 0 to 9. The security level for Print (fourth byte) is not used for reference documents. | |
| Folder-name | A15 | X | The folder in which the reference document is stored. | |
| File-name | A15 | X | The file within the above folder in which the reference document is stored. | |
| Author-user-ID | A8 | X | Name of the cabinet in which the reference document was added. | |
| Date-created | N8 | X | Format yyyymmdd. The date when the reference document was added. |
| 00 | Success |
| 02 | Invalid cabinet name |
| 03 | Password incorrect |
| 04 | ISN was not found |
| 08 | Supply either ISN or name, not both |
| 09 | ISN does not point to correct object |
| 51 | Invalid name |
| 53 | Requested object does not exist |
Z-120
Z-122
Z-123
Z-147
Z-165
Z-175
Z-177
Z-194
Z-197
Z-222
Z-223
Z-400
Z-401
Z-1200&0