Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API in Confluence

...

Tip
titleNew! REST API documentation on docs.requirementyogi.com!

See:

Info
titleExperimental 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.

...

Base URL

...

The "base URL" is the address of Confluence. It could be:

...

Try with {baseUrl}/admin/viewgeneralconfig.action to ensure you have the right one. In the following documentation, we will omit the base URL.

...

Also available inside of the application: Atlassian's REST API Browser

(tick) Install and use Atlassian's REST API Browser and explore URLs inside of your Confluence / or Jira application:

Tip
titleNew! REST API documentation on docs.requirementyogi.com!

See:

Go to https://docs.requirementyogi.com

 → All the documentation for developers
  • The REST API for version 2.5 → The first version of the REST documentation
  • https://docs.requirementyogi.com/javadocs/ → All the REST and Javadocs for all versions

     for our developer portal.


    REST Resources in Confluence

    ...