Skip to content

Latest commit

 

History

History
288 lines (199 loc) · 10.9 KB

BoardSubtypeAssociationsApi.md

File metadata and controls

288 lines (199 loc) · 10.9 KB
Raw

Spinen\ConnectWise\Clients\Service\BoardSubtypeAssociationsApi

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
serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdDelete DELETE /service/boards/{boardId}/subTypes/{subtypeId}/associations/{associationId}
serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdGet GET /service/boards/{boardId}/subTypes/{subtypeId}/associations/{associationId}
serviceBoardsBoardIdSubTypesSubtypeIdAssociationsCountGet GET /service/boards/{boardId}/subTypes/{subtypeId}/associations/count
serviceBoardsBoardIdSubTypesSubtypeIdAssociationsGet GET /service/boards/{boardId}/subTypes/{subtypeId}/associations
serviceBoardsBoardIdSubTypesSubtypeIdAssociationsPost POST /service/boards/{boardId}/subTypes/{subtypeId}/associations

serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdDelete

serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdDelete($board_id, $subtype_id, $association_id)

Delete Subtype Association 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\BoardSubtypeAssociationsApi();
$board_id = 56; // int | 
$subtype_id = 56; // int | 
$association_id = 56; // int | 

try {
    $api_instance->serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdDelete($board_id, $subtype_id, $association_id);
} catch (Exception $e) {
    echo 'Exception when calling BoardSubtypeAssociationsApi->serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
board_id int
subtype_id int
association_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]

serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdGet

\Spinen\ConnectWise\Clients\Service\Model\SubtypeAssociation serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdGet($board_id, $subtype_id, $association_id)

Get Subtype Association 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\BoardSubtypeAssociationsApi();
$board_id = 56; // int | 
$subtype_id = 56; // int | 
$association_id = 56; // int | 

try {
    $result = $api_instance->serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdGet($board_id, $subtype_id, $association_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardSubtypeAssociationsApi->serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
board_id int
subtype_id int
association_id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\SubtypeAssociation

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]

serviceBoardsBoardIdSubTypesSubtypeIdAssociationsCountGet

\Spinen\ConnectWise\Clients\Service\Model\Count serviceBoardsBoardIdSubTypesSubtypeIdAssociationsCountGet($board_id, $subtype_id, $conditions)

Get Subtype Association 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\BoardSubtypeAssociationsApi();
$board_id = 56; // int | 
$subtype_id = 56; // int | 
$conditions = "conditions_example"; // string | 

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

Parameters

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

serviceBoardsBoardIdSubTypesSubtypeIdAssociationsGet

\Spinen\ConnectWise\Clients\Service\Model\SubtypeAssociation[] serviceBoardsBoardIdSubTypesSubtypeIdAssociationsGet($board_id, $subtype_id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Subtype Association

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

Parameters

Name Type Description Notes
board_id int
subtype_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\SubtypeAssociation[]

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]

serviceBoardsBoardIdSubTypesSubtypeIdAssociationsPost

\Spinen\ConnectWise\Clients\Service\Model\SubtypeAssociation serviceBoardsBoardIdSubTypesSubtypeIdAssociationsPost($board_id, $subtype_id, $subtype_association)

Create Subtype Association

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\BoardSubtypeAssociationsApi();
$board_id = 56; // int | 
$subtype_id = 56; // int | 
$subtype_association = new \Spinen\ConnectWise\Clients\Service\Model\SubtypeAssociation(); // \Spinen\ConnectWise\Clients\Service\Model\SubtypeAssociation | 

try {
    $result = $api_instance->serviceBoardsBoardIdSubTypesSubtypeIdAssociationsPost($board_id, $subtype_id, $subtype_association);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardSubtypeAssociationsApi->serviceBoardsBoardIdSubTypesSubtypeIdAssociationsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
board_id int
subtype_id int
subtype_association \Spinen\ConnectWise\Clients\Service\Model\SubtypeAssociation

Return type

\Spinen\ConnectWise\Clients\Service\Model\SubtypeAssociation

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]