| | |
|---|
PARAMETERS FOR ALL SCOPES |
name | string Required | The name of the snapshot. |
scope | string Required | Accepted values: "system", "project" or "projectWithIssues". |
description | string Optional | The description of the snapshot. |
PARAMETERS FOR SCOPES: PROJECT, PROJECT WITH ISSUES |
projectKey | array of strings Required | Includes one or more selected projects. Example: For single-project snapshots: For multi-project snapshots: "projectKey" : [
"PRJA",
"PRJB"
] |
filters | array of objects Optional | Includes the filters that match the provided "filterId". Example: "filters" : [{
"filterId" : 1
}] |
includeProjectFilters | boolean Optional Default value: false | Includes all filters referenced by the projects in the snapshot. Learn more. |
agileBoards | array of objects Optional | Includes the agile boards that match the provided "boardId". Example: "agileBoards" : [{
"boardId" : 1
}] |
includeProjectBoards | boolean Optional Default value: false | Includes all boards of the projects exported with the snapshot. Learn more. |
includeProjectAutomationRules | boolean Default value:
false Optional | Includes all automation rules associated with the selected projects. Learn more. |
includeGlobalAutomationRules | boolean Default value:
false Optional | Includes all global automation rules. Learn more. |
dashboards | array of objects Optional | Includes the dashboards that match the provided "dashboardId". Example: "dashboards" : [{
"dashboardId" : 1
}] |
appsWithGlobalData | array of objects Optional | Includes the global configuration and/or data objects of all specified Jira apps integrated with the respective Service Provider Interface (SPI) integration points. Learn more. Available objects: "key" - specifies the app's key;
"includeGlobalConfiguration" - includes the global app configuration settings of the app specified by the "key" parameter. The app must be integrated with CMJ via the SPI global configuration integration point.
"appDataIds" - includes custom functionality of an app that extends standard Jira functions. The selected app must be integrated with CMJ via the SPI app data integration point.
Example: "appsWithGlobalData" : [
{
"key": "com.botronsoft.jira.rollout.spi-test-plugin",
"includeGlobalConfiguration": "true",
"appDataIds": [
{
"typeId" : "typeOneId",
"objectIds" : ["id1", "id2", "id3"]
},
{
"typeId" : "typeTwoId",
"objectIds" : ["id3"]
}
]
}
] |
filter
Only applicable to the Project with issues scope. | string Optional | Includes only issues filtered by a JQL query. Example: "filter":"issueType = Bug" |
includeOnlyArchivedIssues | boolean Optional Default value: false | Includes only archived issues. |
options | object Optional | Specifies additional data that can be included in the snapshot. Available options: "includeAttachmentFiles" (only applicable to project with issues scope) - includes issue attachment files for the selected projects. If the value is false, during snapshot deployment there's an option to provide the path where the attachment files reside on the target system.
"checkCustomFieldValues" (only applicable to project scope)- includes custom fields with value in at least one issue in the project. If the value is false, only custom fields referenced by the project configuration will be included.
The default value of both options is false if not else specified or if the "options" parameter is not used. Example: "options" : {
"includeAttachmentFiles" : true,
"checkCustomFieldValues" : true
} |
PARAMETERS FOR SCOPE: SYSTEM |
includeGlobalAppData | boolean Default value: false Optional | Includes the global configuration data of all Jira apps integrated with CMJ. |
includeAllFilters | boolean Default value: false Optional | Includes all filters. |
includeAllBoards | boolean Default value: false Optional | Includes all agile boards. |
includeAllDashboards | boolean Default value: false Optional | Includes all dashboards. |
includeAllAutomationRules | boolean Default value:
false Optional | Includes all automation rules. |
