14.2. Getting Started

Example 14-2. Sign off

// utoken is the access token
 
var api_url = 'localhost:8080/token';
request = new XMLHttpRequest();
 
request.open('DELETE', api_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // User signed off successfully
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-3. Get a list of subdomains

// udom - is the Domain id which we want to get subdomains
// utoken - access token
 
//
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// Call domains function with udom parameter
request.open('GET', api_url + '/domains/' + udom, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of domains with their object id,
      // version and label, parse it.
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-4. Get Domain StatusInfo

// udom - is the Domain id which we want to get subdomains with StatusInfo objects
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to StatusInfo function
var si_url = '/domains/' + udom + '/statusinfo';
 
// Call get statusinfo function with udom parameter
request.open('GET', api_url + si_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of domains with StatusInfo object,
      // parse it.
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-5. Get Domain template

// udom - is the Domain where we want to create a new one
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to template function
var template_url = '/domains/' + udom + '/template';
 
request.open('GET', api_url + template_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of editable properties,
      // parse it.
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-6. Create a new Domain

// udom - is the Domain where we want to create a new one
// utoken - access token
// req_xml is xml that contain a list of properties with values
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/domains/' + udom;
 
request.open('POST', api_url + func_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-type', 'text/xml');
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 201) {
      // Domain was created, it's id is in the 'location' header
      // and version is in the 'content-version'
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(req_xml);

Example 14-7. Edit domain properties

// domain_id - is the domain we want to edit
// version - current version of the domain
// utoken - access token
// req_xml is the xml that contain a list of properties we want to change
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/domains/' + domain_id;
 
request.open('PUT', api_url + func_url, true);
 
// Setup required headers
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-version', version);
request.setRequestHeader('content-type', 'text/xml');
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // Domain was updated, the new version is in the 'content-version'header
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(req_xml);

Example 14-8. Delete a Domain

// domain_id - is the domain we want to delete
// version - current version of the domain
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/domains/' + domain_id;
 
request.open('DELETE', api_url + func_url, true);
 
// Setup required headers
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-version', version);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // Domain was deleted
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-9. Get a list of Nodes

// udom - is the Domain id which we want to get Nodes
// utoken - access token
 
//
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// Call nodes function with udom parameter
request.open('GET', api_url + '/nodes/' + udom, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of nodes with their object id,
      // version and label, parse it.
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-10. Get Node template

// udom - is the Domain where we want to create a new Node
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to template function
var template_url = '/nodes/' + udom + '/template';
 
request.open('GET', api_url + template_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of editable properties,
      // parse it.
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-11. Create a new Node

// udom - is the Domain where we want to create a new node
// utoken - access token
// req_xml is xml that contain a list of properties with values
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/nodes/' + udom;
 
request.open('POST', api_url + func_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-type', 'text/xml');
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 201) {
      // Node was created, it's id is in the 'location' header
      // and version is in the 'content-version'
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(req_xml);

Example 14-12. Update Node properties

// node_id - is the id of node we want to edit
// version - current version of the node
// utoken - access token
// req_xml is the xml that contain a list of properties we want to change
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/nodes/' + node_id;
 
request.open('PUT', api_url + func_url, true);
 
// Setup required headers
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-version', version);
request.setRequestHeader('content-type', 'text/xml');
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // Node was updated, the new version is in the 'content-version' header
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(req_xml);

Example 14-13. Delete a Node

// node_id - is the id of node we want to delete
// version - current version of the node
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/nodes/' + domain_id;
 
request.open('DELETE', api_url + func_url, true);
 
// Setup required headers
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-version', version);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // Node was deleted
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-14. Read the check groups

// node_id - entry point to start traversing the checks tree
// utoken - access token
 
//
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
request.open('GET', api_url + '/subtree/' + node_id, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of checkgroup/check objects with their
      // object id, version and label
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-15. Get all active checks

// node_id - this function requires node id to apply filter
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// Notice that we don't specify filter - by default function returns all active checks
request.open('GET', api_url + '/checks/' + node_id, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of active checks with CheckSummary
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-16. Get active ESXi checks in WARNING state

// node_id - this function requires node id to apply filter
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// Get active ESXi checks that are in WARN state
var filter = '/type=esxichecks&status=warn';
request.open('GET', api_url + '/checks/' + node_id + filter, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of active checks with ScoreInfo
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-17. Request a check template for Network Check

// check_grp - notice that we need to pass a Network Checks group.
// utoken - access token
// sibling - is the sibling name of the check we want to get template.
// Use 'get /subtree' to get a full list of network checks with their SiblingNames
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to template function
var template_url = '/checks/' + check_grp + '/template/' + sibling;
 
request.open('GET', api_url + template_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of editable properties,
      // parse it.
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-18. Create a check

// id - parent check group id
// utoken - access token
// req_xml is xml that contain a list of properties with values
// sibling - is the sibling name of the check we want to create
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/checks/' + id + '/template/' + sibling;
 
request.open('POST', api_url + func_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-type', 'text/xml');
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 201) {
      // Check was created, it's id is in the 'location' header
      // and version is in the 'content-version'
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(req_xml);

Example 14-19. Get a lis of editable properties of the given check

// check_id - id of check we want to get a list of editable properties.
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to template function
var template_url = '/checks/' + check_id + '/template/';
 
request.open('GET', api_url + template_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of editable properties,
      // parse it.
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-20. Update a check

// check_id - is the id of check we want to edit
// version - current version of the check
// utoken - access token
// req_xml is the xml that contain a list of properties we want to change
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/checks/' + check_id;
 
request.open('PUT', api_url + func_url, true);
 
// Setup required headers
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-version', version);
request.setRequestHeader('content-type', 'text/xml');
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // Check was updated, the new version is in the 'content-version' header
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(req_xml);

Example 14-21. Delete a Check

// check_id - check we want to delete
// version - current version of the check
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/checks/' + check_id;
 
request.open('DELETE', api_url + func_url, true);
 
// Setup required headers
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-version', version);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // Check was deleted
      ....
    } else if (request.status == 202) {
      // Check was made inactive - new version is in content-version header
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-22. Get a list of Users

// domain_id - Domain we want to get a Users list
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
request.open('GET', api_url + '/users/' + domain_id, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of users registered in the domain
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-23. Get User template

// udom - is the Domain where we want to create a new User
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to template function
var template_url = '/users/' + udom + '/template';
 
request.open('GET', api_url + template_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of editable properties,
      // parse it.
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-24. Create a new User

// udom - is the Domain where we want to create a new user
// utoken - access token
// req_xml is xml that contain a list of properties with values
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/users/' + udom;
 
request.open('POST', api_url + func_url, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-type', 'text/xml');
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 201) {
      // USer was created, it's id is in the 'location' header
      // and version is in the 'content-version'
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(req_xml);

Example 14-25. Update a User

// user_id - is the id of user we want to edit
// version - current version of the user
// utoken - access token
// req_xml is the xml that contain a list of properties we want to change
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/users/' + node_id;
 
request.open('PUT', api_url + func_url, true);
 
// Setup required headers
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-version', version);
request.setRequestHeader('content-type', 'text/xml');
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // User was updated, the new version is in the 'content-version' header
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(req_xml);

Example 14-26. Delete a User

// user_id - is the id of user we want to delete
// version - current version of the user
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
// URL to the function
var func_url = '/users/' + domain_id;
 
request.open('DELETE', api_url + func_url, true);
 
// Setup required headers
request.setRequestHeader('authorization', 'Basic ' + utoken);
request.setRequestHeader('content-version', version);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // User was deleted
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);

Example 14-27. Get object properties

// id - opject id want to get a list of properties
// utoken - access token
 
var api_url = 'localhost:8080';
request = new XMLHttpRequest();
 
request.open('GET', api_url + '/objects/' + id, true);
request.setRequestHeader('authorization', 'Basic ' + utoken);
 
request.onreadystatechange = function() {
  if (request.readyState == 4) {
    if (request.status == 200) {
      // We got xml which contain a list of properties of the object
      ....
    }
    else {
      // Handle errors
      ....
    }
  }
};
 
request.send(null);