Spinen\ConnectWise\Clients\System\MenuEntriesApi

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
systemMenuentriesCountGet	GET /system/menuentries/count
systemMenuentriesGet	GET /system/menuentries
systemMenuentriesIdDelete	DELETE /system/menuentries/{id}
systemMenuentriesIdGet	GET /system/menuentries/{id}
systemMenuentriesIdImageGet	GET /system/menuentries/{id}/image
systemMenuentriesIdImagePost	POST /system/menuentries/{id}/image
systemMenuentriesIdPatch	PATCH /system/menuentries/{id}
systemMenuentriesIdPut	PUT /system/menuentries/{id}
systemMenuentriesPost	POST /system/menuentries

systemMenuentriesCountGet

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

Get Menu Entries 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\MenuEntriesApi();
$conditions = "conditions_example"; // string | 

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

systemMenuentriesGet

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

Get Menu Entries

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\MenuEntriesApi();
$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->systemMenuentriesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuEntriesApi->systemMenuentriesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	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\MenuEntry[]

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]

systemMenuentriesIdDelete

systemMenuentriesIdDelete($id)

Delete Menu Entry 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\MenuEntriesApi();
$id = 56; // int | 

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

systemMenuentriesIdGet

\Spinen\ConnectWise\Clients\System\Model\MenuEntry systemMenuentriesIdGet($id)

Get Menu Entry 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\MenuEntriesApi();
$id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

\Spinen\ConnectWise\Clients\System\Model\MenuEntry

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]

systemMenuentriesIdImageGet

systemMenuentriesIdImageGet($id, $lastmodified, $large_flag)

Get Menu Entry Image

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\MenuEntriesApi();
$id = 56; // int | 
$lastmodified = "lastmodified_example"; // string | 
$large_flag = true; // bool | 

try {
    $api_instance->systemMenuentriesIdImageGet($id, $lastmodified, $large_flag);
} catch (Exception $e) {
    echo 'Exception when calling MenuEntriesApi->systemMenuentriesIdImageGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
id	int
lastmodified	string	[optional]
large_flag	bool	[optional]

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

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

systemMenuentriesIdImagePost

systemMenuentriesIdImagePost($id, $file)

Upload Menu Entry Image

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\MenuEntriesApi();
$id = 56; // int | 
$file = "/path/to/file.txt"; // \SplFileObject | File to upload

try {
    $api_instance->systemMenuentriesIdImagePost($id, $file);
} catch (Exception $e) {
    echo 'Exception when calling MenuEntriesApi->systemMenuentriesIdImagePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
file	\SplFileObject	File to upload	[optional]

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

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

systemMenuentriesIdPatch

\Spinen\ConnectWise\Clients\System\Model\MenuEntry systemMenuentriesIdPatch($id, $operations)

Update Menu Entry

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

try {
    $result = $api_instance->systemMenuentriesIdPatch($id, $operations);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuEntriesApi->systemMenuentriesIdPatch: ', $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\MenuEntry

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]

systemMenuentriesIdPut

\Spinen\ConnectWise\Clients\System\Model\MenuEntry systemMenuentriesIdPut($id, $menu_entry)

Replace Menu Entry

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\MenuEntriesApi();
$id = 56; // int | 
$menu_entry = new \Spinen\ConnectWise\Clients\System\Model\MenuEntry(); // \Spinen\ConnectWise\Clients\System\Model\MenuEntry | 

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

Parameters

Name	Type	Description	Notes
id	int
menu_entry	\Spinen\ConnectWise\Clients\System\Model\MenuEntry

Return type

\Spinen\ConnectWise\Clients\System\Model\MenuEntry

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]

systemMenuentriesPost

\Spinen\ConnectWise\Clients\System\Model\MenuEntry systemMenuentriesPost($menu_entry)

Create Menu Entry

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\MenuEntriesApi();
$menu_entry = new \Spinen\ConnectWise\Clients\System\Model\MenuEntry(); // \Spinen\ConnectWise\Clients\System\Model\MenuEntry | 

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

Parameters

Name	Type	Description	Notes
menu_entry	\Spinen\ConnectWise\Clients\System\Model\MenuEntry

Return type

\Spinen\ConnectWise\Clients\System\Model\MenuEntry

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]

Files

MenuEntriesApi.md

Latest commit

History

MenuEntriesApi.md

File metadata and controls

Spinen\ConnectWise\Clients\System\MenuEntriesApi

systemMenuentriesCountGet

Example

Parameters

Return type

Authorization

HTTP request headers

systemMenuentriesGet

Example

Parameters

Return type

Authorization

HTTP request headers

systemMenuentriesIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

systemMenuentriesIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

systemMenuentriesIdImageGet

Example

Parameters

Return type

Authorization

HTTP request headers

systemMenuentriesIdImagePost

Example

Parameters

Return type

Authorization

HTTP request headers

systemMenuentriesIdPatch

Example

Parameters

Return type

Authorization

HTTP request headers

systemMenuentriesIdPut

Example

Parameters

Return type

Authorization

HTTP request headers

systemMenuentriesPost

Example

Parameters

Return type

Authorization

HTTP request headers