Relativity Forms API
What is Relativity Forms?
Note: If you have customized Classic Forms pages, be aware that Relativity Forms may introduce breaking changes to your classic forms customizations. See the Migrating applications to Relativity Forms topic for more information on migrating to Relativity Forms. .
The Implementing Relativity Forms event handlers topic provides details on how to use the Relativity Forms API.
Conceptually, a forms page has four main workflows:
- Change (also known as interaction)
- Submit (also known as save)
The page then completes its rendering, executing the handlers for the load life cycle which were defined in the scripts which the page downloaded moments beforehand.
In the context of Relativity Forms, the four main workflows are referred to as pipelines:
To aid you, each handler which you implement is provided with:
- A this binding which contains methods and metadata specific to the currently active object.
- A robust convenienceApi object supplying functionality to do things like directly access and manipulate fields without DOM lookup, make http requests, populate the page's Console, and more.