Learn how our REST API works in Confluence

New! REST API documentation on

developer.requirementyogi.com!

See:

• https://developer.requirementyogi.com → All the documentation for developers

• The REST API for version 2.5 → The first version of the REST documentation

• https://developer.requirementyogi.com/javadocs/ → All the REST and Javadocs for all versions

Experimental API

Our API is subject to changes.

• When we annotate @Public, we attempt with "best effort" to keep the API backwards-compatible for as long as possible.

  • If we want to deprecate, we will annotate with @Deprecated for a few versions, then remove it in the major version (in "platform.major.micro" versioning scheme, for example in 2.2.0).

  • We may add parameters, not remove them.

• When we annotate @Internal, we don't even try to keep it stable, it usually changes from 1 micro version to another. Those APIs are tightly couples with the Javascript.

• When we don't annotate, please consider it as @Internal.

This documentation is only designed for programmers. It is provided as is, and programmers are expected to be good enough to solve problems.