Understanding the DevOps Plan Schema API

You can use this API to write code that runs within DevOps Plan (hook code), or that runs independently of an instance of the DevOps Plan application. You can also use the API to create an integration with a new or an existing application (service, tool, or utility) and the DevOps Plan application.

Type of Code: Example
Hook scripts for your DevOps Plan schema: Modify records that users submit, and validate the records before they are committed to the user database. (DevOps Plan Designer provides an editor for you to insert hook scripts.)
External applications that run outside of DevOps Plan: View or modify the data DevOps Plan stores in the user database and schema repository.
Integrations with an application and DevOps Plan: Integrate the functionality of a service, tool, or utility with the capability to view or modify the data DevOps Plan stores in the user database and schema repository. See Considerations for DevOps Plan integrations in the Schema Developer Help for more information.

DevOps Plan runs your hooks in Perl. DevOps Plan Designer allows you to switch between scripting languages. For more information, see the Schema Developer Help.

You can write external applications in any programming environment that can execute Perl scripts.

The DevOps Plan enumerated constants are preloaded and available for use in field hooks and record and global scripts. However, to use the constants in an external application, you must add the constant definitions to your program before you can use them in the program, or the values will not be set.

For Perl, include the following statement:
```
use CQPerlext;
```