Skip to content

Latest commit

 

History

History
386 lines (263 loc) · 12.3 KB

BoardItemsApi.md

File metadata and controls

386 lines (263 loc) · 12.3 KB
Raw

Spinen\ConnectWise\Clients\Service\BoardItemsApi

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
serviceBoardsIdItemsCountGet GET /service/boards/{id}/items/count
serviceBoardsIdItemsGet GET /service/boards/{id}/items
serviceBoardsIdItemsItemIdDelete DELETE /service/boards/{id}/items/{itemId}
serviceBoardsIdItemsItemIdGet GET /service/boards/{id}/items/{itemId}
serviceBoardsIdItemsItemIdPatch PATCH /service/boards/{id}/items/{itemId}
serviceBoardsIdItemsItemIdPut PUT /service/boards/{id}/items/{itemId}
serviceBoardsIdItemsPost POST /service/boards/{id}/items

serviceBoardsIdItemsCountGet

\Spinen\ConnectWise\Clients\Service\Model\Count serviceBoardsIdItemsCountGet($id, $conditions)

Get Items 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\BoardItemsApi();
$id = 56; // int | 
$conditions = "conditions_example"; // string | 

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

Parameters

Name Type Description Notes
id int
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]

serviceBoardsIdItemsGet

\Spinen\ConnectWise\Clients\Service\Model\Item[] serviceBoardsIdItemsGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Items

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\BoardItemsApi();
$id = 56; // int | 
$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->serviceBoardsIdItemsGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardItemsApi->serviceBoardsIdItemsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
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\Item[]

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]

serviceBoardsIdItemsItemIdDelete

serviceBoardsIdItemsItemIdDelete($id, $item_id)

Delete Item 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\BoardItemsApi();
$id = 56; // int | 
$item_id = 56; // int | 

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

Parameters

Name Type Description Notes
id int
item_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]

serviceBoardsIdItemsItemIdGet

\Spinen\ConnectWise\Clients\Service\Model\Item serviceBoardsIdItemsItemIdGet($id, $item_id)

Get Item 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\BoardItemsApi();
$id = 56; // int | 
$item_id = 56; // int | 

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

Parameters

Name Type Description Notes
id int
item_id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\Item

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]

serviceBoardsIdItemsItemIdPatch

\Spinen\ConnectWise\Clients\Service\Model\Item serviceBoardsIdItemsItemIdPatch($id, $item_id, $operations)

Update Item

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\BoardItemsApi();
$id = 56; // int | 
$item_id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\Service\Model\PatchOperation[] | 

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Item

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]

serviceBoardsIdItemsItemIdPut

\Spinen\ConnectWise\Clients\Service\Model\Item serviceBoardsIdItemsItemIdPut($id, $item_id, $item)

Replace Item

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\BoardItemsApi();
$id = 56; // int | 
$item_id = 56; // int | 
$item = new \Spinen\ConnectWise\Clients\Service\Model\Item(); // \Spinen\ConnectWise\Clients\Service\Model\Item | 

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

Parameters

Name Type Description Notes
id int
item_id int
item \Spinen\ConnectWise\Clients\Service\Model\Item

Return type

\Spinen\ConnectWise\Clients\Service\Model\Item

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]

serviceBoardsIdItemsPost

\Spinen\ConnectWise\Clients\Service\Model\Item serviceBoardsIdItemsPost($id, $item)

Create Item

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\BoardItemsApi();
$id = 56; // int | 
$item = new \Spinen\ConnectWise\Clients\Service\Model\Item(); // \Spinen\ConnectWise\Clients\Service\Model\Item | 

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

Parameters

Name Type Description Notes
id int
item \Spinen\ConnectWise\Clients\Service\Model\Item

Return type

\Spinen\ConnectWise\Clients\Service\Model\Item

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]