Skip to content

Latest commit

 

History

History
386 lines (263 loc) · 12.7 KB

BoardStatusesApi.md

File metadata and controls

386 lines (263 loc) · 12.7 KB

Spinen\ConnectWise\Clients\Service\BoardStatusesApi

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
serviceBoardsIdStatusesCountGet GET /service/boards/{id}/statuses/count
serviceBoardsIdStatusesGet GET /service/boards/{id}/statuses
serviceBoardsIdStatusesPost POST /service/boards/{id}/statuses
serviceBoardsIdStatusesStatusIdDelete DELETE /service/boards/{id}/statuses/{statusId}
serviceBoardsIdStatusesStatusIdGet GET /service/boards/{id}/statuses/{statusId}
serviceBoardsIdStatusesStatusIdPatch PATCH /service/boards/{id}/statuses/{statusId}
serviceBoardsIdStatusesStatusIdPut PUT /service/boards/{id}/statuses/{statusId}

serviceBoardsIdStatusesCountGet

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

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

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

serviceBoardsIdStatusesGet

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

Get Statuses

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

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]

serviceBoardsIdStatusesPost

\Spinen\ConnectWise\Clients\Service\Model\Status serviceBoardsIdStatusesPost($id, $status)

Create Statuses

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

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

Parameters

Name Type Description Notes
id int
status \Spinen\ConnectWise\Clients\Service\Model\Status

Return type

\Spinen\ConnectWise\Clients\Service\Model\Status

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]

serviceBoardsIdStatusesStatusIdDelete

serviceBoardsIdStatusesStatusIdDelete($id, $status_id)

Delete Status 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\BoardStatusesApi();
$id = 56; // int | 
$status_id = 56; // int | 

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

Parameters

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

serviceBoardsIdStatusesStatusIdGet

\Spinen\ConnectWise\Clients\Service\Model\Status serviceBoardsIdStatusesStatusIdGet($id, $status_id)

Get Status 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\BoardStatusesApi();
$id = 56; // int | 
$status_id = 56; // int | 

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

Parameters

Name Type Description Notes
id int
status_id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\Status

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]

serviceBoardsIdStatusesStatusIdPatch

\Spinen\ConnectWise\Clients\Service\Model\Status serviceBoardsIdStatusesStatusIdPatch($id, $status_id, $operations)

Update Status

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Status

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]

serviceBoardsIdStatusesStatusIdPut

\Spinen\ConnectWise\Clients\Service\Model\Status serviceBoardsIdStatusesStatusIdPut($id, $status_id, $status)

Replace Statuses

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\BoardStatusesApi();
$id = 56; // int | 
$status_id = 56; // int | 
$status = new \Spinen\ConnectWise\Clients\Service\Model\Status(); // \Spinen\ConnectWise\Clients\Service\Model\Status | 

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

Parameters

Name Type Description Notes
id int
status_id int
status \Spinen\ConnectWise\Clients\Service\Model\Status

Return type

\Spinen\ConnectWise\Clients\Service\Model\Status

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]