Skip to content

Latest commit

 

History

History
374 lines (251 loc) · 13.1 KB

KnowledgeBaseArticlesApi.md

File metadata and controls

374 lines (251 loc) · 13.1 KB
Raw

Spinen\ConnectWise\Clients\Service\KnowledgeBaseArticlesApi

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
serviceKnowledgeBaseArticlesCountGet GET /service/knowledgeBaseArticles/count
serviceKnowledgeBaseArticlesGet GET /service/knowledgeBaseArticles
serviceKnowledgeBaseArticlesIdDelete DELETE /service/knowledgeBaseArticles/{id}
serviceKnowledgeBaseArticlesIdGet GET /service/knowledgeBaseArticles/{id}
serviceKnowledgeBaseArticlesIdPatch PATCH /service/knowledgeBaseArticles/{id}
serviceKnowledgeBaseArticlesIdPut PUT /service/knowledgeBaseArticles/{id}
serviceKnowledgeBaseArticlesPost POST /service/knowledgeBaseArticles

serviceKnowledgeBaseArticlesCountGet

\Spinen\ConnectWise\Clients\Service\Model\Count serviceKnowledgeBaseArticlesCountGet($conditions, $custom_field_conditions)

Get Knowledge Base Articles 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\KnowledgeBaseArticlesApi();
$conditions = "conditions_example"; // string | 
$custom_field_conditions = "custom_field_conditions_example"; // string | 

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

Parameters

Name Type Description Notes
conditions string [optional]
custom_field_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]

serviceKnowledgeBaseArticlesGet

\Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle[] serviceKnowledgeBaseArticlesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Knowledge Base Articles

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\KnowledgeBaseArticlesApi();
$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->serviceKnowledgeBaseArticlesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeBaseArticlesApi->serviceKnowledgeBaseArticlesGet: ', $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\Service\Model\KnowledgeBaseArticle[]

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]

serviceKnowledgeBaseArticlesIdDelete

serviceKnowledgeBaseArticlesIdDelete($id)

Delete Knowledge Base Article 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\KnowledgeBaseArticlesApi();
$id = 56; // int | 

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

serviceKnowledgeBaseArticlesIdGet

\Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle serviceKnowledgeBaseArticlesIdGet($id)

Get Knowledge Base Article 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\KnowledgeBaseArticlesApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle

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]

serviceKnowledgeBaseArticlesIdPatch

\Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle serviceKnowledgeBaseArticlesIdPatch($id, $operations)

Update Knowledge Base Article

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle

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]

serviceKnowledgeBaseArticlesIdPut

\Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle serviceKnowledgeBaseArticlesIdPut($id, $knowledge_base_article)

Replace Knowledge Base Article

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

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

Parameters

Name Type Description Notes
id int
knowledge_base_article \Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle

Return type

\Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle

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]

serviceKnowledgeBaseArticlesPost

\Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle serviceKnowledgeBaseArticlesPost($knowledge_base_article)

Create Knowledge Base Article

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\KnowledgeBaseArticlesApi();
$knowledge_base_article = new \Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle(); // \Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle | 

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

Parameters

Name Type Description Notes
knowledge_base_article \Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle

Return type

\Spinen\ConnectWise\Clients\Service\Model\KnowledgeBaseArticle

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]