Parameters and Limitations of CMJ public REST API
The current version 1.3 of the REST API is lagging behind. Currently there are more features available through the UI, and not everything is achievable through REST. We are planning to update the REST API and entirely redesign the documentation.
Available methods
For all available methods in the latest API refer to this page. Click on the methods to see examples.
The examples incorporate all available options/parameters parameters. To summarize:
The export options (/snapshots POST) are:
checkCustomFieldValues, includeAttachmentFiles
Regarding filters, boards, dashboards: for project snapshots you can only pass lists of their ids. For system you can choose to includeAllFilters, includeAllBoards, includeAllDashboards.
Â
Import options (/deployments POST) are as follows:
Â
For System snapshots:
mergeVersionsAndComponents, mergeProjectRoles, systemDoNotDeployGlobalPermissions
Â
Project:
mergeVersionsAndComponents, mergeProjectRoles, createNewProject, newProjectKey, newProjectName
Â
Project with issues:
mergeProjectRoles, createNewProject, newProjectKey, newProjectName, attachmentFilesPath
Â
Â
Skipping descriptions, avatars and reindexing, as well as selective merge and custom field resolution are not yet available through rest.
Hope this helps! Stay tuned for updates.