Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Request

Parameter
Required
Type
Description
projectIdYesURLThis is a URL path parameter for the id which is used to find a project.
projectVersionNameNoQuery - String

Starts with search by project version name.

This is searched for using startsWith, so a partial version can be used for the search.

projectStreamIdNoQuery - LongEquals search by project stream id.
packageNameNoQuery - StringEquals search by package name. Only for partial deployment projects.
requestAllFilesNoQuery - BooleanEquals search by whether all files are requested or not. Only for partial deployment projects.
scmRevisionNoQuery - StringEquals search by SCM revision.
limitNoQuery - IntegerLimit results to specific count, if not provided all matching results are returned.

Include Page
REST V1 Project Version Response
REST V1 Project Version Response

Response Codes

HTTP Code

Description

200

Project was found and it's versions Search successful and results returned

400

Bad request

401Authentication failure
403Authorization failure (no access to resource)

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
themeEclipse
titleVersions 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

Code Block
themeEclipse
titleGET 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
   }
]