OpenEuropa\SyncopePhpClient\ReportsApi

All URIs are relative to http://syncope-vm.apache.org:9080/syncope/rest

Method	HTTP request	Description
actionJob	POST /reports/jobs/{key}	Executes an action on an existing executable's job.
create1	POST /reports	Creates a new report.
delete1	DELETE /reports/{key}	Deletes report with matching key.
deleteExecution	DELETE /reports/executions/{executionKey}	Deletes the executable execution matching the provided key.
deleteExecutions	DELETE /reports/{key}/executions	Deletes the executions belonging matching the given query.
execute	POST /reports/{key}/execute	Executes the executable matching the given query.
exportExecutionResult	GET /reports/executions/{executionKey}/stream	Exports the report execution with matching key in the requested format.
getJob1	GET /reports/jobs/{key}	Returns job (running or scheduled) for the executable matching the given key.
list20	GET /reports	Returns a list of all existing reports.
listExecutions	GET /reports/{key}/executions	Returns a paged list of executions matching the given query.
listJobs	GET /reports/jobs	List jobs (running and / or scheduled).
listRecentExecutions	GET /reports/executions/recent	Returns the list of recently completed executions, ordered by end date descendent.
read21	GET /reports/{key}	Returns report with matching key.
update1	PUT /reports/{key}	Updates report with matching key.

actionJob

actionJob($key, $xSyncopeDomain, $action)

Executes an action on an existing executable's job.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$key = 'key_example'; // string | executable key
$xSyncopeDomain = 'Master'; // string | 
$action = 'action_example'; // string | action to execute

try {
    $apiInstance->actionJob($key, $xSyncopeDomain, $action);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->actionJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
key	string	executable key
xSyncopeDomain	string		[default to 'Master']
action	string	action to execute	[optional]

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: /

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

create1

create1($xSyncopeDomain, $reportTO)

Creates a new report.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$xSyncopeDomain = 'Master'; // string | report to be created
$reportTO = new \OpenEuropa\SyncopePhpClient\Model\ReportTO(); // \OpenEuropa\SyncopePhpClient\Model\ReportTO | 

try {
    $apiInstance->create1($xSyncopeDomain, $reportTO);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->create1: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string	report to be created	[default to 'Master']
reportTO	\OpenEuropa\SyncopePhpClient\Model\ReportTO

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: application/json, application/yaml, application/xml
Accept: application/json, application/yaml, application/xml

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

delete1

delete1($key, $xSyncopeDomain)

Deletes report with matching key.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$key = 'key_example'; // string | Deletes report with matching key
$xSyncopeDomain = 'Master'; // string | key of execution report to be selected

try {
    $apiInstance->delete1($key, $xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->delete1: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
key	string	Deletes report with matching key
xSyncopeDomain	string	key of execution report to be selected	[default to 'Master']

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml, application/xml

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

deleteExecution

deleteExecution($executionKey, $xSyncopeDomain)

Deletes the executable execution matching the provided key.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$executionKey = 'executionKey_example'; // string | key of executable execution to be deleted
$xSyncopeDomain = 'Master'; // string | query conditions

try {
    $apiInstance->deleteExecution($executionKey, $xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->deleteExecution: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
executionKey	string	key of executable execution to be deleted
xSyncopeDomain	string	query conditions	[default to 'Master']

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml, application/xml

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

deleteExecutions

deleteExecutions($key, $xSyncopeDomain, $startedBefore, $startedAfter, $endedBefore, $endedAfter)

Deletes the executions belonging matching the given query.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$key = 'key_example'; // string | query conditions
$xSyncopeDomain = 'Master'; // string | 
$startedBefore = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$startedAfter = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$endedBefore = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$endedAfter = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 

try {
    $apiInstance->deleteExecutions($key, $xSyncopeDomain, $startedBefore, $startedAfter, $endedBefore, $endedAfter);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->deleteExecutions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
key	string	query conditions
xSyncopeDomain	string		[default to 'Master']
startedBefore	\DateTime		[optional]
startedAfter	\DateTime		[optional]
endedBefore	\DateTime		[optional]
endedAfter	\DateTime		[optional]

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: multipart/mixed

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

execute

execute($key, $xSyncopeDomain, $startAt, $dryRun)

Executes the executable matching the given query.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$key = 'key_example'; // string | query conditions
$xSyncopeDomain = 'Master'; // string | 
$startAt = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$dryRun = false; // bool | 

try {
    $apiInstance->execute($key, $xSyncopeDomain, $startAt, $dryRun);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->execute: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
key	string	query conditions
xSyncopeDomain	string		[default to 'Master']
startAt	\DateTime		[optional]
dryRun	bool		[optional] [default to false]

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml, application/xml

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

exportExecutionResult

exportExecutionResult($executionKey, $xSyncopeDomain, $format)

Exports the report execution with matching key in the requested format.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$executionKey = 'executionKey_example'; // string | key of execution report to be selected
$xSyncopeDomain = 'Master'; // string | 
$format = 'format_example'; // string | file-format selection

try {
    $apiInstance->exportExecutionResult($executionKey, $xSyncopeDomain, $format);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->exportExecutionResult: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
executionKey	string	key of execution report to be selected
xSyncopeDomain	string		[default to 'Master']
format	string	file-format selection	[optional]

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: /

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

getJob1

getJob1($key, $xSyncopeDomain)

Returns job (running or scheduled) for the executable matching the given key.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$key = 'key_example'; // string | executable key
$xSyncopeDomain = 'Master'; // string | 

try {
    $apiInstance->getJob1($key, $xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getJob1: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
key	string	executable key
xSyncopeDomain	string		[default to 'Master']

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml, application/xml

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

list20

list20($xSyncopeDomain)

Returns a list of all existing reports.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$xSyncopeDomain = 'Master'; // string | 

try {
    $apiInstance->list20($xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->list20: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string		[default to 'Master']

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml, application/xml

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

listExecutions

listExecutions($key, $xSyncopeDomain, $page, $size, $orderby)

Returns a paged list of executions matching the given query.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$key = 'key_example'; // string | 
$xSyncopeDomain = 'Master'; // string | 
$page = 1; // int | query conditions
$size = 25; // int | 
$orderby = 'orderby_example'; // string | 

try {
    $apiInstance->listExecutions($key, $xSyncopeDomain, $page, $size, $orderby);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->listExecutions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
key	string
xSyncopeDomain	string		[default to 'Master']
page	int	query conditions	[optional] [default to 1]
size	int		[optional] [default to 25]
orderby	string		[optional]

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml, application/xml

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

listJobs

listJobs($xSyncopeDomain)

List jobs (running and / or scheduled).

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$xSyncopeDomain = 'Master'; // string | 

try {
    $apiInstance->listJobs($xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->listJobs: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string		[default to 'Master']

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml, application/xml

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

listRecentExecutions

listRecentExecutions($xSyncopeDomain, $max)

Returns the list of recently completed executions, ordered by end date descendent.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$xSyncopeDomain = 'Master'; // string | 
$max = 25; // int | the maximum number of executions to return

try {
    $apiInstance->listRecentExecutions($xSyncopeDomain, $max);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->listRecentExecutions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string		[default to 'Master']
max	int	the maximum number of executions to return	[optional] [default to 25]

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml, application/xml

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

read21

read21($key, $xSyncopeDomain)

Returns report with matching key.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$key = 'key_example'; // string | key of report to be read
$xSyncopeDomain = 'Master'; // string | 

try {
    $apiInstance->read21($key, $xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->read21: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
key	string	key of report to be read
xSyncopeDomain	string		[default to 'Master']

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml, application/xml

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

update1

update1($key, $xSyncopeDomain, $reportTO)

Updates report with matching key.

Example

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ReportsApi(
    // 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
);
$key = 'key_example'; // string | Report's key
$xSyncopeDomain = 'Master'; // string | Deletes report with matching key
$reportTO = new \OpenEuropa\SyncopePhpClient\Model\ReportTO(); // \OpenEuropa\SyncopePhpClient\Model\ReportTO | 

try {
    $apiInstance->update1($key, $xSyncopeDomain, $reportTO);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->update1: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
key	string	Report's key
xSyncopeDomain	string	Deletes report with matching key	[default to 'Master']
reportTO	\OpenEuropa\SyncopePhpClient\Model\ReportTO

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

Content-Type: application/json, application/yaml, application/xml
Accept: application/json, application/yaml, application/xml

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

Files

ReportsApi.md

Latest commit

History

ReportsApi.md

File metadata and controls

OpenEuropa\SyncopePhpClient\ReportsApi

actionJob

Example

Parameters

Return type

Authorization

HTTP request headers

create1

Example

Parameters

Return type

Authorization

HTTP request headers

delete1

Example

Parameters

Return type

Authorization

HTTP request headers

deleteExecution

Example

Parameters

Return type

Authorization

HTTP request headers

deleteExecutions

Example

Parameters

Return type

Authorization

HTTP request headers

execute

Example

Parameters

Return type

Authorization

HTTP request headers

exportExecutionResult

Example

Parameters

Return type

Authorization

HTTP request headers

getJob1

Example

Parameters

Return type

Authorization

HTTP request headers

list20

Example

Parameters

Return type

Authorization

HTTP request headers

listExecutions

Example

Parameters

Return type

Authorization

HTTP request headers

listJobs

Example

Parameters

Return type

Authorization

HTTP request headers

listRecentExecutions

Example

Parameters

Return type

Authorization

HTTP request headers

read21