All URIs are relative to https://api.ageras.com/v2
Method | HTTP request | Description |
---|---|---|
tasksCreate | POST /tasks | |
tasksDelete | DELETE /tasks/{task_id} | |
tasksGet | GET /tasks/{task_id} | |
tasksIndex | GET /tasks | |
tasksPrioritiesGet | GET /tasks/priorities/{priority_id} | |
tasksPrioritiesGet_0 | GET /tasks/{task_id}/priorities/{priority_id} | |
tasksPrioritiesIndex | GET /tasks/priorities | |
tasksStatusesGet | GET /tasks/statuses/{status_id} | |
tasksStatusesGet_0 | GET /tasks/{task_id}/statuses/{status_id} | |
tasksStatusesIndex | GET /tasks/statuses | |
tasksTaskablesCreate | POST /tasks/{task_id}/taskables | |
tasksTaskablesDelete | DELETE /tasks/{task_id}/taskables/{taskable_id} | |
tasksTaskablesGet | GET /tasks/{task_id}/taskables/{taskable_id} | |
tasksTaskablesIndex | GET /tasks/{task_id}/taskables | |
tasksUpdate | PUT /tasks/{task_id} |
\Ageras\Api\TaskResource tasksCreate($task_resource)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$task_resource = new \Ageras\Api\TaskResource(); // \Ageras\Api\TaskResource |
try {
$result = $api_instance->tasksCreate($task_resource);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksCreate: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_resource | \Ageras\Api\TaskResource |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
tasksDelete($task_id )
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$task_id = "task_id_example"; // string |
try {
$api_instance->tasksDelete($task_id );
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksDelete: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_id | string |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskResource tasksGet($task_id )
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$task_id = "task_id_example"; // string |
try {
$result = $api_instance->tasksGet($task_id );
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksGet: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_id | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskResult tasksIndex($criteria)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$criteria = [
'task_id' => "task_id_example"; // string | Task id's to filter by.
'geo_code' => "geo_code_example"; // string |
'employee_id' => "employee_id_example"; // string |
'completed_by_employee_id' => "completed_by_employee_id_example"; // string | Filter by tasks that are completed by a given employee_id.
'assigned_employee_id' => "assigned_employee_id_example"; // string | Filter by tasks that are assigned to a given employee_id.
'partner_id' => "partner_id_example"; // string | Query tasks associated to a given partner.
'lead_id' => "lead_id_example"; // string | Query tasks associated to a given lead.
'status' => "status_example"; // string | Status for the tasks to be filtered by.
'limit' => 56; // int | Number of resources to return.
'include_done' => false; // bool |
'process' => "unknown"; // string | Process type
'due_before' => "due_before_example"; // string | Due before date
'sort' => "deadline_at"; // string |
'page' => 56; // int | The page position in the result.
'query' => "query_example"; // string | The search wildcard.
];
try {
$result = $api_instance->tasksIndex($criteria);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksIndex: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_id | string | Task id's to filter by. | [optional] |
geo_code | string | [optional] | |
employee_id | string | [optional] | |
completed_by_employee_id | string | Filter by tasks that are completed by a given employee_id. | [optional] |
assigned_employee_id | string | Filter by tasks that are assigned to a given employee_id. | [optional] |
partner_id | string | Query tasks associated to a given partner. | [optional] |
lead_id | string | Query tasks associated to a given lead. | [optional] |
status | string | Status for the tasks to be filtered by. | [optional] |
limit | int | Number of resources to return. | [optional] |
include_done | bool | [optional] [default to false] | |
process | string | Process type | [optional] [default to unknown] |
due_before | string | Due before date | [optional] |
sort | string | [optional] [default to deadline_at] | |
page | int | The page position in the result. | [optional] |
query | string | The search wildcard. | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskPriorityResource tasksPrioritiesGet($priority_id )
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$priority_id = "priority_id_example"; // string |
try {
$result = $api_instance->tasksPrioritiesGet($priority_id );
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksPrioritiesGet: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
priority_id | string |
\Ageras\Api\TaskPriorityResource
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskPriorityResource tasksPrioritiesGet_0($task_id, $priority_id )
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$task_id = "task_id_example"; // string |
$priority_id = "priority_id_example"; // string |
try {
$result = $api_instance->tasksPrioritiesGet_0($task_id, $priority_id );
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksPrioritiesGet_0: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_id | string | ||
priority_id | string |
\Ageras\Api\TaskPriorityResource
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskPriorityResult tasksPrioritiesIndex($criteria)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$criteria = [
'priority_id' => "priority_id_example"; // string |
'limit' => 56; // int | The number of resources to be returned.
'page' => 56; // int | The page position in the result.
'query' => "query_example"; // string | The search wildcard.
];
try {
$result = $api_instance->tasksPrioritiesIndex($criteria);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksPrioritiesIndex: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
priority_id | string | [optional] | |
limit | int | The number of resources to be returned. | [optional] |
page | int | The page position in the result. | [optional] |
query | string | The search wildcard. | [optional] |
\Ageras\Api\TaskPriorityResult
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskStatusResource tasksStatusesGet($status_id )
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$status_id = "status_id_example"; // string |
try {
$result = $api_instance->tasksStatusesGet($status_id );
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksStatusesGet: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
status_id | string |
\Ageras\Api\TaskStatusResource
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskStatusResource tasksStatusesGet_0($task_id, $status_id )
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$task_id = "task_id_example"; // string |
$status_id = "status_id_example"; // string |
try {
$result = $api_instance->tasksStatusesGet_0($task_id, $status_id );
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksStatusesGet_0: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_id | string | ||
status_id | string |
\Ageras\Api\TaskStatusResource
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskStatusResult tasksStatusesIndex($criteria)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$criteria = [
'status_id' => "status_id_example"; // string |
'limit' => 56; // int | The number of resources to be returned.
'page' => 56; // int | The page position in the result.
'query' => "query_example"; // string | The search wildcard.
];
try {
$result = $api_instance->tasksStatusesIndex($criteria);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksStatusesIndex: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
status_id | string | [optional] | |
limit | int | The number of resources to be returned. | [optional] |
page | int | The page position in the result. | [optional] |
query | string | The search wildcard. | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskableResource tasksTaskablesCreate($task_id , $taskable_resource)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$task_id = "task_id_example"; // string |
$taskable_resource = new \Ageras\Api\TaskableResource(); // \Ageras\Api\TaskableResource |
try {
$result = $api_instance->tasksTaskablesCreate($task_id , $taskable_resource);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksTaskablesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_id | string | ||
taskable_resource | \Ageras\Api\TaskableResource |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
tasksTaskablesDelete($task_id, $taskable_id )
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$task_id = "task_id_example"; // string |
$taskable_id = "taskable_id_example"; // string |
try {
$api_instance->tasksTaskablesDelete($task_id, $taskable_id );
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksTaskablesDelete: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_id | string | ||
taskable_id | string |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskableResource tasksTaskablesGet($task_id, $taskable_id )
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$task_id = "task_id_example"; // string |
$taskable_id = "taskable_id_example"; // string |
try {
$result = $api_instance->tasksTaskablesGet($task_id, $taskable_id );
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksTaskablesGet: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_id | string | ||
taskable_id | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskableResult tasksTaskablesIndex($task_id , $criteria)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$task_id = "task_id_example"; // string |
$criteria = [
'taskable_id' => "taskable_id_example"; // string |
'limit' => 56; // int | The number of resources to be returned.
'page' => 56; // int | The page position in the result.
'query' => "query_example"; // string | The search wildcard.
];
try {
$result = $api_instance->tasksTaskablesIndex($task_id , $criteria);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksTaskablesIndex: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_id | string | ||
taskable_id | string | [optional] | |
limit | int | The number of resources to be returned. | [optional] |
page | int | The page position in the result. | [optional] |
query | string | The search wildcard. | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Ageras\Api\TaskResource tasksUpdate($task_id , $task_resource)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Ageras\Api\Api\TasksApi();
$task_id = "task_id_example"; // string |
$task_resource = new \Ageras\Api\TaskResource(); // \Ageras\Api\TaskResource |
try {
$result = $api_instance->tasksUpdate($task_id , $task_resource);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TasksApi->tasksUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
task_id | string | ||
task_resource | \Ageras\Api\TaskResource |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]