API docs by Redocly

CMJ Cloud Workflows SPI (1.1.23)

Download OpenAPI specification:Download

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

CMJ Cloud Workflows SPI specification

Find out more about CMJ Service Provider Interface

Workflow rules

This resource represents an API that must be implemented by an app and will be invoked by CMJ whenever workflow rules provided by this app are migrated.

Imports workflow rules configuration coming from Jira Server.

Imports the configuration for all rules that an app supports for a single workflow. The rules have already been created in the workflow, the app implementing this endpoint must import the configuration.

Authorizations:
bearerAuth
path Parameters
importFromServerPath
required
string
Request Body schema: application/json

The required data that the app can use to import the workflow rule configuration.

required
object (MigrationMetadata)

Information about a CMJ Cloud migration.

required
object (JiraMetadata)

Information about a Jira instance.

required
object (JiraMetadata)

Information about a Jira instance.

required
object (WorkflowRulesImportContext)

The context for workflow rules import.

Responses

Request samples

Content type
application/json
{
  • "migrationMetadata": {
    },
  • "sourceJiraMetadata": {
    },
  • "targetJiraMetadata": {
    },
  • "context": {
    }
}

Exports workflow rules configuration to later import on Jira Cloud.

Exports the configuration for all rules that an app supports for a single workflow.

Authorizations:
bearerAuth
path Parameters
exportForCloudPath
required
string
Request Body schema: application/json

The required data that the app can use to export the workflow rule configuration.

required
object (MigrationMetadata)

Information about a CMJ Cloud migration.

required
object (JiraMetadata)

Information about a Jira instance.

required
object (WorkflowRulesExportContext)

The context for workflow rules export.

Responses

Request samples

Content type
application/json
{
  • "migrationMetadata": {
    },
  • "sourceJiraMetadata": {
    },
  • "context": {
    }
}

Imports workflow rules configuration coming from Jira Cloud.

Imports the configuration for all rules that an app supports for a single workflow. The rules have already been created in the workflow, the app implementing this endpoint must import the configuration.

Authorizations:
bearerAuth
path Parameters
importFromCloudPath
required
string
Request Body schema: application/json

The required data that the app can use to import the workflow rule configuration.

required
object (MigrationMetadata)

Information about a CMJ Cloud migration.

required
object (JiraMetadata)

Information about a Jira instance.

required
object (JiraMetadata)

Information about a Jira instance.

required
object (WorkflowRulesImportContext)

The context for workflow rules import.

Responses

Request samples

Content type
application/json
{
  • "migrationMetadata": {
    },
  • "sourceJiraMetadata": {
    },
  • "targetJiraMetadata": {
    },
  • "context": {
    }
}