Skip to content

Latest commit

 

History

History
executable file
·
356 lines (239 loc) · 11.1 KB

CommodityGroupsApi.md

File metadata and controls

executable file
·
356 lines (239 loc) · 11.1 KB

KoronacloudApiV3.CommodityGroupsApi

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

Method HTTP request Description
addCommodityGroups POST /accounts/{koronaAccountId}/commodityGroups adds a batch of new commodity groups
deleteCommodityGroup DELETE /accounts/{koronaAccountId}/commodityGroups/{commodityGroupId} deletes the single commodity group
getCommodityGroup GET /accounts/{koronaAccountId}/commodityGroups/{commodityGroupId} returns the single commodity group
getCommodityGroups GET /accounts/{koronaAccountId}/commodityGroups lists all commodity groups
updateCommodityGroup PATCH /accounts/{koronaAccountId}/commodityGroups/{commodityGroupId} updates the single commodity group
updateCommodityGroups PATCH /accounts/{koronaAccountId}/commodityGroups updates a batch of commodity groups

addCommodityGroups

[AddOrUpdateResult] addCommodityGroups(body, koronaAccountId)

adds a batch of new commodity groups

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.CommodityGroupsApi();

var body = [new KoronacloudApiV3.CommodityGroup()]; // [CommodityGroup] | an array of new commodity groups

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.addCommodityGroups(body, koronaAccountId, callback);

Parameters

Name Type Description Notes
body [CommodityGroup] an array of new commodity groups
koronaAccountId String account id of the korona.cloud account

Return type

[AddOrUpdateResult]

Authorization

basicAuth

HTTP request headers

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

deleteCommodityGroup

deleteCommodityGroup(commodityGroupId, koronaAccountId)

deletes the single commodity group

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.CommodityGroupsApi();

var commodityGroupId = "commodityGroupId_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.deleteCommodityGroup(commodityGroupId, koronaAccountId, callback);

Parameters

Name Type Description Notes
commodityGroupId 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

getCommodityGroup

CommodityGroup getCommodityGroup(commodityGroupId, koronaAccountId)

returns the single commodity group

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.CommodityGroupsApi();

var commodityGroupId = "commodityGroupId_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.getCommodityGroup(commodityGroupId, koronaAccountId, callback);

Parameters

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

Return type

CommodityGroup

Authorization

basicAuth

HTTP request headers

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

getCommodityGroups

ResultListCommodityGroup getCommodityGroups(koronaAccountId, opts)

lists all commodity groups

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.CommodityGroupsApi();

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.getCommodityGroups(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

ResultListCommodityGroup

Authorization

basicAuth

HTTP request headers

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

updateCommodityGroup

updateCommodityGroup(commodityGroupId, body, koronaAccountId)

updates the single commodity group

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.CommodityGroupsApi();

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

var body = new KoronacloudApiV3.CommodityGroup(); // CommodityGroup | the properties to update of the commodity group

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.updateCommodityGroup(commodityGroupId, body, koronaAccountId, callback);

Parameters

Name Type Description Notes
commodityGroupId String id of the related object (important: id should match the uuid-format)
body CommodityGroup the properties to update of the commodity group
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

updateCommodityGroups

[AddOrUpdateResult] updateCommodityGroups(body, koronaAccountId)

updates a batch of commodity groups

[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.CommodityGroupsApi();

var body = [new KoronacloudApiV3.CommodityGroup()]; // [CommodityGroup] | an array of existing commodity groups

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.updateCommodityGroups(body, koronaAccountId, callback);

Parameters

Name Type Description Notes
body [CommodityGroup] an array of existing commodity groups
koronaAccountId String account id of the korona.cloud account

Return type

[AddOrUpdateResult]

Authorization

basicAuth

HTTP request headers

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