Skip to content

InfoTextsApi.md

Latest commit

 

History

History
executable file
·
129 lines (88 loc) · 4.01 KB

InfoTextsApi.md

File metadata and controls

executable file
·
129 lines (88 loc) · 4.01 KB
Raw

KoronacloudApiV3.InfoTextsApi

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

Method HTTP request Description
getInfoText GET /accounts/{koronaAccountId}/infoTexts/{infoTextId} returns the single info text
getInfoTexts GET /accounts/{koronaAccountId}/infoTexts lists all info texts

getInfoText

InfoText getInfoText(infoTextId, koronaAccountId)

returns the single info text

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

var infoTextId = "infoTextId_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.getInfoText(infoTextId, koronaAccountId, callback);

Parameters

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

Return type

InfoText

Authorization

basicAuth

HTTP request headers

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

getInfoTexts

ResultListInfoText getInfoTexts(koronaAccountId, opts)

lists all info texts

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

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

ResultListInfoText

Authorization

basicAuth

HTTP request headers

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