Kentico CMS 6.0 Developer's Guide

Running API examples

Running API examples

Previous topic Next topic Mail us feedback on this topic!  

Running API examples

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

All API examples can be run by clicking the respective buttons in the module API examples user interface. In this interface you can display also the examples code. To prevent any failures, it is recommended to follow the API examples order in the Creating and managing section and the reversed order in the Cleanup section. Please note that API examples marked blue in the user interface can be skipped.

 

Running an API example may result in:

 

Success - the operation ran as expected.

devguide_clip1536

 

Failure - due to non-existence of the object. The given object was not found in the database.

devguide_clip1538

 

Failure - due to other reasons. You can refer to the event log for more details.

devguide_clip1537

 

API examples in the Creating and managing section and those in the Cleanup section can also be run all at once by clicking the Run all (Run_API) and Cleanup all (Cleanup_all) icons, respectively.

 

devguide_clip1541

 

Please note that the result of running an API example can be verified in the UI listing or directly in the corresponding table in the database.