Versions Compared

Key

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

...

GET

GET by 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
titleAPI URL

http://{host:port}/flexdeploy/rest/v1/project/{projectId}/version/{versionid}


Request

Parameter
Required
Type
Description
projectIdYesURLThis is a URL path parameter for the id which is used to find a project.
versionidYesURLThis is a URL path parameter for project version id.

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 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.

Code Block
themeEclipse
titleVersion 4281839
[
    {
        packageName: "ALM151",
        isActive: false,
        projectVersionId: 4281839,
        projectStreamId: 3882239,
        projectVersionName: "1.0.45",
        scmRevision: "1710",
        requestAllFiles: false
    },
    {
        packageName: "ALM151",
        isActive: true,
        projectVersionId: 4281805,
        projectStreamId: 3882239,
        projectVersionName: "1.0.44",
        scmRevision: "1709",
        requestAllFiles: false
    },
    {
        packageName: "ALM151",
        isActive: true,
        projectVersionId: 4281769,
        projectStreamId: 3882239,
        projectVersionName: "1.0.43",
        scmRevision: "1709",
        requestAllFiles: false
    }
]

Get by id for 4281839 will return following.

Code Block
themeEclipse
titleVersion 4281839
{
    packageName: "ALM151",
    isActive: false,
    projectVersionId: 4281839,
    projectStreamId: 3882239,
    projectVersionName: "1.0.45",
    scmRevision: "1710",
    requestAllFiles: false
}


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
titleAPI URL

http://{host:port}/flexdeploy/rest/v1/project/{projectId}/version?

Query Parameters

  • projectVersionName
  • projectStreamId
  • packageName
  • requestAllFiles
  • scmRevision
  • limit

For example,

http://{host:port}/flexdeploy/rest/v1/project/{projectId}/version?projectVersionName=1.0


...