Skip to content

Latest commit

 

History

History
672 lines (490 loc) · 19.3 KB

DatawarehouseApi.md

File metadata and controls

672 lines (490 loc) · 19.3 KB
Raw

com.ultracart.admin.v2.Api.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

void DeleteReport (int? reportOid)

Delete a report

Delete a report on the UltraCart account.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class DeleteReportExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new DatawarehouseApi(simpleKey);

            var reportOid = 56;  // int? | The report oid to delete.

            try
            {
                // Delete a report
                apiInstance.DeleteReport(reportOid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatawarehouseApi.DeleteReport: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
reportOid 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

ReportDryRunQueriesResponse DryRunReportQueries (ReportDryRunQueriesRequest queryRequest)

Dry run the report queries

Dry run the report queries

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class DryRunReportQueriesExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new DatawarehouseApi(simpleKey);

            var queryRequest = new ReportDryRunQueriesRequest(); // ReportDryRunQueriesRequest | Dry run request

            try
            {
                // Dry run the report queries
                ReportDryRunQueriesResponse result = apiInstance.DryRunReportQueries(queryRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatawarehouseApi.DryRunReportQueries: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
queryRequest ReportDryRunQueriesRequest Dry run request

Return type

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

void ExecuteReportQueries (ReportExecuteQueriesRequest queryRequest)

Execute the report queries

Execute the report queries

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class ExecuteReportQueriesExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new DatawarehouseApi(simpleKey);

            var queryRequest = new ReportExecuteQueriesRequest(); // ReportExecuteQueriesRequest | Query request

            try
            {
                // Execute the report queries
                apiInstance.ExecuteReportQueries(queryRequest);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatawarehouseApi.ExecuteReportQueries: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
queryRequest 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

ReportResponse GetReport (int? reportOid)

Get a report

Retrieve a report

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class GetReportExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new DatawarehouseApi(simpleKey);

            var reportOid = 56;  // int? | 

            try
            {
                // Get a report
                ReportResponse result = apiInstance.GetReport(reportOid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatawarehouseApi.GetReport: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
reportOid int?

Return type

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

ReportDataSetResponse GetReportDataSet (string datasetUuid)

Get a report data set

Retrieve a report data set

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class GetReportDataSetExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new DatawarehouseApi(simpleKey);

            var datasetUuid = datasetUuid_example;  // string | 

            try
            {
                // Get a report data set
                ReportDataSetResponse result = apiInstance.GetReportDataSet(datasetUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatawarehouseApi.GetReportDataSet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
datasetUuid string

Return type

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

ReportDataSetPageResponse GetReportDataSetPage (string datasetUuid, int? pageNumber)

Get a report data set page

Retrieve a report data set page

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class GetReportDataSetPageExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new DatawarehouseApi(simpleKey);

            var datasetUuid = datasetUuid_example;  // string | 
            var pageNumber = 56;  // int? | 

            try
            {
                // Get a report data set page
                ReportDataSetPageResponse result = apiInstance.GetReportDataSetPage(datasetUuid, pageNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatawarehouseApi.GetReportDataSetPage: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
datasetUuid string
pageNumber int?

Return type

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

ReportAuthResponse GetReportWebsocketAuthorization ()

Get report websocket authorization

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

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class GetReportWebsocketAuthorizationExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new DatawarehouseApi(simpleKey);


            try
            {
                // Get report websocket authorization
                ReportAuthResponse result = apiInstance.GetReportWebsocketAuthorization();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatawarehouseApi.GetReportWebsocketAuthorization: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

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

ReportsResponse GetReports ()

Get list of reports available

Retrieve a list of reports available

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class GetReportsExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new DatawarehouseApi(simpleKey);


            try
            {
                // Get list of reports available
                ReportsResponse result = apiInstance.GetReports();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatawarehouseApi.GetReports: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

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

ReportResponse InsertReport (Report report)

Create a report

Create a new report on the UltraCart account.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class InsertReportExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new DatawarehouseApi(simpleKey);

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

            try
            {
                // Create a report
                ReportResponse result = apiInstance.InsertReport(report);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatawarehouseApi.InsertReport: " + e.Message );
            }
        }
    }
}

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

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

UpdateReport

ReportResponse UpdateReport (Report report, int? reportOid)

Update a report

Update a report on the UltraCart account.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class UpdateReportExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new DatawarehouseApi(simpleKey);

            var report = new Report(); // Report | Report to update
            var reportOid = 56;  // int? | The report oid to update.

            try
            {
                // Update a report
                ReportResponse result = apiInstance.UpdateReport(report, reportOid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatawarehouseApi.UpdateReport: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
report Report Report to update
reportOid int? The report oid to update.

Return type

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]