AnchorTopTop

Projects Versions can be accessed through this API using the GET service.

...

title	Base URL for Project REST API

...

Projects Versions can be accessed through this API using the GET service.

Include Page

	REST V1 Authentication
	REST V1 Authentication

Table of Contents

maxLevel	2

GET

GET by ID

This GET service will find project version for supplied parameters and return a JSON representation of it.

Info

title	API URL

http://{host:port}/flexdeploy/rest/v1/project/{projectId}/version/{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

	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	Authentication failure
403	Authorization failure (no access to resource)
404	Project or Version not found
500	Unexpected internal server error

Example

If we had the following project versions in a Project with a project.

Code Block

theme	Eclipse
title	Version 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

theme	Eclipse
title	Version 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

title	API 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

...

Table of Contents

maxLevel	2

Each function returns a JSON object containing certain attributes for each version of the specified project. The Project Version JSON Object is an object that has these attributes,

Attributes

?projectVersionName=1.0

Request

Parameter	Required	Type	Description
projectId

projectVersionId

Yes

LongThe Identification number of this project version

URL	This is a URL path parameter for the id which is used to find a project.
projectVersionName	No	Query - String

The Name of this

Parameter

Required

Type

Description

projectIdYesURLThis is a URL path parameter for the id which is used to find a project.

Starts with search by project version name.

isActiveBoolean A boolean describing whether or not this project version is active.projectStreamIdLongThe ID of the project stream associated with this project version.packageNameStringThe package name associated with this project version.requestAllFilesBooleanA boolean describing whether or not all files are requested for this project version.scmRevisionStringA string representation of the SCM revision of this project version. Null if no such revision exists.

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.

Info

title	API URLs

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

Parameters

This is searched for using startsWith, so a partial version can be used for the search.
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

	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
401

Unauthorized

Authentication failure
403	Authorization 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

theme	Eclipse
title	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

Code Block

theme	Eclipse
title	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
   }
]

Versions Compared

Old Version 9

New Version Current

Key

GET

GET by ID

Request

Response Codes

HTTP Code

Description

Example

GET (Using Query Parameters)

Request

GET (By Project ID)

Parameters

Response Codes

HTTP Code

Description

Example

Page Comparison

Versions Compared

Old Version 9

New Version Current

Key

GET

GET by ID

Request

Response Codes

HTTP Code

Description

Example

GET (Using Query Parameters)

Request

GET (By Project ID)

Parameters

Response Codes

HTTP Code

Description

Example