Skip to content

Latest commit

 

History

History
1079 lines (732 loc) · 38.3 KB

LegacyProvisioningApi.md

File metadata and controls

1079 lines (732 loc) · 38.3 KB

Equisoft\SDK\EquisoftConnect\LegacyProvisioningApi

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

Method HTTP request Description
legacyProvisioningAddOrganization() POST /apps/provisioning/kronos.provisioning.addOrganization Add a new organization.
legacyProvisioningAddUser() POST /apps/provisioning/kronos.provisioning.addUser Add a new user.
legacyProvisioningChangeDatabaseProfile() POST /apps/provisioning/kronos.provisioning.changeDatabaseProfile Change database profile.
legacyProvisioningClearCache() POST /apps/provisioning/kronos.provisioning.clearCache Clear cache.
legacyProvisioningDeleteOrganization() POST /apps/provisioning/kronos.provisioning.deleteOrganization Delete an organization.
legacyProvisioningDeleteUser() POST /apps/provisioning/kronos.provisioning.deleteUser Delete a user.
legacyProvisioningEnableContactPersonalizedFieldsModule() POST /apps/provisioning/kronos.provisioning.enableContactPersonalizedFieldsModule Enable Contact Personalized Fields module for a database.
legacyProvisioningEnableFnaForUser() POST /apps/provisioning/kronos.provisioning.enableFnaForUser Enable FNA for user.
legacyProvisioningGetCrmGatewaysAccessReport() GET /apps/provisioning/kronos.provisioning.getCrmGatewaysAccessReport Get a report of active accesses for all CRM datagateways.
legacyProvisioningGetFFGatewaysAccessReport() GET /apps/provisioning/kronos.provisioning.getFFGatewaysAccessReport Get a report of active accesses for all FF datagateways.
legacyProvisioningGetGatewayArchiveByDate() GET /apps/provisioning/kronos.provisioning.getGatewayArchiveByDate Get the archives for a given gateway at the given date.
legacyProvisioningGetGatewayArchiveListByDate() GET /apps/provisioning/kronos.provisioning.getGatewayArchiveListByDate Get the archives list for a given gateway at the given date.
legacyProvisioningGetOrganizationStatus() POST /apps/provisioning/kronos.provisioning.getOrganizationStatus Return the state of a given database.
legacyProvisioningGetSyncControlDataForAllDatabaseStatus() GET /apps/provisioning/kronos.provisioning.getSyncControlDataForAllDatabaseStatus Get the progression status of a previous call to moveUserToOrganization.
legacyProvisioningMonitorDatagateways() GET /apps/provisioning/kronos.provisioning.monitorDatagateways Monitor stats of the datagateways for a given environment.
legacyProvisioningSyncControlData() POST /apps/provisioning/kronos.provisioning.syncControlData Sync one database pilotage.
legacyProvisioningSyncControlDataForAllDatabase() POST /apps/provisioning/kronos.provisioning.syncControlDataForAllDatabase Use gearman to sync all database for a given profile.
legacyProvisioningUpdateUser() POST /apps/provisioning/kronos.provisioning.updateUser Update a user.

legacyProvisioningAddOrganization()

legacyProvisioningAddOrganization($legacyProvisioningOrganizationPayloadRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningAddOrganizationResponse

Add a new organization.

This method is asynchronous. It returns the new organization unique identifier. Use getOrganizationStatus in a loop until the returned status is not "CREATION". If the organization creation failed, getOrganizationStatus will throw a ERR_RECORD_NOT_FOUND exception.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$legacyProvisioningOrganizationPayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningOrganizationPayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningOrganizationPayloadRequest

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

Parameters

Name Type Description Notes
legacyProvisioningOrganizationPayloadRequest \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningOrganizationPayloadRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningAddOrganizationResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

legacyProvisioningAddUser()

legacyProvisioningAddUser($orgId, $legacyProvisioningUserPayloadRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningAddUpdateUserResponse

Add a new user.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$orgId = 'orgId_example'; // string | Organization identifier.
$legacyProvisioningUserPayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningUserPayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningUserPayloadRequest

try {
    $result = $apiInstance->legacyProvisioningAddUser($orgId, $legacyProvisioningUserPayloadRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegacyProvisioningApi->legacyProvisioningAddUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
orgId string Organization identifier.
legacyProvisioningUserPayloadRequest \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningUserPayloadRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningAddUpdateUserResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

legacyProvisioningChangeDatabaseProfile()

legacyProvisioningChangeDatabaseProfile($orgId, $legacyProvisioningChangeDatabaseProfilePayloadRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningChangeDatabaseProfileResponse

Change database profile.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$orgId = 'orgId_example'; // string | Organization identifier.
$legacyProvisioningChangeDatabaseProfilePayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningChangeDatabaseProfilePayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningChangeDatabaseProfilePayloadRequest

try {
    $result = $apiInstance->legacyProvisioningChangeDatabaseProfile($orgId, $legacyProvisioningChangeDatabaseProfilePayloadRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegacyProvisioningApi->legacyProvisioningChangeDatabaseProfile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
orgId string Organization identifier.
legacyProvisioningChangeDatabaseProfilePayloadRequest \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningChangeDatabaseProfilePayloadRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningChangeDatabaseProfileResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

legacyProvisioningClearCache()

legacyProvisioningClearCache($legacyProvisioningClearCachePayloadRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningClearCacheResponse

Clear cache.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$legacyProvisioningClearCachePayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningClearCachePayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningClearCachePayloadRequest

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

Parameters

Name Type Description Notes
legacyProvisioningClearCachePayloadRequest \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningClearCachePayloadRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningClearCacheResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

legacyProvisioningDeleteOrganization()

legacyProvisioningDeleteOrganization($orgId, $legacyProvisioningDeleteOrganizationOptionRequest, $testIfOrgExists): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningDeleteOrganizationResponse

Delete an organization.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$orgId = 'orgId_example'; // string | Organization identifier.
$legacyProvisioningDeleteOrganizationOptionRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningDeleteOrganizationOptionRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningDeleteOrganizationOptionRequest
$testIfOrgExists = True; // bool | Test if the organization exists.

try {
    $result = $apiInstance->legacyProvisioningDeleteOrganization($orgId, $legacyProvisioningDeleteOrganizationOptionRequest, $testIfOrgExists);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegacyProvisioningApi->legacyProvisioningDeleteOrganization: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
orgId string Organization identifier.
legacyProvisioningDeleteOrganizationOptionRequest \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningDeleteOrganizationOptionRequest
testIfOrgExists bool Test if the organization exists. [optional]

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningDeleteOrganizationResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

legacyProvisioningDeleteUser()

legacyProvisioningDeleteUser($userId, $legacyProvisioningDeleteUserOptionRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Delete a user.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$userId = 'userId_example'; // string | User identifier.
$legacyProvisioningDeleteUserOptionRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningDeleteUserOptionRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningDeleteUserOptionRequest

try {
    $result = $apiInstance->legacyProvisioningDeleteUser($userId, $legacyProvisioningDeleteUserOptionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegacyProvisioningApi->legacyProvisioningDeleteUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
userId string User identifier.
legacyProvisioningDeleteUserOptionRequest \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningDeleteUserOptionRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

legacyProvisioningEnableContactPersonalizedFieldsModule()

legacyProvisioningEnableContactPersonalizedFieldsModule($orgId): \Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Enable Contact Personalized Fields module for a database.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$orgId = 'orgId_example'; // string | Organization identifier.

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

Parameters

Name Type Description Notes
orgId string Organization identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningEnableFnaForUser()

legacyProvisioningEnableFnaForUser($userId): \Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Enable FNA for user.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$userId = 'userId_example'; // string | User identifier.

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

Parameters

Name Type Description Notes
userId string User identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningGetCrmGatewaysAccessReport()

legacyProvisioningGetCrmGatewaysAccessReport(): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningReportAccessesResponse

Get a report of active accesses for all CRM datagateways.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningReportAccessesResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningGetFFGatewaysAccessReport()

legacyProvisioningGetFFGatewaysAccessReport(): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningReportAccessesResponse

Get a report of active accesses for all FF datagateways.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningReportAccessesResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningGetGatewayArchiveByDate()

legacyProvisioningGetGatewayArchiveByDate($payload): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningGetFileForGatewayArchiveByDateResponse

Get the archives for a given gateway at the given date.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$payload = new \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningGatewayArchivePayload(); // LegacyProvisioningGatewayArchivePayload | Legacy payload argument.

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

Parameters

Name Type Description Notes
payload LegacyProvisioningGatewayArchivePayload Legacy payload argument.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningGetFileForGatewayArchiveByDateResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningGetGatewayArchiveListByDate()

legacyProvisioningGetGatewayArchiveListByDate($payload): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningGetGatewayArchiveListByDateResponse

Get the archives list for a given gateway at the given date.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$payload = new \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningGatewayArchivePayload(); // LegacyProvisioningGatewayArchivePayload | Legacy payload argument.

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

Parameters

Name Type Description Notes
payload LegacyProvisioningGatewayArchivePayload Legacy payload argument.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningGetGatewayArchiveListByDateResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningGetOrganizationStatus()

legacyProvisioningGetOrganizationStatus($orgId): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningGetOrganizationStatusResponse

Return the state of a given database.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$orgId = 'orgId_example'; // string | Organization identifier.

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

Parameters

Name Type Description Notes
orgId string Organization identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningGetOrganizationStatusResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningGetSyncControlDataForAllDatabaseStatus()

legacyProvisioningGetSyncControlDataForAllDatabaseStatus($jobId): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningSyncControlDataForAllDatabaseResponse

Get the progression status of a previous call to moveUserToOrganization.

Status can be "MOVING" or "DONE".

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$jobId = 'jobId_example'; // string | Job identifier.

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

Parameters

Name Type Description Notes
jobId string Job identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningSyncControlDataForAllDatabaseResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningMonitorDatagateways()

legacyProvisioningMonitorDatagateways($environment): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningMonitorDatagatewayResponse

Monitor stats of the datagateways for a given environment.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$environment = 'environment_example'; // string | The environment.

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

Parameters

Name Type Description Notes
environment string The environment.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningMonitorDatagatewayResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningSyncControlData()

legacyProvisioningSyncControlData($database): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningSyncControlDataResponse

Sync one database pilotage.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$database = 'database_example'; // string | Database identifier.

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

Parameters

Name Type Description Notes
database string Database identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningSyncControlDataResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningSyncControlDataForAllDatabase()

legacyProvisioningSyncControlDataForAllDatabase($profile): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningSyncControlDataForAllDatabaseResponse

Use gearman to sync all database for a given profile.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$profile = 'profile_example'; // string | Profile identifier.

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

Parameters

Name Type Description Notes
profile string Profile identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningSyncControlDataForAllDatabaseResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

legacyProvisioningUpdateUser()

legacyProvisioningUpdateUser($userId, $legacyProvisioningUserPayloadRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningAddUpdateUserResponse

Update a user.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyProvisioningApi(
    // 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
);
$userId = 'userId_example'; // string | User identifier.
$legacyProvisioningUserPayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningUserPayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningUserPayloadRequest

try {
    $result = $apiInstance->legacyProvisioningUpdateUser($userId, $legacyProvisioningUserPayloadRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegacyProvisioningApi->legacyProvisioningUpdateUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
userId string User identifier.
legacyProvisioningUserPayloadRequest \Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningUserPayloadRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyProvisioningAddUpdateUserResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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