Skip to content

Latest commit

 

History

History
492 lines (330 loc) · 15.7 KB

DatawarehouseApi.md

File metadata and controls

492 lines (330 loc) · 15.7 KB
Raw

ultracart\v2\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\DatawarehouseApi::usingApiKey($simple_key);

$report_oid = 56; // int | The report oid to delete.

try {
    $apiInstance->deleteReport($report_oid);
} catch (Exception $e) {
    echo 'Exception when calling DatawarehouseApi->deleteReport: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dryRunReportQueries

\ultracart\v2\models\ReportDryRunQueriesResponse dryRunReportQueries($query_request)

Dry run the report queries

Dry run the report queries

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\DatawarehouseApi::usingApiKey($simple_key);

$query_request = new \ultracart\v2\models\ReportDryRunQueriesRequest(); // \ultracart\v2\models\ReportDryRunQueriesRequest | Dry run request

try {
    $result = $apiInstance->dryRunReportQueries($query_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatawarehouseApi->dryRunReportQueries: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
query_request \ultracart\v2\models\ReportDryRunQueriesRequest Dry run request

Return type

\ultracart\v2\models\ReportDryRunQueriesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

executeReportQueries

executeReportQueries($query_request)

Execute the report queries

Execute the report queries

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\DatawarehouseApi::usingApiKey($simple_key);

$query_request = new \ultracart\v2\models\ReportExecuteQueriesRequest(); // \ultracart\v2\models\ReportExecuteQueriesRequest | Query request

try {
    $apiInstance->executeReportQueries($query_request);
} catch (Exception $e) {
    echo 'Exception when calling DatawarehouseApi->executeReportQueries: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
query_request \ultracart\v2\models\ReportExecuteQueriesRequest Query request

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getReport

\ultracart\v2\models\ReportResponse getReport($report_oid)

Get a report

Retrieve a report

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\DatawarehouseApi::usingApiKey($simple_key);

$report_oid = 56; // int | 

try {
    $result = $apiInstance->getReport($report_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatawarehouseApi->getReport: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
report_oid int

Return type

\ultracart\v2\models\ReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getReportDataSet

\ultracart\v2\models\ReportDataSetResponse getReportDataSet($dataset_uuid)

Get a report data set

Retrieve a report data set

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\DatawarehouseApi::usingApiKey($simple_key);

$dataset_uuid = "dataset_uuid_example"; // string | 

try {
    $result = $apiInstance->getReportDataSet($dataset_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatawarehouseApi->getReportDataSet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
dataset_uuid string

Return type

\ultracart\v2\models\ReportDataSetResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getReportDataSetPage

\ultracart\v2\models\ReportDataSetPageResponse getReportDataSetPage($dataset_uuid, $page_number)

Get a report data set page

Retrieve a report data set page

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\DatawarehouseApi::usingApiKey($simple_key);

$dataset_uuid = "dataset_uuid_example"; // string | 
$page_number = 56; // int | 

try {
    $result = $apiInstance->getReportDataSetPage($dataset_uuid, $page_number);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatawarehouseApi->getReportDataSetPage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
dataset_uuid string
page_number int

Return type

\ultracart\v2\models\ReportDataSetPageResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getReportWebsocketAuthorization

\ultracart\v2\models\ReportAuthResponse getReportWebsocketAuthorization()

Get report websocket authorization

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\DatawarehouseApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getReportWebsocketAuthorization();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatawarehouseApi->getReportWebsocketAuthorization: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ReportAuthResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getReports

\ultracart\v2\models\ReportsResponse getReports()

Get list of reports available

Retrieve a list of reports available

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\DatawarehouseApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getReports();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatawarehouseApi->getReports: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ReportsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertReport

\ultracart\v2\models\ReportResponse insertReport($report)

Create a report

Create a new report on the UltraCart account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\DatawarehouseApi::usingApiKey($simple_key);

$report = new \ultracart\v2\models\Report(); // \ultracart\v2\models\Report | Report to create

try {
    $result = $apiInstance->insertReport($report);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatawarehouseApi->insertReport: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
report \ultracart\v2\models\Report Report to create

Return type

\ultracart\v2\models\ReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateReport

\ultracart\v2\models\ReportResponse updateReport($report, $report_oid)

Update a report

Update a report on the UltraCart account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\DatawarehouseApi::usingApiKey($simple_key);

$report = new \ultracart\v2\models\Report(); // \ultracart\v2\models\Report | Report to update
$report_oid = 56; // int | The report oid to update.

try {
    $result = $apiInstance->updateReport($report, $report_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatawarehouseApi->updateReport: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
report \ultracart\v2\models\Report Report to update
report_oid int The report oid to update.

Return type

\ultracart\v2\models\ReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]