Skip to content

Latest commit

 

History

History
231 lines (159 loc) · 7.71 KB

ReportsApi.md

File metadata and controls

231 lines (159 loc) · 7.71 KB
Raw

Spinen\ConnectWise\Clients\System\ReportsApi

Spinen's PHP ConnectWise Client for System API generated by Swagger Code Generator.

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
systemReportsGet GET /system/reports
systemReportsReportNameColumnsGet GET /system/reports/{reportName}/columns
systemReportsReportNameCountGet GET /system/reports/{reportName}/count
systemReportsReportNameGet GET /system/reports/{reportName}

systemReportsGet

\Spinen\ConnectWise\Clients\System\Model\Report[] systemReportsGet($conditions, $order_by, $childconditions, $customfieldconditions)

Get Reports

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\System\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\System\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\System\Api\ReportsApi();
$conditions = "conditions_example"; // string | 
$order_by = "order_by_example"; // string | 
$childconditions = "childconditions_example"; // string | 
$customfieldconditions = "customfieldconditions_example"; // string | 

try {
    $result = $api_instance->systemReportsGet($conditions, $order_by, $childconditions, $customfieldconditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->systemReportsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
conditions string [optional]
order_by string [optional]
childconditions string [optional]
customfieldconditions string [optional]

Return type

\Spinen\ConnectWise\Clients\System\Model\Report[]

Authorization

BasicAuth

HTTP request headers

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

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

systemReportsReportNameColumnsGet

\Spinen\ConnectWise\Clients\System\Model\JObject[] systemReportsReportNameColumnsGet($report_name)

Get Column Definitions

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\System\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\System\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\System\Api\ReportsApi();
$report_name = "report_name_example"; // string | 

try {
    $result = $api_instance->systemReportsReportNameColumnsGet($report_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->systemReportsReportNameColumnsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
report_name string

Return type

\Spinen\ConnectWise\Clients\System\Model\JObject[]

Authorization

BasicAuth

HTTP request headers

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

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

systemReportsReportNameCountGet

\Spinen\ConnectWise\Clients\System\Model\Count systemReportsReportNameCountGet($report_name, $conditions)

Get Report Results Count

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\System\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\System\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\System\Api\ReportsApi();
$report_name = "report_name_example"; // string | 
$conditions = "conditions_example"; // string | 

try {
    $result = $api_instance->systemReportsReportNameCountGet($report_name, $conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->systemReportsReportNameCountGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
report_name string
conditions string [optional]

Return type

\Spinen\ConnectWise\Clients\System\Model\Count

Authorization

BasicAuth

HTTP request headers

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

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

systemReportsReportNameGet

\Spinen\ConnectWise\Clients\System\Model\ReportDataResponse systemReportsReportNameGet($report_name, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size, $columns)

Get Report Results

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\System\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\System\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\System\Api\ReportsApi();
$report_name = "report_name_example"; // string | 
$conditions = "conditions_example"; // string | 
$order_by = "order_by_example"; // string | 
$childconditions = "childconditions_example"; // string | 
$customfieldconditions = "customfieldconditions_example"; // string | 
$page = 56; // int | 
$page_size = 56; // int | 
$columns = "columns_example"; // string | 

try {
    $result = $api_instance->systemReportsReportNameGet($report_name, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size, $columns);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->systemReportsReportNameGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
report_name string
conditions string [optional]
order_by string [optional]
childconditions string [optional]
customfieldconditions string [optional]
page int [optional]
page_size int [optional]
columns string [optional]

Return type

\Spinen\ConnectWise\Clients\System\Model\ReportDataResponse

Authorization

BasicAuth

HTTP request headers

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

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