OpenAPI\Client\TasksApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
tasksCreateTask()	POST /api/tasks/v1/Tasks	Create a new task
tasksDeleteTask()	DELETE /api/tasks/v1/Tasks/{taskId}	Delete a task from a storage
tasksGet()	GET /api/tasks/v1/Tasks/{taskId}	Get a task by a specified id
tasksGetList()	GET /api/tasks/v1/Tasks	Get tasks list
tasksGetPermissions()	GET /api/tasks/v1/Tasks/{id}/permissions	Get all Task permissions
tasksRenameTask()	PUT /api/tasks/v1/Tasks/{taskId}/rename	Rename a task
tasksRunTask()	POST /api/tasks/v1/Tasks/run	Run a task from request body
tasksRunTaskById()	POST /api/tasks/v1/Tasks/{taskId}/run	Run a task by id
tasksUpdatePermissions()	POST /api/tasks/v1/Tasks/{id}/permissions	Update permissions
tasksUpdateTask()	PUT /api/tasks/v1/Tasks/{taskId}	Update a task

`tasksCreateTask()`

tasksCreateTask($create_task_base_vm): \OpenAPI\Client\cloud\fastreport\model\TaskBaseVM

Create a new task

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TasksApi(
    // 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
);
$create_task_base_vm = new \OpenAPI\Client\cloud\fastreport\model\CreateTaskBaseVM(); // \OpenAPI\Client\cloud\fastreport\model\CreateTaskBaseVM | task's view model. You have to specify task type (type: \"ExportTemplate\")

try {
    $result = $apiInstance->tasksCreateTask($create_task_base_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->tasksCreateTask: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
create_task_base_vm	\OpenAPI\Client\cloud\fastreport\model\CreateTaskBaseVM	task's view model. You have to specify task type (type: "ExportTemplate")	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\TaskBaseVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

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

`tasksDeleteTask()`

tasksDeleteTask($task_id)

Delete a task from a storage

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TasksApi(
    // 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
);
$task_id = 'task_id_example'; // string | deleting task id

try {
    $apiInstance->tasksDeleteTask($task_id);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->tasksDeleteTask: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
task_id	string	deleting task id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`tasksGet()`

tasksGet($task_id): \OpenAPI\Client\cloud\fastreport\model\TaskBaseVM

Get a task by a specified id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TasksApi(
    // 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
);
$task_id = 'task_id_example'; // string | a task id

try {
    $result = $apiInstance->tasksGet($task_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->tasksGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
task_id	string	a task id

Return type

\OpenAPI\Client\cloud\fastreport\model\TaskBaseVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`tasksGetList()`

tasksGetList($skip, $take, $subscription_id, $search_pattern): \OpenAPI\Client\cloud\fastreport\model\TasksVM

Get tasks list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TasksApi(
    // 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
);
$skip = 0; // int | number of tasks, that have to be skipped
$take = 10; // int | number of tasks, that have to be returned
$subscription_id = 'subscription_id_example'; // string | subscription id
$search_pattern = ''; // string | 

try {
    $result = $apiInstance->tasksGetList($skip, $take, $subscription_id, $search_pattern);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->tasksGetList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
skip	int	number of tasks, that have to be skipped	[optional] [default to 0]
take	int	number of tasks, that have to be returned	[optional] [default to 10]
subscription_id	string	subscription id	[optional]
search_pattern	string		[optional] [default to '']

Return type

\OpenAPI\Client\cloud\fastreport\model\TasksVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`tasksGetPermissions()`

tasksGetPermissions($id): \OpenAPI\Client\cloud\fastreport\model\TaskPermissionsVM

Get all Task permissions

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TasksApi(
    // 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 = 'id_example'; // string | task id

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

Parameters

Name	Type	Description	Notes
id	string	task id

Return type

\OpenAPI\Client\cloud\fastreport\model\TaskPermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`tasksRenameTask()`

tasksRenameTask($task_id, $new_name): \OpenAPI\Client\cloud\fastreport\model\TaskBaseVM

Rename a task

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TasksApi(
    // 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
);
$task_id = 'task_id_example'; // string | renaming task id
$new_name = 'new_name_example'; // string | task's new Name

try {
    $result = $apiInstance->tasksRenameTask($task_id, $new_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->tasksRenameTask: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
task_id	string	renaming task id
new_name	string	task's new Name	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\TaskBaseVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`tasksRunTask()`

tasksRunTask($run_task_base_vm)

Run a task from request body

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TasksApi(
    // 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
);
$run_task_base_vm = new \OpenAPI\Client\cloud\fastreport\model\RunTaskBaseVM(); // \OpenAPI\Client\cloud\fastreport\model\RunTaskBaseVM | task's view model

try {
    $apiInstance->tasksRunTask($run_task_base_vm);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->tasksRunTask: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
run_task_base_vm	\OpenAPI\Client\cloud\fastreport\model\RunTaskBaseVM	task's view model	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

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

`tasksRunTaskById()`

tasksRunTaskById($task_id)

Run a task by id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TasksApi(
    // 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
);
$task_id = 'task_id_example'; // string | task id

try {
    $apiInstance->tasksRunTaskById($task_id);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->tasksRunTaskById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
task_id	string	task id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`tasksUpdatePermissions()`

tasksUpdatePermissions($id, $update_task_permissions_vm)

Update permissions

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TasksApi(
    // 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 = 'id_example'; // string | task id
$update_task_permissions_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateTaskPermissionsVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateTaskPermissionsVM | new permissions

try {
    $apiInstance->tasksUpdatePermissions($id, $update_task_permissions_vm);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->tasksUpdatePermissions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	task id
update_task_permissions_vm	\OpenAPI\Client\cloud\fastreport\model\UpdateTaskPermissionsVM	new permissions	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

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

`tasksUpdateTask()`

tasksUpdateTask($task_id, $update_task_base_vm): \OpenAPI\Client\cloud\fastreport\model\TaskBaseVM

Update a task

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TasksApi(
    // 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
);
$task_id = 'task_id_example'; // string | updating task id
$update_task_base_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateTaskBaseVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateTaskBaseVM | task's view model. You have to specify task type (type: \"ExportTemplate\")

try {
    $result = $apiInstance->tasksUpdateTask($task_id, $update_task_base_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->tasksUpdateTask: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
task_id	string	updating task id
update_task_base_vm	\OpenAPI\Client\cloud\fastreport\model\UpdateTaskBaseVM	task's view model. You have to specify task type (type: "ExportTemplate")	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\TaskBaseVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

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

Files

TasksApi.md

Latest commit

History

TasksApi.md

File metadata and controls

OpenAPI\Client\TasksApi

tasksCreateTask()

Example

Parameters

Return type

Authorization

HTTP request headers

tasksDeleteTask()

Example

Parameters

Return type

Authorization

HTTP request headers

tasksGet()

Example

Parameters

Return type

Authorization

HTTP request headers

tasksGetList()

Example

Parameters

Return type

Authorization

HTTP request headers

tasksGetPermissions()

Example

Parameters

Return type

Authorization

HTTP request headers

tasksRenameTask()

Example

Parameters

Return type

Authorization

HTTP request headers

tasksRunTask()

Example

Parameters

Return type

Authorization

HTTP request headers

tasksRunTaskById()

Example

Parameters

Return type

Authorization

HTTP request headers

tasksUpdatePermissions()

Example

Parameters

Return type

Authorization

HTTP request headers

tasksUpdateTask()

Example

Parameters

Return type

Authorization

HTTP request headers

`tasksCreateTask()`

`tasksDeleteTask()`

`tasksGet()`

`tasksGetList()`

`tasksGetPermissions()`

`tasksRenameTask()`

`tasksRunTask()`

`tasksRunTaskById()`

`tasksUpdatePermissions()`

`tasksUpdateTask()`