Configuration Manager for Jira (CMJ) version 1.2

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

/snapshots

Manage snapshots.

post

post

Creates a new snapshot. The scope of the snapshot can be either 'system' or 'project'. The 'options' array is not required.

Creates a new snapshot. The scope of the snapshot can be either 'system' or 'project'. The 'options' array is not required.

Body

Media type: application/json

Type: any

Example:

{
  "name" : "My Project Snapshot",
  "description" : "Interesting snapshot",
  "scope" : "project",
  "projectKey" : "PRJ",
  "filters" : [ {
    "filterId" : 10001
  },
  {
    "filterId" : 10010
  } ],
  "agileBoards" : [ {
    "boardId" : 10001
  },
  {
    "boardId" : 10010
  } ],
  "dashboards" : [ {
    "dashboardId" : 10001
  },
  {
    "dashboardId" : 10010
  } ],
  "options" : {
    "checkCustomFieldValues" : true
  }
}

or

{
  "name" : "My Project Snapshot",
  "description" : "Interesting snapshot",
  "scope" : "project",
  "projectKey" : [
    "PRJA",
    "PRJB"
  ],
  "filters" : [ {
    "filterId" : 10001
  } ],
  "agileBoards" : [ {
    "boardId" : 10001
  } ],
  "dashboards" : [ {
    "dashboardId" : 10001
  } ],
  "options" : {
    "checkCustomFieldValues" : true
  }
}

or

{
  "name" : "My System Snapshot",
  "description" : "Interesting snapshot",
  "scope" : "system",
  "includeAllFilters" : true,
  "includeAllBoards" : true,
  "includeAllDashboards" : true
}

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.

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.

Body

Media type: application/json

Type: any

Example:

{
  "scope" : "system",
  "mode" : "systemMerge",
  "options" : {
    "mergeVersionsAndComponents" : true,
    "mergeProjectRoles": true,
    "systemDoNotDeployGlobalPermissions" : true
  }
}

or

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

or

{
  "scope" : "project",
  "mode" : "singleProject",
  "projectKey" : "TEST",
  "options" : {
    "createNewProject" : true,
    "newProjectKey" : "PRJ",
    "newProjectName" : "My Project",
    "mergeVersionsAndComponents" : false,
    "mergeProjectRoles": false
  }
}

or

{
  "scope" : "project",
  "mode" : "multiProject",
  "options" : {
    "mergeVersionsAndComponents" : true,
    "mergeProjectRoles": true
  }
}

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"
}

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: object

Properties
  • formData: (string)

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.