Skip to content

Latest commit

 

History

History
323 lines (234 loc) · 11 KB

WorkflowApi.md

File metadata and controls

323 lines (234 loc) · 11 KB
Raw

OpenEuropa\SyncopePhpClient\WorkflowApi

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

Method HTTP request Description
delete1 DELETE /workflows/{anyType}/{key} Removes the workflow definition for matching any object type, under the provided key.
exportDiagram GET /workflows/{anyType}/{key}/diagram.png Exports the workflow diagram representation (if available), for matching any object type and key.
get2 GET /workflows/{anyType}/{key} Exports the workflow definition for matching any object type and key.
list27 GET /workflows/{anyType} Lists the available workflow definitions, for the given any object type.
set PUT /workflows/{anyType}/{key} Imports the workflow definition for matching any object type, under the provided key.

delete1

delete1($anyType, $key, $xSyncopeDomain)

Removes the workflow definition for matching any object type, under 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\WorkflowApi(
    // 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
);
$anyType = 'anyType_example'; // string | any object type
$key = 'key_example'; // string | workflow definition key
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name Type Description Notes
anyType string any object type
key string workflow definition 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]

exportDiagram

exportDiagram($anyType, $key, $xSyncopeDomain)

Exports the workflow diagram representation (if available), for matching any object type and 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\WorkflowApi(
    // 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
);
$anyType = 'anyType_example'; // string | any object type
$key = 'key_example'; // string | workflow definition key
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name Type Description Notes
anyType string any object type
key string workflow definition key
xSyncopeDomain string [default to 'Master']

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: image/png

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

get2

get2($anyType, $key, $xSyncopeDomain)

Exports the workflow definition for matching any object type and 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\WorkflowApi(
    // 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
);
$anyType = 'anyType_example'; // string | any object type
$key = 'key_example'; // string | workflow definition key
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name Type Description Notes
anyType string any object type
key string workflow definition 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]

list27

list27($anyType, $xSyncopeDomain)

Lists the available workflow definitions, for the given any object type.

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\WorkflowApi(
    // 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
);
$anyType = 'anyType_example'; // string | any object type
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

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

set

set($anyType, $key, $xSyncopeDomain, $body)

Imports the workflow definition for matching any object type, under 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\WorkflowApi(
    // 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
);
$anyType = 'anyType_example'; // string | any object type
$key = 'key_example'; // string | workflow definition key
$xSyncopeDomain = 'Master'; // string | workflow definition for matching kind
$body = 'body_example'; // string | 

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

Parameters

Name Type Description Notes
anyType string any object type
key string workflow definition key
xSyncopeDomain string workflow definition for matching kind [default to 'Master']
body string

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]