Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.3 KB

BoardsApi.md

File metadata and controls

372 lines (249 loc) · 11.3 KB

Spinen\ConnectWise\Clients\Service\BoardsApi

Spinen's PHP ConnectWise Client for Service 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
serviceBoardsCountGet GET /service/boards/count
serviceBoardsGet GET /service/boards
serviceBoardsIdDelete DELETE /service/boards/{id}
serviceBoardsIdGet GET /service/boards/{id}
serviceBoardsIdPatch PATCH /service/boards/{id}
serviceBoardsIdPut PUT /service/boards/{id}
serviceBoardsPost POST /service/boards

serviceBoardsCountGet

\Spinen\ConnectWise\Clients\Service\Model\Count serviceBoardsCountGet($conditions)

Get Boards Count

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardsApi();
$conditions = "conditions_example"; // string | 

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

Parameters

Name Type Description Notes
conditions string [optional]

Return type

\Spinen\ConnectWise\Clients\Service\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]

serviceBoardsGet

\Spinen\ConnectWise\Clients\Service\Model\Board[] serviceBoardsGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Boards

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardsApi();
$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 | 

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Board[]

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]

serviceBoardsIdDelete

serviceBoardsIdDelete($id)

Delete Board By Id

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardsApi();
$id = 56; // int | 

try {
    $api_instance->serviceBoardsIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling BoardsApi->serviceBoardsIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

serviceBoardsIdGet

\Spinen\ConnectWise\Clients\Service\Model\Board serviceBoardsIdGet($id)

Get Board By Id

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardsApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\Board

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]

serviceBoardsIdPatch

\Spinen\ConnectWise\Clients\Service\Model\Board serviceBoardsIdPatch($id, $operations)

Update Board

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardsApi();
$id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\Service\Model\PatchOperation[] | 

try {
    $result = $api_instance->serviceBoardsIdPatch($id, $operations);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardsApi->serviceBoardsIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
operations \Spinen\ConnectWise\Clients\Service\Model\PatchOperation[]

Return type

\Spinen\ConnectWise\Clients\Service\Model\Board

Authorization

BasicAuth

HTTP request headers

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

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

serviceBoardsIdPut

\Spinen\ConnectWise\Clients\Service\Model\Board serviceBoardsIdPut($id, $board)

Replace Board

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardsApi();
$id = 56; // int | 
$board = new \Spinen\ConnectWise\Clients\Service\Model\Board(); // \Spinen\ConnectWise\Clients\Service\Model\Board | 

try {
    $result = $api_instance->serviceBoardsIdPut($id, $board);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardsApi->serviceBoardsIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
board \Spinen\ConnectWise\Clients\Service\Model\Board

Return type

\Spinen\ConnectWise\Clients\Service\Model\Board

Authorization

BasicAuth

HTTP request headers

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

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

serviceBoardsPost

\Spinen\ConnectWise\Clients\Service\Model\Board serviceBoardsPost($board)

Create Board

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardsApi();
$board = new \Spinen\ConnectWise\Clients\Service\Model\Board(); // \Spinen\ConnectWise\Clients\Service\Model\Board | 

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

Parameters

Name Type Description Notes
board \Spinen\ConnectWise\Clients\Service\Model\Board

Return type

\Spinen\ConnectWise\Clients\Service\Model\Board

Authorization

BasicAuth

HTTP request headers

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

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