Skip to content

Latest commit

 

History

History
280 lines (202 loc) · 9.44 KB

WikiPageApi.md

File metadata and controls

280 lines (202 loc) · 9.44 KB

VereTech\SyncroMSP_PHPclient\Client\WikiPageApi

All URIs are relative to https://{subdomain}.syncromsp.com/api/v1

Method HTTP request Description
wikiPagesGet GET /wiki_pages Returns a paginated list of Wiki Pages
wikiPagesIdDelete DELETE /wiki_pages/{id} Deletes a Wiki Page by ID
wikiPagesIdGet GET /wiki_pages/{id} Retrieves a Wiki Page
wikiPagesIdPut PUT /wiki_pages/{id} Updates an existing Wiki Page by ID
wikiPagesPost POST /wiki_pages Creates a Wiki Page

wikiPagesGet

wikiPagesGet($page)

Returns a paginated list of Wiki Pages

Required permission: Documentation - Allow Usage

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\WikiPageApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 56; // int | Returns provided page of results, each 'page' contains 100 result

try {
    $apiInstance->wikiPagesGet($page);
} catch (Exception $e) {
    echo 'Exception when calling WikiPageApi->wikiPagesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
page int Returns provided page of results, each 'page' contains 100 result [optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

wikiPagesIdDelete

wikiPagesIdDelete($id)

Deletes a Wiki Page by ID

Required permission: Documentation - Delete

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\WikiPageApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 

try {
    $apiInstance->wikiPagesIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling WikiPageApi->wikiPagesIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

wikiPagesIdGet

\VereTech\SyncroMSP_PHPclient\Client\Model\InlineResponse2006 wikiPagesIdGet($id)

Retrieves a Wiki Page

Required permission: Documentation - Allow Usage

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\WikiPageApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\VereTech\SyncroMSP_PHPclient\Client\Model\InlineResponse2006

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

wikiPagesIdPut

wikiPagesIdPut($id, $body)

Updates an existing Wiki Page by ID

Required permission: Documentation - Edit

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\WikiPageApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 
$body = new \VereTech\SyncroMSP_PHPclient\Client\Model\WikiPagesIdBody(); // \VereTech\SyncroMSP_PHPclient\Client\Model\WikiPagesIdBody | Wiki Page object that needs to be updated

try {
    $apiInstance->wikiPagesIdPut($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling WikiPageApi->wikiPagesIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
body \VereTech\SyncroMSP_PHPclient\Client\Model\WikiPagesIdBody Wiki Page object that needs to be updated [optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

wikiPagesPost

wikiPagesPost($body)

Creates a Wiki Page

Required permission: Documentation - Create

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\WikiPageApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \VereTech\SyncroMSP_PHPclient\Client\Model\WikiPagesBody(); // \VereTech\SyncroMSP_PHPclient\Client\Model\WikiPagesBody | Wiki Page object that needs to be added

try {
    $apiInstance->wikiPagesPost($body);
} catch (Exception $e) {
    echo 'Exception when calling WikiPageApi->wikiPagesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \VereTech\SyncroMSP_PHPclient\Client\Model\WikiPagesBody Wiki Page object that needs to be added [optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]