Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.3 KB

SkillsApi.md

File metadata and controls

372 lines (249 loc) · 11.3 KB
Raw

Spinen\ConnectWise\Clients\System\SkillsApi

Spinen's PHP ConnectWise Client for System 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
systemSkillsCountGet GET /system/skills/count
systemSkillsGet GET /system/skills
systemSkillsIdDelete DELETE /system/skills/{id}
systemSkillsIdGet GET /system/skills/{id}
systemSkillsIdPatch PATCH /system/skills/{id}
systemSkillsIdPut PUT /system/skills/{id}
systemSkillsPost POST /system/skills

systemSkillsCountGet

\Spinen\ConnectWise\Clients\System\Model\Count systemSkillsCountGet($conditions)

Get Skill Count

Example

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

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

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

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

Parameters

Name Type Description Notes
conditions string [optional]

Return type

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

systemSkillsGet

\Spinen\ConnectWise\Clients\System\Model\Skill[] systemSkillsGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Skill

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\System\Api\SkillsApi();
$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->systemSkillsGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SkillsApi->systemSkillsGet: ', $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\System\Model\Skill[]

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]

systemSkillsIdDelete

systemSkillsIdDelete($id)

Delete Skill By Id

Example

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

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

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

try {
    $api_instance->systemSkillsIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling SkillsApi->systemSkillsIdDelete: ', $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]

systemSkillsIdGet

\Spinen\ConnectWise\Clients\System\Model\Skill systemSkillsIdGet($id)

Get Skill By Id

Example

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

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

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\System\Model\Skill

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]

systemSkillsIdPatch

\Spinen\ConnectWise\Clients\System\Model\Skill systemSkillsIdPatch($id, $operations)

Update Skill

Example

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

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

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\System\Model\Skill

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]

systemSkillsIdPut

\Spinen\ConnectWise\Clients\System\Model\Skill systemSkillsIdPut($id, $skill)

Replace Skill

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\System\Api\SkillsApi();
$id = 56; // int | 
$skill = new \Spinen\ConnectWise\Clients\System\Model\Skill(); // \Spinen\ConnectWise\Clients\System\Model\Skill | 

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

Parameters

Name Type Description Notes
id int
skill \Spinen\ConnectWise\Clients\System\Model\Skill

Return type

\Spinen\ConnectWise\Clients\System\Model\Skill

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]

systemSkillsPost

\Spinen\ConnectWise\Clients\System\Model\Skill systemSkillsPost($skill)

Create Skill

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\System\Api\SkillsApi();
$skill = new \Spinen\ConnectWise\Clients\System\Model\Skill(); // \Spinen\ConnectWise\Clients\System\Model\Skill | 

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

Parameters

Name Type Description Notes
skill \Spinen\ConnectWise\Clients\System\Model\Skill

Return type

\Spinen\ConnectWise\Clients\System\Model\Skill

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]