Skip to content

Latest commit

 

History

History
356 lines (239 loc) · 11.6 KB

ExternalSystemCallsApi.md

File metadata and controls

356 lines (239 loc) · 11.6 KB

KoronacloudApiV3.ExternalSystemCallsApi

All URIs are relative to https://www.koronacloud.com/web/api/v3

Method HTTP request Description
addExternalSystemCalls POST /accounts/{koronaAccountId}/externalSystemCalls adds a batch of new external system calls
deleteExternalSystemCall DELETE /accounts/{koronaAccountId}/externalSystemCalls/{externalSystemCallId} deletes a single external system call
getExternalSystemCall GET /accounts/{koronaAccountId}/externalSystemCalls/{externalSystemCallId} returns a single external system call
getExternalSystemCalls GET /accounts/{koronaAccountId}/externalSystemCalls lists all external system calls
updateExternalSystemCall PATCH /accounts/{koronaAccountId}/externalSystemCalls/{externalSystemCallId} updates the single external system call
updateExternalSystemCalls PATCH /accounts/{koronaAccountId}/externalSystemCalls updates a batch of external system calls

addExternalSystemCalls

[AddOrUpdateResult] addExternalSystemCalls(body, koronaAccountId)

adds a batch of new external system calls

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.ExternalSystemCallsApi();

var body = [new KoronacloudApiV3.ExternalSystemCall()]; // [ExternalSystemCall] | an array of new external system calls

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addExternalSystemCalls(body, koronaAccountId, callback);

Parameters

Name Type Description Notes
body [ExternalSystemCall] an array of new external system calls
koronaAccountId String account id of the korona.cloud account

Return type

[AddOrUpdateResult]

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteExternalSystemCall

deleteExternalSystemCall(externalSystemCallId, koronaAccountId)

deletes a single external system call

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.ExternalSystemCallsApi();

var externalSystemCallId = "externalSystemCallId_example"; // String | id of the related object (important: id should match the uuid-format)

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteExternalSystemCall(externalSystemCallId, koronaAccountId, callback);

Parameters

Name Type Description Notes
externalSystemCallId String id of the related object (important: id should match the uuid-format)
koronaAccountId String account id of the korona.cloud account

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getExternalSystemCall

ExternalSystemCall getExternalSystemCall(externalSystemCallId, koronaAccountId)

returns a single external system call

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.ExternalSystemCallsApi();

var externalSystemCallId = "externalSystemCallId_example"; // String | id of the related object (important: id should match the uuid-format)

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getExternalSystemCall(externalSystemCallId, koronaAccountId, callback);

Parameters

Name Type Description Notes
externalSystemCallId String id of the related object (important: id should match the uuid-format)
koronaAccountId String account id of the korona.cloud account

Return type

ExternalSystemCall

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getExternalSystemCalls

ResultListExternalSystemCall getExternalSystemCalls(koronaAccountId, opts)

lists all external system calls

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.ExternalSystemCallsApi();

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account

var opts = { 
  'page': 56, // Number | number of the page to fetch
  'size': 56, // Number | amount of objects to return per page
  'sort': "sort_example", // String | attribute to sort by (multiple separated by comma; max. 5)
  'revision': 789, // Number | last revision number, objects with a greater revision than this will be returned
  'includeDeleted': true // Boolean | indicates deleted objects should be loaded or not (default: false)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getExternalSystemCalls(koronaAccountId, opts, callback);

Parameters

Name Type Description Notes
koronaAccountId String account id of the korona.cloud account
page Number number of the page to fetch [optional]
size Number amount of objects to return per page [optional]
sort String attribute to sort by (multiple separated by comma; max. 5) [optional]
revision Number last revision number, objects with a greater revision than this will be returned [optional]
includeDeleted Boolean indicates deleted objects should be loaded or not (default: false) [optional]

Return type

ResultListExternalSystemCall

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateExternalSystemCall

updateExternalSystemCall(externalSystemCallId, body, koronaAccountId)

updates the single external system call

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.ExternalSystemCallsApi();

var externalSystemCallId = "externalSystemCallId_example"; // String | id of the related object (important: id should match the uuid-format)

var body = new KoronacloudApiV3.ExternalSystemCall(); // ExternalSystemCall | the properties to update of the external system call

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updateExternalSystemCall(externalSystemCallId, body, koronaAccountId, callback);

Parameters

Name Type Description Notes
externalSystemCallId String id of the related object (important: id should match the uuid-format)
body ExternalSystemCall the properties to update of the external system call
koronaAccountId String account id of the korona.cloud account

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateExternalSystemCalls

[AddOrUpdateResult] updateExternalSystemCalls(body, koronaAccountId)

updates a batch of external system calls

[number] must be set in the objects, otherwise the object cannot be updated

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.ExternalSystemCallsApi();

var body = [new KoronacloudApiV3.ExternalSystemCall()]; // [ExternalSystemCall] | an array of existing external system calls

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateExternalSystemCalls(body, koronaAccountId, callback);

Parameters

Name Type Description Notes
body [ExternalSystemCall] an array of existing external system calls
koronaAccountId String account id of the korona.cloud account

Return type

[AddOrUpdateResult]

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json