example

var currentDate = api.createDate(new Date().getTime());

example

try {
  ldapResult = api.executeLdapQuery("OU=Engineering", "(&(objectCategory=user)(objectClass=user))", ["sAMAccountName", "givenName", "sn", "mail"]);
} catch(e) {
  api.printLog("LDAP error: " + e.message);
}

example

var propertyInfoObject = api.getPropertyInfo("Project", "Accountability");
// Create the string to be logged
var propertyInfo = 'Project - Accountability '
  + '(type: ' + propertyInfoObject.type
  + ', multiple: ' + propertyInfoObject.multiple
  + ', mandatory: ' + propertyInfoObject.mandatory + ')';
// log the information
api.printLog(propertyInfo);

deprecated

Use UserApi.get instead.

remarks

This is the only way to log information. Do NOT try to use log.debug or similar things.

remarks

This and Api.subscribeFor are the only two functions that should be called at the top level scope of a plugin script.

example

api.registerExecution(test);

function test() {
  api.printLog('Function test executing');
}

remarks

This is only intended for usage in callbacks for Api.subscribeFor! Do not use it in callbacks to Api.registerExecution, as this might have unintended side effects.

Please see the Subscriptions for more information on how to configure Mail-notifications. // TODO: Delete or specify

example

var subject = "Example subject";
var content = "Example mail content"
api.sendEmail(user.getEmail(), subject, content);

remarks

This and Api.registerExecution are the only two functions that should be called at the top level scope of a plugin script.

example

api.subscribeFor('ItService', test);

// This comment is necessary for autocompletion in the editor to work.
// You dont need it for the script itself to work.
/**
 @param {BuildingBlockType} bbt
 @param {ChangeEvent} ev
*\/   (Note: Remove the \ here)
function test(bbt, ev) {
  for (var i = 0; i < ev.length; i++) {
    var e = ev[i];
    if (e.changeType === 'DELETE') {
      var bb = api.datamodel.findByTypeAndId(bbt, e.id);
    }
  }
}