Skip to content

Latest commit

 

History

History
447 lines (256 loc) · 8.53 KB

DocumentApi.md

File metadata and controls

447 lines (256 loc) · 8.53 KB

SlambySdk.DocumentApi

All URIs are relative to https://localhost/

Method HTTP request Description
bulkDocuments POST /api/Documents/Bulk
copyDocuments POST /api/Documents/Copy
createDocument POST /api/Documents
deleteDocument DELETE /api/Documents/{id}
getDocument GET /api/Documents/{id}
getFilteredDocuments POST /api/Documents/Filter/{scrollId}
getSampleDocuments POST /api/Documents/Sample
moveDocuments POST /api/Documents/Move
updateDocument PUT /api/Documents/{id}

bulkDocuments

BulkResults bulkDocuments(opts)

Example

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


var apiInstance = new SlambySdk.DocumentApi();

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

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

Parameters

Name Type Description Notes
settings DocumentBulkSettings [optional]

Return type

BulkResults

Authorization

No authorization required

HTTP request headers

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

copyDocuments

Process copyDocuments(opts)

Example

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


var apiInstance = new SlambySdk.DocumentApi();

var opts = { 
  'copySettings': new SlambySdk.DocumentCopySettings() // DocumentCopySettings | 
};

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

Parameters

Name Type Description Notes
copySettings DocumentCopySettings [optional]

Return type

Process

Authorization

No authorization required

HTTP request headers

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

createDocument

createDocument(opts)

Example

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


var apiInstance = new SlambySdk.DocumentApi();

var opts = { 
  'document': null // Object | 
};

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

Parameters

Name Type Description Notes
document Object [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

deleteDocument

deleteDocument(id)

Example

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


var apiInstance = new SlambySdk.DocumentApi();

var id = "id_example"; // String | 


apiInstance.deleteDocument(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

getDocument

Object getDocument(id)

Example

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


var apiInstance = new SlambySdk.DocumentApi();

var id = "id_example"; // String | 


apiInstance.getDocument(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

Object

Authorization

No authorization required

HTTP request headers

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

getFilteredDocuments

PaginatedListObject getFilteredDocuments(scrollId, opts)

Example

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


var apiInstance = new SlambySdk.DocumentApi();

var scrollId = "scrollId_example"; // String | 

var opts = { 
  'filterSettings': new SlambySdk.DocumentFilterSettings() // DocumentFilterSettings | 
};

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

Parameters

Name Type Description Notes
scrollId String
filterSettings DocumentFilterSettings [optional]

Return type

PaginatedListObject

Authorization

No authorization required

HTTP request headers

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

getSampleDocuments

PaginatedListObject getSampleDocuments(opts)

Example

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


var apiInstance = new SlambySdk.DocumentApi();

var opts = { 
  'sampleSettings': new SlambySdk.DocumentSampleSettings() // DocumentSampleSettings | 
};

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

Parameters

Name Type Description Notes
sampleSettings DocumentSampleSettings [optional]

Return type

PaginatedListObject

Authorization

No authorization required

HTTP request headers

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

moveDocuments

Process moveDocuments(opts)

Example

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


var apiInstance = new SlambySdk.DocumentApi();

var opts = { 
  'moveSettings': new SlambySdk.DocumentMoveSettings() // DocumentMoveSettings | 
};

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

Parameters

Name Type Description Notes
moveSettings DocumentMoveSettings [optional]

Return type

Process

Authorization

No authorization required

HTTP request headers

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

updateDocument

Object updateDocument(id, opts)

Example

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


var apiInstance = new SlambySdk.DocumentApi();

var id = "id_example"; // String | 

var opts = { 
  'document': null // Object | 
};

apiInstance.updateDocument(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
document Object [optional]

Return type

Object

Authorization

No authorization required

HTTP request headers

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