Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 12.5 KB

UserDefinedFieldsApi.md

File metadata and controls

372 lines (249 loc) · 12.5 KB
Raw

Spinen\ConnectWise\Clients\System\UserDefinedFieldsApi

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
systemUserDefinedFieldsCountGet GET /system/userDefinedFields/count
systemUserDefinedFieldsGet GET /system/userDefinedFields
systemUserDefinedFieldsIdDelete DELETE /system/userDefinedFields/{id}
systemUserDefinedFieldsIdGet GET /system/userDefinedFields/{id}
systemUserDefinedFieldsIdPatch PATCH /system/userDefinedFields/{id}
systemUserDefinedFieldsIdPut PUT /system/userDefinedFields/{id}
systemUserDefinedFieldsPost POST /system/userDefinedFields

systemUserDefinedFieldsCountGet

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

Get User Defined Fields 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\UserDefinedFieldsApi();
$conditions = "conditions_example"; // string | 

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

systemUserDefinedFieldsGet

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

Get User Defined Fields

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

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]

systemUserDefinedFieldsIdDelete

systemUserDefinedFieldsIdDelete($id)

Delete User Defined Field 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\UserDefinedFieldsApi();
$id = 56; // int | 

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

systemUserDefinedFieldsIdGet

\Spinen\ConnectWise\Clients\System\Model\UserDefinedField systemUserDefinedFieldsIdGet($id)

Get User Defined Field 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\UserDefinedFieldsApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\System\Model\UserDefinedField

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]

systemUserDefinedFieldsIdPatch

\Spinen\ConnectWise\Clients\System\Model\UserDefinedField systemUserDefinedFieldsIdPatch($id, $operations)

Update User Defined Field

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

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

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]

systemUserDefinedFieldsIdPut

\Spinen\ConnectWise\Clients\System\Model\UserDefinedField systemUserDefinedFieldsIdPut($id, $user_defined_field)

Replace User Defined Field

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

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

Parameters

Name Type Description Notes
id int
user_defined_field \Spinen\ConnectWise\Clients\System\Model\UserDefinedField

Return type

\Spinen\ConnectWise\Clients\System\Model\UserDefinedField

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]

systemUserDefinedFieldsPost

\Spinen\ConnectWise\Clients\System\Model\UserDefinedField systemUserDefinedFieldsPost($user_defined_field)

Create User Defined Field

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\UserDefinedFieldsApi();
$user_defined_field = new \Spinen\ConnectWise\Clients\System\Model\UserDefinedField(); // \Spinen\ConnectWise\Clients\System\Model\UserDefinedField | 

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

Parameters

Name Type Description Notes
user_defined_field \Spinen\ConnectWise\Clients\System\Model\UserDefinedField

Return type

\Spinen\ConnectWise\Clients\System\Model\UserDefinedField

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]