Projects Versions can be accessed through this API using the GET service. @Since 5.0.0.4.
Include Page REST V1 Authentication REST V1 Authentication
Table of Contents | ||
---|---|---|
|
GET
GET
(By Projectby ID
)This GET service will find
project version for supplied parameters and return a JSON representation of it. Project versions are sorted from newest to oldest.
Info | ||
---|---|---|
| ||
http://{host:port}/flexdeploy/rest/v1/project/{projectId}/version |
Latest project versions are returned first in response.
/{versionid} |
Request
Parameter | Required | Type | Description |
---|---|---|---|
projectId | Yes | URL | This is a URL path parameter for the id which is used to find a project. |
versionid | Yes | URL | This is a URL path parameter for project version id. |
Include Page | ||||
---|---|---|---|---|
|
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:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"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
}
]
|
GET (Using Query Parameters)
This GET service will find project version for supplied parameters and return a JSON representation of it. Project versions are sorted from newest to oldest.
Info | ||
---|---|---|
| ||
http://{host:port}/flexdeploy/rest/v1/project/{projectId}/version? Query Parameters
For example, http://{host:port}/flexdeploy/rest/v1/project/{projectId}/version?projectVersionName=1.0 |
Request
Parameter | Required | Type | Description |
---|---|---|---|
projectId | Yes | URL | This is a URL path parameter for the id which is used to find a project. |
projectVersionName | No | Query - String | Starts with search by project version name. |
projectStreamId | No | Query - Long | Equals search by project stream id. |
packageName | No | Query - String | Equals search by package name. Only for partial deployment projects. |
requestAllFiles | No | Query - Boolean | Equals search by whether all files are requested or not. Only for partial deployment projects. |
scmRevision | No | Query - String | Equals search by SCM revision. |
limit | No | Query - Integer | Limit results to specific count, if not provided all matching results are returned. |
Include Page | ||||
---|---|---|---|---|
|
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:
Code Block | ||||
---|---|---|---|---|
| ||||
[ { "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
Code Block | ||||
---|---|---|---|---|
| ||||
[ { "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 } ] |
...