Versions Compared

Key

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

On this page:

Table of Contents

...

minLevel1
maxLevel6
include
outlinefalse
indent
styledefault
exclude
typelist
class
printabletrue

SPI API reference

If you need more technical information on the latest SPI OpenAPI specs, please read the complete API reference.

...

Invoke the Operations API

The Operations API is the REST API that CMJ Cloud provides and can be invoked by apps implementing the SPI for various services.

...

...

Report results and progress

CMJ Cloud works with apps asynchronously - an operation is started, and then the app must call back CMJ via the Operations API to notify that it is done.

...

Code Block
languagejson
{
  "progress":0.5
}

...

Map configuration elements

When configuration and data are moved between different instances of Jira, the IDs of the different configuration elements change. The same applies to migrations to Jira Cloud. The data exported by your app may contain references to configuration elements that need to be updated with the new IDs.

...

For example, in your Server SPI implementation, you might be referring to a user by their username. However, in the Cloud, you need to know the id ID of that user. You can use the Operations API’s output to match the user’s key and id.

...