TagApi.md

SlambySdk.TagApi

All URIs are relative to https://localhost/

Method	HTTP request	Description
bulkTags	POST /api/Tags/Bulk
cleanDocuments	POST /api/Tags/CleanDocuments
createTag	POST /api/Tags
deleteTag	DELETE /api/Tags/{id}
getTag	GET /api/Tags/{id}
getTags	GET /api/Tags
updateTag	PUT /api/Tags/{id}
wordsExport	POST /api/Tags/ExportWords

bulkTags

BulkResults bulkTags(opts)

Example

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


var apiInstance = new SlambySdk.TagApi();

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

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

Parameters

Name	Type	Description	Notes
settings	TagBulkSettings		[optional]

Return type

BulkResults

Authorization

No authorization required

HTTP request headers

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

cleanDocuments

cleanDocuments()

Example

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


var apiInstance = new SlambySdk.TagApi();

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

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

createTag

Tag createTag(opts)

Example

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


var apiInstance = new SlambySdk.TagApi();

var opts = { 
  'tag': new SlambySdk.Tag() // Tag | 
};

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

Parameters

Name	Type	Description	Notes
tag	Tag		[optional]

Return type

Tag

Authorization

No authorization required

HTTP request headers

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

deleteTag

deleteTag(id, opts)

Example

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


var apiInstance = new SlambySdk.TagApi();

var id = "id_example"; // String | 

var opts = { 
  'force': true, // Boolean | 
  'cleanDocuments': true // Boolean | 
};

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

Parameters

Name	Type	Description	Notes
id	String
force	Boolean		[optional]
cleanDocuments	Boolean		[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getTag

Tag getTag(id, opts)

Example

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


var apiInstance = new SlambySdk.TagApi();

var id = "id_example"; // String | 

var opts = { 
  'withDetails': true // Boolean | 
};

apiInstance.getTag(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
withDetails	Boolean		[optional]

Return type

Tag

Authorization

No authorization required

HTTP request headers

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

getTags

[Tag] getTags(opts)

Example

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


var apiInstance = new SlambySdk.TagApi();

var opts = { 
  'withDetails': true // Boolean | 
};

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

Parameters

Name	Type	Description	Notes
withDetails	Boolean		[optional]

Return type

[Tag]

Authorization

No authorization required

HTTP request headers

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

updateTag

updateTag(id, opts)

Example

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


var apiInstance = new SlambySdk.TagApi();

var id = "id_example"; // String | 

var opts = { 
  'tag': new SlambySdk.Tag() // Tag | 
};

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

Parameters

Name	Type	Description	Notes
id	String
tag	Tag		[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

wordsExport

Process wordsExport(opts)

Example

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


var apiInstance = new SlambySdk.TagApi();

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

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

Parameters

Name	Type	Description	Notes
settings	TagsExportWordsSettings		[optional]

Return type

Process

Authorization

No authorization required

HTTP request headers

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