Skip to content

Files

Latest commit

 

History

History
245 lines (137 loc) · 4.16 KB

ServiceApi.md

File metadata and controls

245 lines (137 loc) · 4.16 KB

SlambySdk.ServiceApi

All URIs are relative to https://localhost/

Method HTTP request Description
createService POST /api/Services
deleteService DELETE /api/Services/{id}
getService GET /api/Services/{id}
getServices GET /api/Services
updateService PUT /api/Services/{id}

createService

createService(opts)

Example

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


var apiInstance = new SlambySdk.ServiceApi();

var opts = { 
  'service': new SlambySdk.Service() // Service | 
};

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

Parameters

Name Type Description Notes
service Service [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

deleteService

deleteService(id)

Example

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


var apiInstance = new SlambySdk.ServiceApi();

var id = "id_example"; // String | 


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

getService

Service getService(id)

Example

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


var apiInstance = new SlambySdk.ServiceApi();

var id = "id_example"; // String | 


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

Service

Authorization

No authorization required

HTTP request headers

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

getServices

[Service] getServices()

Example

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


var apiInstance = new SlambySdk.ServiceApi();

apiInstance.getServices().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

[Service]

Authorization

No authorization required

HTTP request headers

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

updateService

Service updateService(id, opts)

Example

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


var apiInstance = new SlambySdk.ServiceApi();

var id = "id_example"; // String | 

var opts = { 
  'service': new SlambySdk.Service() // Service | 
};

apiInstance.updateService(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
service Service [optional]

Return type

Service

Authorization

No authorization required

HTTP request headers

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