Skip to content

Latest commit

 

History

History
386 lines (263 loc) · 12.3 KB

BoardTeamsApi.md

File metadata and controls

386 lines (263 loc) · 12.3 KB
Raw

Spinen\ConnectWise\Clients\Service\BoardTeamsApi

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
serviceBoardsIdTeamsCountGet GET /service/boards/{id}/teams/count
serviceBoardsIdTeamsGet GET /service/boards/{id}/teams
serviceBoardsIdTeamsPost POST /service/boards/{id}/teams
serviceBoardsIdTeamsTeamIdDelete DELETE /service/boards/{id}/teams/{teamId}
serviceBoardsIdTeamsTeamIdGet GET /service/boards/{id}/teams/{teamId}
serviceBoardsIdTeamsTeamIdPatch PATCH /service/boards/{id}/teams/{teamId}
serviceBoardsIdTeamsTeamIdPut PUT /service/boards/{id}/teams/{teamId}

serviceBoardsIdTeamsCountGet

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

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

try {
    $result = $api_instance->serviceBoardsIdTeamsCountGet($id, $conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardTeamsApi->serviceBoardsIdTeamsCountGet: ', $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]

serviceBoardsIdTeamsGet

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

Get Teams

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\BoardTeamsApi();
$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->serviceBoardsIdTeamsGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardTeamsApi->serviceBoardsIdTeamsGet: ', $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\Team[]

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]

serviceBoardsIdTeamsPost

\Spinen\ConnectWise\Clients\Service\Model\Team serviceBoardsIdTeamsPost($id, $team)

Create Team

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

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

Parameters

Name Type Description Notes
id int
team \Spinen\ConnectWise\Clients\Service\Model\Team

Return type

\Spinen\ConnectWise\Clients\Service\Model\Team

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]

serviceBoardsIdTeamsTeamIdDelete

serviceBoardsIdTeamsTeamIdDelete($id, $team_id)

Delete Team 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\BoardTeamsApi();
$id = 56; // int | 
$team_id = 56; // int | 

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

Parameters

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

serviceBoardsIdTeamsTeamIdGet

\Spinen\ConnectWise\Clients\Service\Model\Team serviceBoardsIdTeamsTeamIdGet($id, $team_id)

Get Team 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\BoardTeamsApi();
$id = 56; // int | 
$team_id = 56; // int | 

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

Parameters

Name Type Description Notes
id int
team_id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\Team

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]

serviceBoardsIdTeamsTeamIdPatch

\Spinen\ConnectWise\Clients\Service\Model\Team serviceBoardsIdTeamsTeamIdPatch($id, $team_id, $operations)

Update Team

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Team

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]

serviceBoardsIdTeamsTeamIdPut

\Spinen\ConnectWise\Clients\Service\Model\Team serviceBoardsIdTeamsTeamIdPut($id, $team_id, $team)

Replace Team

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\BoardTeamsApi();
$id = 56; // int | 
$team_id = 56; // int | 
$team = new \Spinen\ConnectWise\Clients\Service\Model\Team(); // \Spinen\ConnectWise\Clients\Service\Model\Team | 

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

Parameters

Name Type Description Notes
id int
team_id int
team \Spinen\ConnectWise\Clients\Service\Model\Team

Return type

\Spinen\ConnectWise\Clients\Service\Model\Team

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]