Skip to content

Latest commit

 

History

History
315 lines (226 loc) · 10.3 KB

CamelRoutesApi.md

File metadata and controls

315 lines (226 loc) · 10.3 KB
Raw

OpenEuropa\SyncopePhpClient\CamelRoutesApi

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

Method HTTP request Description
list4 GET /camelRoutes/{anyTypeKind} List all routes for the given any type kind.
metrics GET /camelRoutes/metrics Provides Camel metrics.
read6 GET /camelRoutes/{anyTypeKind}/{key} Read the route with the given key.
restartContext POST /camelRoutes/restartContext Restart the underlying Apache Camel context.
update PUT /camelRoutes/{anyTypeKind}/{key} Update the given route.

list4

list4($anyTypeKind, $xSyncopeDomain)

List all routes for the given any type kind.

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\CamelRoutesApi(
    // 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
);
$anyTypeKind = 'anyTypeKind_example'; // string | any type kind
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name Type Description Notes
anyTypeKind string any type kind
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]

metrics

metrics($xSyncopeDomain)

Provides Camel metrics.

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\CamelRoutesApi(
    // 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->metrics($xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling CamelRoutesApi->metrics: ', $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]

read6

read6($anyTypeKind, $key, $xSyncopeDomain)

Read the route with 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\CamelRoutesApi(
    // 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
);
$anyTypeKind = 'anyTypeKind_example'; // string | any type kind
$key = 'key_example'; // string | route key
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name Type Description Notes
anyTypeKind string any type kind
key string route 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]

restartContext

restartContext($xSyncopeDomain)

Restart the underlying Apache Camel context.

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\CamelRoutesApi(
    // 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->restartContext($xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling CamelRoutesApi->restartContext: ', $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]

update

update($key, $anyTypeKind, $xSyncopeDomain, $camelRouteTO)

Update the given route.

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\CamelRoutesApi(
    // 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 | Camel route's key
$anyTypeKind = 'anyTypeKind_example'; // string | to be updated
$xSyncopeDomain = 'Master'; // string | 
$camelRouteTO = new \OpenEuropa\SyncopePhpClient\Model\CamelRouteTO(); // \OpenEuropa\SyncopePhpClient\Model\CamelRouteTO | 

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

Parameters

Name Type Description Notes
key string Camel route's key
anyTypeKind string to be updated
xSyncopeDomain string [default to 'Master']
camelRouteTO \OpenEuropa\SyncopePhpClient\Model\CamelRouteTO

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]