Skip to content

Latest commit

 

History

History
386 lines (263 loc) · 12.4 KB

TicketTasksApi.md

File metadata and controls

386 lines (263 loc) · 12.4 KB

Spinen\ConnectWise\Clients\Service\TicketTasksApi

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
serviceTicketsIdTasksCountGet GET /service/tickets/{id}/tasks/count
serviceTicketsIdTasksGet GET /service/tickets/{id}/tasks
serviceTicketsIdTasksPost POST /service/tickets/{id}/tasks
serviceTicketsIdTasksTaskIdDelete DELETE /service/tickets/{id}/tasks/{taskId}
serviceTicketsIdTasksTaskIdGet GET /service/tickets/{id}/tasks/{taskId}
serviceTicketsIdTasksTaskIdPatch PATCH /service/tickets/{id}/tasks/{taskId}
serviceTicketsIdTasksTaskIdPut PUT /service/tickets/{id}/tasks/{taskId}

serviceTicketsIdTasksCountGet

\Spinen\ConnectWise\Clients\Service\Model\Count serviceTicketsIdTasksCountGet($id, $conditions)

Get Tasks 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\TicketTasksApi();
$id = 56; // int | 
$conditions = "conditions_example"; // string | 

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

Parameters

Name Type Description Notes
id int
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]

serviceTicketsIdTasksGet

\Spinen\ConnectWise\Clients\Service\Model\Task[] serviceTicketsIdTasksGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Tasks

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\TicketTasksApi();
$id = 56; // int | 
$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->serviceTicketsIdTasksGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketTasksApi->serviceTicketsIdTasksGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
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\Task[]

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]

serviceTicketsIdTasksPost

\Spinen\ConnectWise\Clients\Service\Model\Task serviceTicketsIdTasksPost($id, $task)

Create Task

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

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

Parameters

Name Type Description Notes
id int
task \Spinen\ConnectWise\Clients\Service\Model\Task

Return type

\Spinen\ConnectWise\Clients\Service\Model\Task

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]

serviceTicketsIdTasksTaskIdDelete

serviceTicketsIdTasksTaskIdDelete($id, $task_id)

Delete Task 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\TicketTasksApi();
$id = 56; // int | 
$task_id = 56; // int | 

try {
    $api_instance->serviceTicketsIdTasksTaskIdDelete($id, $task_id);
} catch (Exception $e) {
    echo 'Exception when calling TicketTasksApi->serviceTicketsIdTasksTaskIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
task_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]

serviceTicketsIdTasksTaskIdGet

\Spinen\ConnectWise\Clients\Service\Model\Task serviceTicketsIdTasksTaskIdGet($id, $task_id)

Get Task 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\TicketTasksApi();
$id = 56; // int | 
$task_id = 56; // int | 

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

Parameters

Name Type Description Notes
id int
task_id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\Task

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]

serviceTicketsIdTasksTaskIdPatch

\Spinen\ConnectWise\Clients\Service\Model\Task serviceTicketsIdTasksTaskIdPatch($id, $task_id, $operations)

Update Task

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Task

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]

serviceTicketsIdTasksTaskIdPut

\Spinen\ConnectWise\Clients\Service\Model\Task serviceTicketsIdTasksTaskIdPut($id, $task_id, $task)

Replace Task

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\TicketTasksApi();
$id = 56; // int | 
$task_id = 56; // int | 
$task = new \Spinen\ConnectWise\Clients\Service\Model\Task(); // \Spinen\ConnectWise\Clients\Service\Model\Task | 

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

Parameters

Name Type Description Notes
id int
task_id int
task \Spinen\ConnectWise\Clients\Service\Model\Task

Return type

\Spinen\ConnectWise\Clients\Service\Model\Task

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]