Retrieve document

Table 1. Retrieve document API
HTTP verb URL Request parameters
GET /v1/hits/{folderName}/{docId} Content Manager OnDemand folder name

Content Manager OnDemand document identifier

Optional query string: viewerName={transform name} where transform name is the name of a configured transform

The retrieve document API requires two URL parameters: a folder name, and a document identifier. Optionally, a transform name can be specified in a query string. This will cause the data to be converted to a different data type, such as PDF. These parameters must be URL encoded.

Sample request 

GET /cmod-rest/v1/hits/Ledger%20Reports/Y2wumpdlBLHubqoHI7SOWrm2bURa4MS%2F%2FK7fsMJJcMQipqF%2FZ%2FSfhm%2Bc7F6kAs5r9KsRg307wFXXSe5ejURkY0lM938akwCSK5tg8WYoewm2RUDkfcH7OsZUdEQPU535wBRr1SVi7ADYAJQYcySl12rJEPyaxiEA1Tf6wRYyFza%2BE%3D HTTP/1.1
usi-date: 2023-11-13T18:32:24Z
Authorization: CMODSharedKey odvttstl01-68yXERhn79KNry/oV7IY:7dpKwx5tdElArfzKvJJuHpJLRCs6Y/IJsbQv5KoBXCo=
Host: localhost

Sample response 

HTTP/1.1 200 OK
X-Powered-By: Servlet/4.0
Content-Type: application/unknown
Content-Disposition: attachment;filename=xLsGMa1FfeAFVi.txt
Date: Mon, 13 Nov 2023 18:32:25 GMT
Correlation-Id: 41253010-a785-4412-9409-a9090b59f03a
Content-Language: en-US
Content-Length: 5553
            
BAXTER BAY INFORMATION SYSTEM             TRANSACTION DATE :15/07/2020             PROCESSING DATE 01/08/2020
 MZSB32/3    LISTING OF CIS ENQUIRY TRANSACTIONS                                                      PAGE  1
            
 BANK              : BAXTER BAY CREDIT
            
 DEPARTMENT/BRANCH : 1234 TEST CO ACCOUNT SERVICES
            
 PRODUCT TYPE     PRODUCT REFERENCE     BOT    TIME     USER ID  OPER TYPE  USER  SYS  DATA TYPE
                                                                            ORG   ID
                                                          
    0010          07027403793           1006  12:23:37  test-id   CLERK     2003  S1   PRODUCT INFORMATION
    0020          40200200097           1006  09:01:30  test-id   CLERK     2003  S1   PRODUCT INFORMATION
    0020          40200200097           1006  09:14:41  test-id   CLERK     2003  S1   PRODUCT INFORMATION
    0020          40200200097           1006  09:30:48  test-id   CLERK     2003  S1   PRODUCT INFORMATION
    0020          40200200097           1006  09:44:44  test-id   CLERK     2003  S1   PRODUCT INFORMATION

Sample request with transform specified 

GET /cmod-rest/v1/hits/Ledger%20Reports/Y2wumpdlBLHubqoHI7SOWrm2bURa4MS%2F%2FK7fsMJJcMQipqF%2FZ%2FSfhm%2Bc7F6kAs5r9KsRg307wFXXSe5ejURkY0lM938akwCSK5tg8WYoewm2RUDkfcH7OsZUdEQPU535wBRr1SVi7ADYAJQYcySl12rJEPyaxiEA1Tf6wRYyFza%2BE%3D? viewerName=OD_LINE2PDF HTTP/1.1 
usi-date: 2023-11-13T18:32:26Z
Authorization: CMODSharedKey odvttstl01-68yXERhn79KNry/oV7IY:eUg4dpU3vFktPCx8UpcdzTSgkmLL6GbUT6UdJSTmVzo=
Host: localhost

Sample response 

HTTP/1.1 200 OK
X-Powered-By: Servlet/4.0
Content-Type: application/pdf
Content-Disposition: attachment;filename=6xgdVZNjmxt8dk.pdf
Date: Mon, 13 Nov 2023 18:32:31 GMT
Correlation-Id: c3299f0f-2cf0-4a68-bbaf-bf224b838216
Content-Language: en-US
Content-Length: 1227
%PDF-1.3
%
1 0 ob
<<
/Type /Catalog
/Pages 2 0 R