Kentico CMS 6.0 Developer's Guide

Data used by the API examples

Data used by the API examples

Previous topic Next topic Mail us feedback on this topic!  

Data used by the API examples

Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic!  

All API examples work with their own objects in the MyNew<object> format. It means your module data in Kentico CMS should not be influenced by running API examples. However, all API examples actions directly affect the database.
 
Typically, the Create action creates an object in the MyNew<object> format, e.g. MyNewUser. The Get and Update action gets and updates the MyNew<object> object. And the Get and bulk update action gets and bulk updates objects which start with MyNew<object>. Please ensure that your own objects starting MyNew will not be overwritten. This can be done best by running API examples on a dedicated testing Kentico CMS installation.

 

If an API example needs to use one of the general objects (site, role, user, document etc.), the following ones are used:

 

For site - current site.

For role - role CMS Desk Administrator.

For user - current user.

For document - root document from the current site.

For country - USA.

For state - Alabama.

For currency - USD.

 

If other general objects are used in API examples, their list can be found in the Internals and API section of the respective module.