...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
This manual shows how to interact with the plugin over REST API. Every function of the plugin could be performed with REST also.
...
Get All Bundles of a Project
Returns all bundles for the requested project.
| Code Block |
|---|
GET /rest/com.deniz.jira.mapping/latest/bundles?projectKey={projectKey} |
Response is a JSON array of bundles defined for the project.
| Code Block |
|---|
[
{
"id": 3,
"versionId": 10005,
"projectKey": "ERP",
"projectId": 10000,
"releaseDate": 1458165600000,
"bundleName": "A New Bundle",
"releaseDateStr": "17/Mar/16",
"released": true
}
] |
Get a Bundle with Bundle Id
Returns information about a bundle with requested id. This returns only information on bundle not components containd in the bundle.
| Code Block |
|---|
GET /rest/com.deniz.jira.mapping/latest/bundles/{bundleId} |
Response is a JSON document with bundle information. Release date may not be available if bundle is not released.
| Code Block |
|---|
{
"id": 3,
"versionId": 10005,
"projectKey": "ERP",
"projectId": 10000,
"releaseDate": 1458165600000,
"bundleName": "A New Bundle",
"releaseDateStr": "17/Mar/16",
"released": true
} |
Add a New Bundle
Create a new bundle.
| Code Block |
|---|
POST /rest/com.deniz.jira.mapping/latest/bundles/ |
You should include bundle information to be included in the request body. You don't need to include releaseDate if bundle is not released.
| Code Block |
|---|
{
"versionId": 10005,
"bundleName": "A New Bundle",
"releaseDate": 1458165600000,
"released": true
} |
Response is a JSON document with created mapping information. Id of bundle can be used for further requests.
| Code Block |
|---|
{
"id": 3,
"versionId": 10005,
"projectKey": "ERP",
"projectId": 10000,
"releaseDate": 1458165600000,
"bundleName": "A New Bundle",
"releaseDateStr": "17/Mar/16",
"released": true
} |
...
| Code Block |
|---|
PUT /rest/com.deniz.jira.mapping/latest/bundles/{bundleId} |
You should include bundle information to be included in the request body. You don't need to include releaseDate if bundle is not released. Note that this is not additive, it completely overrides existing information for the bundle. For example if you don't include released flag, it is assumed to be false and unreleases the bundle.
| Code Block |
|---|
{
"versionId": 10005,
"releaseDate": 1458165600000,
"bundleName": "New Name",
"released": true
} |
Response is a JSON document with updated mapping information.
| Code Block |
|---|
{
"versionId": 10005,
"releaseDate": 1458165600000,
"bundleName": "New Name",
"released": true
} |
...