API docs by Redocly

CMJ Cloud Operations API (1.1.17)

Download OpenAPI specification:Download

E-mail: support@appfire.com License: Creative Commons license (CC BY 4.0) Terms of Service

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

Find out more about CMJ Service Provider Interface

Operation progress

This resource can be used for updating the progress during an SPI operation.

Updates progress

Updates the progress of the SPI operation. This is an optional API that an app can invoke to update the progress for a given SPI operation.

Authorizations:
bearerAuth
path Parameters
operationId
required
string

The id of the operation as received when the app SPI endpoint was invoked.

Request Body schema: application/json

The updated progress for the operation.

progress
required
number [ 0 .. 1 ]

A double in the interval [0.0, 1.0] which represents the progress for the SPI operation.

Responses

Request samples

Content type
application/json
{
  • "progress": 0.25
}

Operation result

This resource can be used for submitting the result of an SPI operation.

Submits result

Submits the result of the SPI operation.

Authorizations:
bearerAuth
path Parameters
operationId
required
string

The id of the operation as received when the app SPI endpoint was invoked.

Request Body schema: application/json

The result of the operation.

resultLink
string <uri>

A link to a result page displayed to the user in the report for the SPI operation. This link takes precedence over the resultHtml field in the final report.

resultHtml
string

An HTML that will be displayed to the user in the report for the SPI operation. This HTML will be sanitized. This is suitable for small html reports up to several MBs.

Array of objects (Problem)

The list of problems that have been encountered by the app during the invocation of the SPI endpoint.

Responses

Request samples

Content type
application/json
{
  • "resultLink": "http://example.com",
  • "resultHtml": "string",
  • "problems": [
    ]
}

Object mappings

This resource represents the mappings of object identifiers between source and target.

Returns object mappings

Returns the Jira configuration object mappings for a given operation.

Authorizations:
bearerAuth
path Parameters
operationId
required
string

The id of the operation as received when the app SPI endpoint was invoked.

query Parameters
pageSize
integer [ 1 .. 1000 ]
Default: 1000

The size of the requested page.

lastItemKey
string

The key to fetch the next page.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

Workflow data

This resource can be used for submitting exported workflow data.

Submits workflow rules data

Submits workflow rules data for the given rules

Authorizations:
bearerAuth
path Parameters
operationId
required
string

The id of the operation as received when the app SPI endpoint was invoked.

Request Body schema: application/json

The workflow rules.

workflowId
required
string

A key that identifies the data.

required
Array of objects (WorkflowRuleData)

The list of workflow rules and their configuration.

Responses

Request samples

Content type
application/json
{
  • "workflowId": "string",
  • "workflowRules": [
    ]
}