Skip to content

Latest commit

 

History

History
247 lines (174 loc) · 8.92 KB

ClassApi.md

File metadata and controls

247 lines (174 loc) · 8.92 KB
Raw

Swagger\Client\ClassApi

All URIs are relative to /

Method HTTP request Description
apiV2ClassDetailsDiffPost POST /api/v2/Class/DetailsDiff Get a specific class by class code and version, and show changes with previous version.
apiV2ClassDetailsForReleasePost POST /api/v2/Class/DetailsForRelease Get a specific class by class code and release.
apiV2ClassDetailsManyPost POST /api/v2/Class/DetailsMany Get multiple classes by class code and version.
apiV2ClassDetailsPost POST /api/v2/Class/Details Get a specific class by class code and version.
apiV2ClassSearchPost POST /api/v2/Class/Search Get a list of all classes that meet the input filters.

apiV2ClassDetailsDiffPost

\Swagger\Client\Model\EtimClass apiV2ClassDetailsDiffPost($body)

Get a specific class by class code and version, and show changes with previous version.

Example

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

$apiInstance = new Swagger\Client\Api\ClassApi(
    // 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()
);
$body = new \Swagger\Client\Model\ClassDetailsInput(); // \Swagger\Client\Model\ClassDetailsInput | Object of type Etim.Models.Elastic.ClassDetailsInput.

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\ClassDetailsInput Object of type Etim.Models.Elastic.ClassDetailsInput. [optional]

Return type

\Swagger\Client\Model\EtimClass

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: text/plain, application/json, text/json

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

apiV2ClassDetailsForReleasePost

\Swagger\Client\Model\EtimClass apiV2ClassDetailsForReleasePost($body)

Get a specific class by class code and release.

Example

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

$apiInstance = new Swagger\Client\Api\ClassApi(
    // 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()
);
$body = new \Swagger\Client\Model\ClassDetailsReleaseInput(); // \Swagger\Client\Model\ClassDetailsReleaseInput | Object of type Etim.Models.Elastic.ClassDetailsReleaseInput.

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\ClassDetailsReleaseInput Object of type Etim.Models.Elastic.ClassDetailsReleaseInput. [optional]

Return type

\Swagger\Client\Model\EtimClass

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: text/plain, application/json, text/json

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

apiV2ClassDetailsManyPost

\Swagger\Client\Model\EtimClass[] apiV2ClassDetailsManyPost($body)

Get multiple classes by class code and version.

Example

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

$apiInstance = new Swagger\Client\Api\ClassApi(
    // 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()
);
$body = new \Swagger\Client\Model\ClassListInput(); // \Swagger\Client\Model\ClassListInput | Objects of type Etim.Models.Elastic.ClassListInput.

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\ClassListInput Objects of type Etim.Models.Elastic.ClassListInput. [optional]

Return type

\Swagger\Client\Model\EtimClass[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: text/plain, application/json, text/json

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

apiV2ClassDetailsPost

\Swagger\Client\Model\EtimClass apiV2ClassDetailsPost($body)

Get a specific class by class code and version.

Example

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

$apiInstance = new Swagger\Client\Api\ClassApi(
    // 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()
);
$body = new \Swagger\Client\Model\ClassDetailsInput(); // \Swagger\Client\Model\ClassDetailsInput | Object of type Etim.Models.Elastic.ClassDetailsInput.

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\ClassDetailsInput Object of type Etim.Models.Elastic.ClassDetailsInput. [optional]

Return type

\Swagger\Client\Model\EtimClass

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: text/plain, application/json, text/json

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

apiV2ClassSearchPost

\Swagger\Client\Model\ClassSearchOutput apiV2ClassSearchPost($body)

Get a list of all classes that meet the input filters.

Example

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

$apiInstance = new Swagger\Client\Api\ClassApi(
    // 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()
);
$body = new \Swagger\Client\Model\EntitySearchInput(); // \Swagger\Client\Model\EntitySearchInput | Object of type Etim.Models.Elastic.EntitySearchInput.

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\EntitySearchInput Object of type Etim.Models.Elastic.EntitySearchInput. [optional]

Return type

\Swagger\Client\Model\ClassSearchOutput

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain, application/json, text/json

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