Projects Versions can be accessed through this API using the GET service.
Authentication - Use Basic Authentication for this API.
GET
GET (By Project ID)
This GET service will find a Project by Id and return a JSON representation of it. Project versions are sorted from newest to oldest.
API URL
http://{host:port}/flexdeploy/rest/v1/project/{projectId}/version
Latest project versions are returned first in response.
Request
Parameter | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | URL | This is a URL path parameter for the id which is used to find a project. |
Response
| Attributes | Type | Description |
|---|---|---|
| projectVersionId | Long | The Identification number of this project version. |
| projectVersionName | String | The Name of this project version. |
| isActive | Boolean | A boolean describing whether or not this project version is active. |
| projectStreamId | Long | The ID of the project stream associated with this project version. |
| packageName | String | The package name associated with this project version. |
| requestAllFiles | Boolean | A boolean describing whether or not all files are requested for this project version. |
| scmRevision | String | A string representation of the SCM revision of this project version. Null if no such revision exists. |
Response Codes
HTTP Code | Description |
|---|---|
200 | Project was found and it's versions returned |
400 | Bad request |
401 | Unauthorized |
404 | Project with the specified Id was not found |
500 | Unexpected internal server error |
Example
If we had the following project versions in a Project with a project ID of 10002:
Versions For Project 10002
[
{
"packageName": "1.0.12",
"isActive": true,
"requestAllFiles": false,
"scmevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.12",
"projectVersionId": 13117
},
{
"packageName": "1.0.11",
"isActive": false,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.11",
"projectVersionId": 13101
},
{
"packageName": "1.0.10",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.10",
"projectVersionId": 12954
},
{
"packageName": "1.0.9",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.9",
"projectVersionId": 12938
},
{
"packageName": "1.0.8",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.8",
"projectVersionId": 12922
},
{
"packageName": "1.0.7",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.7",
"projectVersionId": 12906
},
{
"packageName": "1.0.6",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.6",
"projectVersionId": 12890
},
{
"packageName": "1.0.5",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.5",
"projectVersionId": 12870
},
{
"packageName": "1.0.4",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.4",
"projectVersionId": 12854
},
{
"packageName": "1.0.3",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.3",
"projectVersionId": 12838
},
{
"packageName": "1.0.2",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.2",
"projectVersionId": 12820
},
{
"packageName": "1.0.1",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.1",
"projectVersionId": 12801
}
]
When we run a request at the following URL:
http://host:port/flexdeploy/rest/v1/project/10002/version
A GET request would be triggered and return the following JSON project versions object
GET JSON Response
[
{
"packageName": "1.0.12",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.12",
"projectVersionId": 13117
},
{
"packageName": "1.0.11",
"isActive": false,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.11",
"projectVersionId": 13101
},
{
"packageName": "1.0.10",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.10",
"projectVersionId": 12954
},
{
"packageName": "1.0.9",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.9",
"projectVersionId": 12938
},
{
"packageName": "1.0.8",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.8",
"projectVersionId": 12922
},
{
"packageName": "1.0.7",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.7",
"projectVersionId": 12906
},
{
"packageName": "1.0.6",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.6",
"projectVersionId": 12890
},
{
"packageName": "1.0.5",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.5",
"projectVersionId": 12870
},
{
"packageName": "1.0.4",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.4",
"projectVersionId": 12854
},
{
"packageName": "1.0.3",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.3",
"projectVersionId": 12838
},
{
"packageName": "1.0.2",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.2",
"projectVersionId": 12820
},
{
"packageName": "1.0.1",
"isActive": true,
"requestAllFiles": false,
"scmRevision": null,
"projectStreamId": 12702,
"projectVersionName": "1.0.1",
"projectVersionId": 12801
}
]