cybersource-rest-client
Version:
Node.js SDK for the CyberSource REST API
63 lines (41 loc) • 2.9 kB
Markdown
//apitest.cybersource.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**downloadReport**](ReportDownloadsApi.md
<a name="downloadReport"></a>
> downloadReport(reportDate, reportName, opts)
Download a Report
Download a report using the unique report name and date.
```javascript
var CyberSource = require('CyberSource');
var apiInstance = new CyberSource.ReportDownloadsApi();
var reportDate = new Date("2013-10-20"); // Date | Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10
var reportName = "reportName_example"; // String | Name of the report to download
var opts = {
'organizationId': "organizationId_example" // String | Valid Organization Id
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.downloadReport(reportDate, reportName, opts, callback);
```
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**reportDate** | **Date**| Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10 |
**reportName** | **String**| Name of the report to download |
**organizationId** | **String**| Valid Organization Id | [optional]
null (empty response body)
No authorization required
- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/xml, text/csv
All URIs are relative to *https: