Skip to content

Latest commit

 

History

History
511 lines (294 loc) · 10.4 KB

PrcServiceApi.md

File metadata and controls

511 lines (294 loc) · 10.4 KB

SlambySdk.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

Process prcActivateService(id, opts)

Example

var SlambySdk = require('slamby-sdk');


var apiInstance = new SlambySdk.PrcServiceApi();

var id = "id_example"; // String | 

var opts = { 
  'prcActivateSettings': new SlambySdk.PrcActivateSettings() // PrcActivateSettings | 
};

apiInstance.prcActivateService(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String
prcActivateSettings PrcActivateSettings [optional]

Return type

Process

Authorization

No authorization required

HTTP request headers

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

prcDeactivateService

prcDeactivateService(id)

Example

var SlambySdk = require('slamby-sdk');


var apiInstance = new SlambySdk.PrcServiceApi();

var id = "id_example"; // String | 


apiInstance.prcDeactivateService(id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

prcExportDictionaries

Process prcExportDictionaries(id, opts)

Example

var SlambySdk = require('slamby-sdk');


var apiInstance = new SlambySdk.PrcServiceApi();

var id = "id_example"; // String | 

var opts = { 
  'settings': new SlambySdk.ExportDictionariesSettings() // ExportDictionariesSettings | 
};

apiInstance.prcExportDictionaries(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String
settings ExportDictionariesSettings [optional]

Return type

Process

Authorization

No authorization required

HTTP request headers

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

prcGetService

PrcService prcGetService(id)

Example

var SlambySdk = require('slamby-sdk');


var apiInstance = new SlambySdk.PrcServiceApi();

var id = "id_example"; // String | 


apiInstance.prcGetService(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String

Return type

PrcService

Authorization

No authorization required

HTTP request headers

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

prcIndexPartialService

Process prcIndexPartialService(id)

Example

var SlambySdk = require('slamby-sdk');


var apiInstance = new SlambySdk.PrcServiceApi();

var id = "id_example"; // String | 


apiInstance.prcIndexPartialService(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String

Return type

Process

Authorization

No authorization required

HTTP request headers

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

prcIndexService

Process prcIndexService(id, opts)

Example

var SlambySdk = require('slamby-sdk');


var apiInstance = new SlambySdk.PrcServiceApi();

var id = "id_example"; // String | 

var opts = { 
  'prcIndexSettings': new SlambySdk.PrcIndexSettings() // PrcIndexSettings | 
};

apiInstance.prcIndexService(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String
prcIndexSettings PrcIndexSettings [optional]

Return type

Process

Authorization

No authorization required

HTTP request headers

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

prcKeywordsService

[PrcKeywordsResult] prcKeywordsService(id, opts)

Example

var SlambySdk = require('slamby-sdk');


var apiInstance = new SlambySdk.PrcServiceApi();

var id = "id_example"; // String | 

var opts = { 
  'request': new SlambySdk.PrcKeywordsRequest(), // PrcKeywordsRequest | 
  'isStrict': true // Boolean | 
};

apiInstance.prcKeywordsService(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String
request PrcKeywordsRequest [optional]
isStrict Boolean [optional]

Return type

[PrcKeywordsResult]

Authorization

No authorization required

HTTP request headers

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

prcPrepareService

Process prcPrepareService(id, opts)

Example

var SlambySdk = require('slamby-sdk');


var apiInstance = new SlambySdk.PrcServiceApi();

var id = "id_example"; // String | 

var opts = { 
  'prcPrepareSettings': new SlambySdk.PrcPrepareSettings() // PrcPrepareSettings | 
};

apiInstance.prcPrepareService(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String
prcPrepareSettings PrcPrepareSettings [optional]

Return type

Process

Authorization

No authorization required

HTTP request headers

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

prcRecommendByIdService

[PrcRecommendationResult] prcRecommendByIdService(id, opts)

Example

var SlambySdk = require('slamby-sdk');


var apiInstance = new SlambySdk.PrcServiceApi();

var id = "id_example"; // String | 

var opts = { 
  'request': new SlambySdk.PrcRecommendationByIdRequest() // PrcRecommendationByIdRequest | 
};

apiInstance.prcRecommendByIdService(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String
request PrcRecommendationByIdRequest [optional]

Return type

[PrcRecommendationResult]

Authorization

No authorization required

HTTP request headers

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

prcRecommendService

[PrcRecommendationResult] prcRecommendService(id, opts)

Example

var SlambySdk = require('slamby-sdk');


var apiInstance = new SlambySdk.PrcServiceApi();

var id = "id_example"; // String | 

var opts = { 
  'request': new SlambySdk.PrcRecommendationRequest() // PrcRecommendationRequest | 
};

apiInstance.prcRecommendService(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
id String
request PrcRecommendationRequest [optional]

Return type

[PrcRecommendationResult]

Authorization

No authorization required

HTTP request headers

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