Skip to content

Latest commit

 

History

History
506 lines (309 loc) · 13.3 KB

PrcServiceApi.md

File metadata and controls

506 lines (309 loc) · 13.3 KB
Raw

Swagger\Client\PrcServiceApi

All URIs are relative to https://localhost/

Method HTTP request Description
prcActivateService POST /api/Services/Prc/{id}/Activate
prcDeactivateService POST /api/Services/Prc/{id}/Deactivate
prcExportDictionaries POST /api/Services/Prc/{id}/ExportDictionaries
prcGetService GET /api/Services/Prc/{id}
prcIndexPartialService POST /api/Services/Prc/{id}/IndexPartial
prcIndexService POST /api/Services/Prc/{id}/Index
prcKeywordsService POST /api/Services/Prc/{id}/Keywords
prcPrepareService POST /api/Services/Prc/{id}/Prepare
prcRecommendByIdService POST /api/Services/Prc/{id}/RecommendById
prcRecommendService POST /api/Services/Prc/{id}/Recommend

prcActivateService

\Swagger\Client\Model\Process prcActivateService($id, $prc_activate_settings)

Example

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


$api_instance = new Swagger\Client\Api\PrcServiceApi();
$id = "id_example"; // string | 
$prc_activate_settings = new \Swagger\Client\Model\PrcActivateSettings(); // \Swagger\Client\Model\PrcActivateSettings | 


try { 
    $result = $api_instance->prcActivateService($id, $prc_activate_settings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrcServiceApi->prcActivateService: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string
prc_activate_settings \Swagger\Client\Model\PrcActivateSettings [optional]

Return type

\Swagger\Client\Model\Process

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/json-patch+json
  • Accept: Not defined

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

prcDeactivateService

prcDeactivateService($id)

Example

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


$api_instance = new Swagger\Client\Api\PrcServiceApi();
$id = "id_example"; // string | 


try { 
    $api_instance->prcDeactivateService($id);
} catch (Exception $e) {
    echo 'Exception when calling PrcServiceApi->prcDeactivateService: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

prcExportDictionaries

\Swagger\Client\Model\Process prcExportDictionaries($id, $settings)

Example

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


$api_instance = new Swagger\Client\Api\PrcServiceApi();
$id = "id_example"; // string | 
$settings = new \Swagger\Client\Model\ExportDictionariesSettings(); // \Swagger\Client\Model\ExportDictionariesSettings | 


try { 
    $result = $api_instance->prcExportDictionaries($id, $settings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrcServiceApi->prcExportDictionaries: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string
settings \Swagger\Client\Model\ExportDictionariesSettings [optional]

Return type

\Swagger\Client\Model\Process

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/json-patch+json
  • Accept: Not defined

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

prcGetService

\Swagger\Client\Model\PrcService prcGetService($id)

Example

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


$api_instance = new Swagger\Client\Api\PrcServiceApi();
$id = "id_example"; // string | 


try { 
    $result = $api_instance->prcGetService($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrcServiceApi->prcGetService: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Swagger\Client\Model\PrcService

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

prcIndexPartialService

\Swagger\Client\Model\Process prcIndexPartialService($id)

Example

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


$api_instance = new Swagger\Client\Api\PrcServiceApi();
$id = "id_example"; // string | 


try { 
    $result = $api_instance->prcIndexPartialService($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrcServiceApi->prcIndexPartialService: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Swagger\Client\Model\Process

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

prcIndexService

\Swagger\Client\Model\Process prcIndexService($id, $prc_index_settings)

Example

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


$api_instance = new Swagger\Client\Api\PrcServiceApi();
$id = "id_example"; // string | 
$prc_index_settings = new \Swagger\Client\Model\PrcIndexSettings(); // \Swagger\Client\Model\PrcIndexSettings | 


try { 
    $result = $api_instance->prcIndexService($id, $prc_index_settings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrcServiceApi->prcIndexService: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string
prc_index_settings \Swagger\Client\Model\PrcIndexSettings [optional]

Return type

\Swagger\Client\Model\Process

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/json-patch+json
  • Accept: Not defined

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

prcKeywordsService

\Swagger\Client\Model\PrcKeywordsResult[] prcKeywordsService($id, $request, $is_strict)

Example

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


$api_instance = new Swagger\Client\Api\PrcServiceApi();
$id = "id_example"; // string | 
$request = new \Swagger\Client\Model\PrcKeywordsRequest(); // \Swagger\Client\Model\PrcKeywordsRequest | 
$is_strict = true; // bool | 


try { 
    $result = $api_instance->prcKeywordsService($id, $request, $is_strict);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrcServiceApi->prcKeywordsService: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string
request \Swagger\Client\Model\PrcKeywordsRequest [optional]
is_strict bool [optional]

Return type

\Swagger\Client\Model\PrcKeywordsResult[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/json-patch+json
  • Accept: Not defined

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

prcPrepareService

\Swagger\Client\Model\Process prcPrepareService($id, $prc_prepare_settings)

Example

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


$api_instance = new Swagger\Client\Api\PrcServiceApi();
$id = "id_example"; // string | 
$prc_prepare_settings = new \Swagger\Client\Model\PrcPrepareSettings(); // \Swagger\Client\Model\PrcPrepareSettings | 


try { 
    $result = $api_instance->prcPrepareService($id, $prc_prepare_settings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrcServiceApi->prcPrepareService: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string
prc_prepare_settings \Swagger\Client\Model\PrcPrepareSettings [optional]

Return type

\Swagger\Client\Model\Process

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/json-patch+json
  • Accept: Not defined

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

prcRecommendByIdService

\Swagger\Client\Model\PrcRecommendationResult[] prcRecommendByIdService($id, $request)

Example

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


$api_instance = new Swagger\Client\Api\PrcServiceApi();
$id = "id_example"; // string | 
$request = new \Swagger\Client\Model\PrcRecommendationByIdRequest(); // \Swagger\Client\Model\PrcRecommendationByIdRequest | 


try { 
    $result = $api_instance->prcRecommendByIdService($id, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrcServiceApi->prcRecommendByIdService: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string
request \Swagger\Client\Model\PrcRecommendationByIdRequest [optional]

Return type

\Swagger\Client\Model\PrcRecommendationResult[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/json-patch+json
  • Accept: Not defined

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

prcRecommendService

\Swagger\Client\Model\PrcRecommendationResult[] prcRecommendService($id, $request)

Example

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


$api_instance = new Swagger\Client\Api\PrcServiceApi();
$id = "id_example"; // string | 
$request = new \Swagger\Client\Model\PrcRecommendationRequest(); // \Swagger\Client\Model\PrcRecommendationRequest | 


try { 
    $result = $api_instance->prcRecommendService($id, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrcServiceApi->prcRecommendService: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string
request \Swagger\Client\Model\PrcRecommendationRequest [optional]

Return type

\Swagger\Client\Model\PrcRecommendationResult[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/json-patch+json
  • Accept: Not defined

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