Skip to content

Latest commit

 

History

History
155 lines (86 loc) · 2.58 KB

ProcessApi.md

File metadata and controls

155 lines (86 loc) · 2.58 KB

SlambySdk.ProcessApi

All URIs are relative to https://localhost/

Method HTTP request Description
cancelProcess POST /api/Processes/{id}/Cancel
getProcess GET /api/Processes/{id}
getProcesses GET /api/Processes

cancelProcess

cancelProcess(id)

Example

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


var apiInstance = new SlambySdk.ProcessApi();

var id = "id_example"; // String | 


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

getProcess

Process getProcess(id)

Example

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


var apiInstance = new SlambySdk.ProcessApi();

var id = "id_example"; // String | 


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

getProcesses

[Process] getProcesses(opts)

Example

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


var apiInstance = new SlambySdk.ProcessApi();

var opts = { 
  'allStatus': true, // Boolean | 
  'allTime': true // Boolean | 
};

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

Parameters

Name Type Description Notes
allStatus Boolean [optional]
allTime Boolean [optional]

Return type

[Process]

Authorization

No authorization required

HTTP request headers

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