DataSetApi.md

SlambySdk.DataSetApi

All URIs are relative to https://localhost/

Method	HTTP request	Description
createDataSet	POST /api/DataSets
createDataSetSchema	POST /api/DataSets/Schema
deleteDataSet	DELETE /api/DataSets/{name}
getDataSet	GET /api/DataSets/{name}
getDataSets	GET /api/DataSets
updateDataSet	PUT /api/DataSets/{existingName}

createDataSet

createDataSet(opts)

Example

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


var apiInstance = new SlambySdk.DataSetApi();

var opts = { 
  'dataSet': new SlambySdk.DataSet() // DataSet | 
};

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

Parameters

Name	Type	Description	Notes
dataSet	DataSet		[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

createDataSetSchema

createDataSetSchema(opts)

Example

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


var apiInstance = new SlambySdk.DataSetApi();

var opts = { 
  'dataSet': new SlambySdk.DataSet() // DataSet | 
};

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

Parameters

Name	Type	Description	Notes
dataSet	DataSet		[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

deleteDataSet

deleteDataSet(name)

Example

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


var apiInstance = new SlambySdk.DataSetApi();

var name = "name_example"; // String | 


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

Parameters

Name	Type	Description	Notes
name	String

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getDataSet

DataSet getDataSet(name)

Example

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


var apiInstance = new SlambySdk.DataSetApi();

var name = "name_example"; // String | 


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

Parameters

Name	Type	Description	Notes
name	String

Return type

DataSet

Authorization

No authorization required

HTTP request headers

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

getDataSets

[DataSet] getDataSets()

Example

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


var apiInstance = new SlambySdk.DataSetApi();

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

Parameters

This endpoint does not need any parameter.

Return type

[DataSet]

Authorization

No authorization required

HTTP request headers

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

updateDataSet

updateDataSet(existingName, opts)

Example

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


var apiInstance = new SlambySdk.DataSetApi();

var existingName = "existingName_example"; // String | 

var opts = { 
  'dataSetUpdate': new SlambySdk.DataSetUpdate() // DataSetUpdate | 
};

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

Parameters

Name	Type	Description	Notes
existingName	String
dataSetUpdate	DataSetUpdate		[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