Configuration Manager for Jira (CMJ) version 1.6

http://yourjira.com/jira/rest/configuration-manager/api/1.6

/snapshots

Manage snapshots.

post

post

Creates a new snapshot. The scope of the snapshot can be either 'system', 'project' or 'projectWithIssues'. The 'options' array is not required. The 'includeAttachmentFiles' flag will include issue attachment files for the selected projects. If unselected, during snapshot deployment there's an option to provide the path where the attachment files reside on the target system. All filters/boards/dashboards/global app data can be included. Individual items can be included explicitly using the 'filters', 'agileBoards', 'dashboards' and 'appsWithGlobalData' parameters. Filters and boards related to the exported projects can be included with the includeProjectFilters/includeProjectBoards options (not available for system snapshot). Exported issues can be filtered using the 'filter' parameter. Please refer to the examples for details!

Creates a new snapshot. The scope of the snapshot can be either 'system', 'project' or 'projectWithIssues'. The 'options' array is not required. The 'includeAttachmentFiles' flag will include issue attachment files for the selected projects. If unselected, during snapshot deployment there's an option to provide the path where the attachment files reside on the target system. All filters/boards/dashboards/global app data can be included. Individual items can be included explicitly using the 'filters', 'agileBoards', 'dashboards' and 'appsWithGlobalData' parameters. Filters and boards related to the exported projects can be included with the includeProjectFilters/includeProjectBoards options (not available for system snapshot). Exported issues can be filtered using the 'filter' parameter. Please refer to the examples for details!

Body

Media type: application/json

Type: any

Example:

{
  "name" : "Project Snapshot",
  "description" : "A snapshot of all project PRJ configuration",
  "scope" : "project",
  "projectKey" : "PRJ",
}

or

{
  "name" : "Multi-project Snapshot",
  "description" : "Multi-project snapshot with explicitly included filters, boards and dashboards, and custom fields referenced in custom field values for issues in these projects",
  "scope" : "project",
  "projectKey" : [
    "PRJA",
    "PRJB"
  ],
  "filters" : [ {
    "filterId" : 10001
  } ],
  "agileBoards" : [ {
    "boardId" : 10001
  } ],
  "dashboards" : [ {
    "dashboardId" : 10001
  } ],
  "options" : {
    "checkCustomFieldValues" : true
  },
}

or

{
  "name" : "Project Snapshot with Issues",
  "description" : "Project snapshot with issues - attachment files included",
  "scope" : "projectWithIssues",
  "projectKey" : [
    "PRJA",
    "PRJB"
  ],
  "options" : {
    "includeAttachmentFiles" : true
  },
}

or

{
  "name" : "System Snapshot",
  "description" : "System snapshot including all filters, boards, dashboards and supported 3rd party app data on the system. The option to include all filters etc. is also available for (multi)project snapshots as well.",
  "scope" : "system",
  "includeAllFilters" : true,
  "includeAllBoards" : true,
  "includeAllDashboards" : true,
  "includeGlobalAppData": true,
}

or

{
  "name" : "Project Snapshot with related filters and boards",
  "description" : "Project snapshot including all project filters and boards (which reference the project in their JQL query)",
  "scope" : "project",
  "includeProjectFilters" : true,
  "includeProjectBoards" : true,
}

or

{
  "name" : "Project Snapshot including an app's global data",
  "description" : "Project snapshot including global app data of a single app",
  "scope" : "project",
  "projectKey" : [ "PRJA", "PRJB" ],
  "appsWithGlobalData" : [
        {
          "key": "com.botronsoft.jira.rollout.spi-test-plugin",
          "includeGlobalConfiguration": "true",
          "appDataIds": [
            {
              "typeId" : "typeOneId",
              "objectIds" : ["id1", "id2", "id3"]
            },
            {
              "typeId" : "typeTwoId",
              "objectIds" : ["id3"]
            }
          ]
        },
        {
          "key": "com.botronsoft.jira.rollout.spi-annotation-test-plugin",
          "includeGlobalConfiguration": "false",
          "appDataIds": [
            {
              "typeId" : "type1Id",
              "objectIds" : ["id6", "id7"]
            },
            {
              "typeId" : "type2Id",
              "objectIds" : ["id5"]
            }
          ]
        }
    ]
}
or

{
  "name" : "Project Snapshot with filtered issues",
  "description" : "Project snapshot with issues using an additional filter: this snapshot includes Bugs only",
  "scope" : "projectWithIssues",
  "projectKey" : [
    "PRJA",
    "PRJB"
  ],
  "filter":"issueType = Bug",
}

HTTP status code 201

Response containing metadata about the snapshot.

Headers

  • Location: required(string)

    The URI pointing to the newly created snapshot.

Body

Media type: application/json

Type: any

Example:

{
  "id": 1,
  "objectCount": 86
}

HTTP status code 400

Request is invalid. Some of the required parameters are not provided.

HTTP status code 403

User does not have permissions to create a snapshot.

get delete

Manage the snapshot with the given id.

get

Returns the specified snapshot as ZIP containing a snapshot XML and additional data.

delete

Deletes the specified snapshot.

Returns the specified snapshot as ZIP containing a snapshot XML and additional data.

URI Parameters

  • id: required(integer)

    The id of the snapshot.

HTTP status code 200

Snapshot successfully retrieved.

Body

Media type: application/octet-stream

Type: any

Example:

A .zip file containing the snapshot XML in the following form along with additional data:

<?xml version="1.1" encoding="UTF-8"?>
<jiraconfiguration:JiraConfigurationRoot xmi:version="2.0" type="System" name="My snapshot">
...
</jiraconfiguration:JiraConfigurationRoot>

HTTP status code 400

Request is invalid.

HTTP status code 403

User does not have permissions to create a snapshot.

HTTP status code 404

No snapshot with the given id.

Deletes the specified snapshot.

URI Parameters

  • id: required(integer)

    The id of the snapshot.

HTTP status code 204

Snapshot successfully deleted.

HTTP status code 400

Request is invalid.

HTTP status code 403

User does not have permissions to create a snapshot.

HTTP status code 404

No snapshot with the given id.

/deployments

Manage deployments. Deployment is a two step process - first meta information is provided and then a snapshot file is uploaded. The operation is asynchronous - a separate REST endpoint is used for tracking deployment progress.

post

post

Starts a deployment operation. Scope can be either 'system' or 'project'. Mode can be either 'systemMerge'/'systemRestore' for system snapshots, or 'singleProject'/'multiProject' for project snapshots depending on the number of projects inside the snapshot. The parameter attachmentFilesPath is the path where the attachment files reside on this system. Choosing 'skipReindexing' makes the deployment operation faster by skipping reindexing. In this case reindexing should be done later by the user. Remaining request options when set to TRUE are used to deploy modifications of associated objects. For example, 'modifyAvatars' will ignore changes to avatars if set to FALSE but include them if left at TRUE.

Starts a deployment operation. Scope can be either 'system' or 'project'. Mode can be either 'systemMerge'/'systemRestore' for system snapshots, or 'singleProject'/'multiProject' for project snapshots depending on the number of projects inside the snapshot. The parameter attachmentFilesPath is the path where the attachment files reside on this system. Choosing 'skipReindexing' makes the deployment operation faster by skipping reindexing. In this case reindexing should be done later by the user. Remaining request options when set to TRUE are used to deploy modifications of associated objects. For example, 'modifyAvatars' will ignore changes to avatars if set to FALSE but include them if left at TRUE.

Body

Media type: application/json

Type: any

Example:

{
  "scope" : "system",
  "mode" : "systemMerge",
  "options" : {
    "modifyProjectVersions" : false,
    "modifyProjectComponents" : true,
    "modifyProjectRoles": true,
    "modifyProjectShortcuts": false,
    "modifyGlobalPermissions" : false,
    "modifyAvatars" : true,
    "modifyFieldDefaultValues" : true,
    "modifyFieldOptions" : true,
    "modifyIssueTypesInContexts" : true,
    "modifyObjectDescriptions" : true,
    "modifyObjectTranslations" : true,
    "modifyStatusCategories" : false,
    "modifyPriorityColors" : false,
    "skipReindexing" : true
  }
}

or

{
  "scope" : "system",
  "mode" : "systemRestore"
}

or

{
  "scope" : "system",
  "mode" : "systemMerge",
  "options" : {
    "modifyProjectVersions" : false,
    "modifyProjectComponents" : false,
    "modifyProjectRoles": false,
    "modifyProjectShortcuts": false,
    "modifyGlobalPermissions" : false,
    "modifyAvatars" : false,
    "modifyFieldDefaultValues" : false,
    "modifyFieldOptions" : false,
    "modifyIssueTypesInContexts" : false,
    "modifyObjectDescriptions" : false,
    "modifyObjectTranslations" : false,
    "modifyStatusCategories" : false,
    "modifyPriorityColors" : false
  }
}

or

{
  "scope" : "project",
  "mode" : "singleProject",
  "projectKey" : "TEST",
  "options" : {
    "createNewProject" : true,
    "newProjectKey" : "PRJ",
    "newProjectName" : "My Project",
    "modifyProjectVersions" : true,
    "modifyProjectComponents" : true,
    "modifyProjectRoles": true,
    "modifyMovedIssueKeys": true,
    "attachmentFilesPath" : "C:\\attachments"
  }
}

or

{
  "scope" : "project",
  "mode" : "multiProject",
  "options" : {
    "modifyProjectVersions" : false,
    "modifyProjectComponents" : false,
    "modifyProjectRoles": false,
    "modifyMovedIssueKeys": false,
    "attachmentFilesPath" : "C:\\attachments"
  }
}

HTTP status code 201

Deployment operation created. Returns the id of the operation.

Headers

  • Location: required(string)

    The URI for checking the progress of the deployment operation.

Body

Media type: application/json

Type: any

Example:

{
  "id" : 1
}

HTTP status code 400

Request is invalid.

HTTP status code 403

User does not have permissions to deploy a snapshot.

get

Manage the deployment with the given id.

get

The status of the deployment operation with the given id.

The status of the deployment operation with the given id.

URI Parameters

  • id: required(integer)

    The deployment operation id.

HTTP status code 200

Status successfully returned. Can be "waiting", "running", "failed", "succeeded".

Body

Media type: application/json

Type: any

Example:

{
  "id" : 1,
  "status" : "running"
}

or

{
  "id" : 1,
  "status" : "failed",
  "reason" : "Some explanation of the failure"
}

or

{
  "id" : 1,
  "status" : "succeeded"
}

HTTP status code 400

Request is invalid.

HTTP status code 403

User does not have permissions to check deployment status.

HTTP status code 404

No deployment operation with the given id.

put

Manage the snapshot content for the deployment with the given id.

put

Uploads the snapshot content. The snapshot content must be provided in a part named 'file' within a multipart/form-data body. After the content is successfully uploaded, the deployment process will start.

Uploads the snapshot content. The snapshot content must be provided in a part named 'file' within a multipart/form-data body. After the content is successfully uploaded, the deployment process will start.

URI Parameters

  • id: required(integer)

    The deployment operation id.

Query Parameters

  • file: required(string)

    The snapshot file to upload.

Body

Media type: multipart/form-data

Type: any

HTTP status code 200

Snapshot successfully uploaded and parsed.

HTTP status code 400

Request is invalid - in case the type of the snapshot does not match the type of deployment operation.

HTTP status code 403

User does not have permissions to deploy a snapshot.