Skip to content

Latest commit

 

History

History
514 lines (342 loc) · 14.3 KB

DatawarehouseApi.md

File metadata and controls

514 lines (342 loc) · 14.3 KB
Raw

UltraCartRestApiV2.DatawarehouseApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method HTTP request Description
deleteReport DELETE /datawarehouse/reports/{report_oid} Delete a report
dryRunReportQueries PUT /datawarehouse/reports/dryrun Dry run the report queries
executeReportQueries PUT /datawarehouse/reports/execute Execute the report queries
getReport GET /datawarehouse/reports/{report_oid} Get a report
getReportDataSet GET /datawarehouse/reports/dataset/{dataset_uuid} Get a report data set
getReportDataSetPage GET /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} Get a report data set page
getReportWebsocketAuthorization PUT /datawarehouse/reports/auth Get report websocket authorization
getReports GET /datawarehouse/reports Get list of reports available
insertReport POST /datawarehouse/reports Create a report
updateReport PUT /datawarehouse/reports/{report_oid} Update a report

deleteReport

deleteReport(report_oid)

Delete a report

Delete a report on the UltraCart account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.DatawarehouseApi();


var report_oid = 56; // Number | The report oid to delete.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteReport(report_oid, callback);

Parameters

Name Type Description Notes
report_oid Number The report oid to delete.

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

dryRunReportQueries

ReportDryRunQueriesResponse dryRunReportQueries(query_request)

Dry run the report queries

Dry run the report queries

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.DatawarehouseApi();


var query_request = new UltraCartRestApiV2.ReportDryRunQueriesRequest(); // ReportDryRunQueriesRequest | Dry run request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.dryRunReportQueries(query_request, callback);

Parameters

Name Type Description Notes
query_request ReportDryRunQueriesRequest Dry run request

Return type

ReportDryRunQueriesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

executeReportQueries

executeReportQueries(query_request)

Execute the report queries

Execute the report queries

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.DatawarehouseApi();


var query_request = new UltraCartRestApiV2.ReportExecuteQueriesRequest(); // ReportExecuteQueriesRequest | Query request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.executeReportQueries(query_request, callback);

Parameters

Name Type Description Notes
query_request ReportExecuteQueriesRequest Query request

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getReport

ReportResponse getReport(report_oid)

Get a report

Retrieve a report

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.DatawarehouseApi();


var report_oid = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getReport(report_oid, callback);

Parameters

Name Type Description Notes
report_oid Number

Return type

ReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getReportDataSet

ReportDataSetResponse getReportDataSet(dataset_uuid)

Get a report data set

Retrieve a report data set

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.DatawarehouseApi();


var dataset_uuid = "dataset_uuid_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getReportDataSet(dataset_uuid, callback);

Parameters

Name Type Description Notes
dataset_uuid String

Return type

ReportDataSetResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getReportDataSetPage

ReportDataSetPageResponse getReportDataSetPage(dataset_uuid, page_number)

Get a report data set page

Retrieve a report data set page

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.DatawarehouseApi();


var dataset_uuid = "dataset_uuid_example"; // String | 

var page_number = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getReportDataSetPage(dataset_uuid, page_number, callback);

Parameters

Name Type Description Notes
dataset_uuid String
page_number Number

Return type

ReportDataSetPageResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getReportWebsocketAuthorization

ReportAuthResponse getReportWebsocketAuthorization()

Get report websocket authorization

Retrieve a JWT to authorize a report to make a websocket connection.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.DatawarehouseApi();



var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getReportWebsocketAuthorization(callback);

Parameters

This endpoint does not need any parameter.

Return type

ReportAuthResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getReports

ReportsResponse getReports()

Get list of reports available

Retrieve a list of reports available

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.DatawarehouseApi();



var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getReports(callback);

Parameters

This endpoint does not need any parameter.

Return type

ReportsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

insertReport

ReportResponse insertReport(report)

Create a report

Create a new report on the UltraCart account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.DatawarehouseApi();


var report = new UltraCartRestApiV2.Report(); // Report | Report to create


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.insertReport(report, callback);

Parameters

Name Type Description Notes
report Report Report to create

Return type

ReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json; charset=UTF-8
  • Accept: application/json

updateReport

ReportResponse updateReport(report, report_oid)

Update a report

Update a report on the UltraCart account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.DatawarehouseApi();


var report = new UltraCartRestApiV2.Report(); // Report | Report to update

var report_oid = 56; // Number | The report oid to update.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateReport(report, report_oid, callback);

Parameters

Name Type Description Notes
report Report Report to update
report_oid Number The report oid to update.

Return type

ReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json; charset=UTF-8
  • Accept: application/json