Get report sample data
get
/services/rest/v1/reports/{reportPath}/sampleData
Gets the sample data file stored with the report data model.
Request
Path Parameters
-
reportPath(required): string
URL encoded report path. For example, if your report path is "/Sample Lite/Published Reporting/Reports/Balance Letter" then your encoded report path will be "%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter". Use double encoded forward slash when you send a REST request to BI Publisher through a load balancer that isn't configured to pass encoded slashes. For example, if your report path is "/Sample Lite/Published Reporting/Reports/Balance Letter" then your encoded report path will be Sample%20Lite%252FPublished%20Reporting%252FReports%252FBalance%20Letter
Response
Supported Media Types
- application/octet-stream
200 Response
Returns the report sample data in binary format.
Root Schema : schema
Type:
string(binary)
Examples
The following example shows how to get the sample data file stored with the data model of a report by submitting a GET request on the REST resource using cURL.
curl \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--request GET 'https://hostname/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FBalance%20Letter/sampleData'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
<?xml version="1.0" encoding="UTF-8"?><ARXCOBLX> <G_CUSTOMER> <CUSTOMER_NUMBER>1005</CUSTOMER_NUMBER><CUSTOMER_NAME>Vision Operations</CUSTOMER_NAME><ADDRESS_LINE1>5645 Main Street</ADDRESS_LINE1><ADDRESS_LINE2/><ADDRESS_LINE3/><ADDRESS_LINE4/><CITY>Jacksonville</CITY><STATE>FL</STATE><ZIP>32209-1234</ZIP><COUNTRY>US</COUNTRY> <AS_OF_DATE>2004-01-01</AS_OF_DATE> <TAX_REFERENCE_NUM/><ORGANIZATION_NAME>Vision Operations (USA)</ORGANIZATION_NAME><G_CURRENCY> <TRX_CURRENCY_CODE>CAD</TRX_CURRENCY_CODE><G_INVOICES> <TRX_NUMBER>502444</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-12-06</TRANSACTION_DATE><TRANS_AMOUNT>19125</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>19125</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 19,125.00 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 19,125.00 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>502445</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-12-06</TRANSACTION_DATE><TRANS_AMOUNT>12375</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>12375</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 12,375.00 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 12,375.00 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><CF_TOTAL>31500</CF_TOTAL><C_ON_ACCOUNT_RECEIPTS>0</C_ON_ACCOUNT_RECEIPTS><CF_CREDITS_AND_RECEIPTS>0</CF_CREDITS_AND_RECEIPTS><C_UNAPPLIED_RECEIPTS>0</C_UNAPPLIED_RECEIPTS><C_ON_ACCOUNT_CREDITS>0</C_ON_ACCOUNT_CREDITS><C_INV_OPEN_BALANCE>31500</C_INV_OPEN_BALANCE><C_COUNT_INV>31500</C_COUNT_INV><CF_TOT_INV_DISPLAY> 31,500.00 </CF_TOT_INV_DISPLAY><C_TOTAL_INV>31500</C_TOTAL_INV><CF_TOTAL_DISPLAY> 31,500.00 </CF_TOTAL_DISPLAY><CF_CR_DB_DISPLAY> 0.00 </CF_CR_DB_DISPLAY><CF_INV_BAL_DISPLAY> 31,500.00 </CF_INV_BAL_DISPLAY></G_CURRENCY><G_CURRENCY> <TRX_CURRENCY_CODE>USD</TRX_CURRENCY_CODE><G_INVOICES> <TRX_NUMBER>10020219</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-11-21</TRANSACTION_DATE><TRANS_AMOUNT>89344.81</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>89344.81</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 89,344.81 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 89,344.81 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>502394</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-11-22</TRANSACTION_DATE><TRANS_AMOUNT>11250</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>11250</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 11,250.00 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 11,250.00 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>10020280</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-11-24</TRANSACTION_DATE><TRANS_AMOUNT>128654.96</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>128654.96</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 128,654.96 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 128,654.96 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>10020404</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-12-04</TRANSACTION_DATE><TRANS_AMOUNT>147740.25</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>147740.25</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 147,740.25 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 147,740.25 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>10020405</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-12-04</TRANSACTION_DATE><TRANS_AMOUNT>71577.42</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>71577.42</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 71,577.42 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 71,577.42 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>10020408</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-12-04</TRANSACTION_DATE><TRANS_AMOUNT>176353.55</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>176353.55</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 176,353.55 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 176,353.55 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>10020487</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-12-05</TRANSACTION_DATE><TRANS_AMOUNT>112902.54</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>112902.54</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 112,902.54 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 112,902.54 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>10020520</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-12-09</TRANSACTION_DATE><TRANS_AMOUNT>147740.25</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>147740.25</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 147,740.25 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 147,740.25 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>10020522</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-12-09</TRANSACTION_DATE><TRANS_AMOUNT>281904.71</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>281904.71</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 281,904.71 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 281,904.71 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>10020657</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-12-16</TRANSACTION_DATE><TRANS_AMOUNT>147740.25</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>147740.25</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 147,740.25 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 147,740.25 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><G_INVOICES> <TRX_NUMBER>502532</TRX_NUMBER><TRANS_TYPE>Standard</TRANS_TYPE><TRANSACTION_DATE>2003-12-20</TRANSACTION_DATE><TRANS_AMOUNT>11250</TRANS_AMOUNT><TRANS_AMOUNT_REMAINING>11250</TRANS_AMOUNT_REMAINING><RECEIPT_AMOUNT>0</RECEIPT_AMOUNT><ADJUSTMENT_AMOUNT>0</ADJUSTMENT_AMOUNT><EARNED_DISCOUNT_AMOUNT>0</EARNED_DISCOUNT_AMOUNT><UNEARNED_DISCOUNT_AMOUNT>0</UNEARNED_DISCOUNT_AMOUNT><INVOICE_CREDIT_AMOUNT>0</INVOICE_CREDIT_AMOUNT><BANK_CHARGE>0</BANK_CHARGE><ON_ACCOUNT_CREDIT_AMOUNT>0</ON_ACCOUNT_CREDIT_AMOUNT><ON_ACCOUNT_RECEIPTS>0</ON_ACCOUNT_RECEIPTS><UNAPPLIED_RECEIPTS>0</UNAPPLIED_RECEIPTS><CF_TRANS_AMOUNT> 11,250.00 </CF_TRANS_AMOUNT><CF_TRANS_AMOUNT_REMAIN> 11,250.00 </CF_TRANS_AMOUNT_REMAIN></G_INVOICES><CF_TOTAL>3365647.81</CF_TOTAL><C_ON_ACCOUNT_RECEIPTS>0</C_ON_ACCOUNT_RECEIPTS><CF_CREDITS_AND_RECEIPTS>0</CF_CREDITS_AND_RECEIPTS><C_UNAPPLIED_RECEIPTS>0</C_UNAPPLIED_RECEIPTS><C_ON_ACCOUNT_CREDITS>0</C_ON_ACCOUNT_CREDITS><C_INV_OPEN_BALANCE>3365647.81</C_INV_OPEN_BALANCE><C_COUNT_INV>3365647.81</C_COUNT_INV><CF_TOT_INV_DISPLAY> 3,365,647.81 </CF_TOT_INV_DISPLAY><C_TOTAL_INV>3365647.81</C_TOTAL_INV><CF_TOTAL_DISPLAY> 3,365,647.81 </CF_TOTAL_DISPLAY><CF_CR_DB_DISPLAY> 0.00 </CF_CR_DB_DISPLAY><CF_INV_BAL_DISPLAY> 3,365,647.81 </CF_INV_BAL_DISPLAY></G_CURRENCY><C_AS_OF_DATE_DISPLAY>01 January 2004</C_AS_OF_DATE_DISPLAY></G_CUSTOMER><C_COUNT_CUR>2</C_COUNT_CUR></ARXCOBLX>