Versions Compared

Old Version 2

changes.mady.by.user Ben Hoffman

Saved on

compared with

New Version 3

changes.mady.by.user Ben Hoffman

Saved on

Key

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

This POST service will perform the same action found on the Release Screen.  This service can be used to add projects to a release in FlexDeploy.

Info
titleAPI URL
http://host:port/flexdeploy/rest/release/addProjectsToRelease

...

Add Projects to Release Sample JSON Request
Anchor
Full
Full


{

"authentication": { "userId":"fdadmin", "password":"password1" },

Opening bracket

Authentication section, used on all types of requests.

Required parameters for creating or editing a release.

"releaseName": "Demo Release",

"releaseProjectDetails":

[{

"qualifiedProjectName": "FlexDeploy/MyFolder/MyApp/MyProject",

"priority": 1,

"streamName": "trunk",

"groupName": "Group1"

},

{

"qualifiedProjectName": "FlexDeploy/MyFolder/MyApp/MyPartialDeployProject",

"priority": 2,

"streamName": "branch1",

"groupName": "Group2",

"requestAllFiles": true

}]

Add projects to the release named Demo Release.

A list of Projects and releaseProjectDetails to add to the release.


Add the Project located at "FlexDeploy/MyFolder/MyApp/MyProject" to the release.

Set the Priority of this project to 1.

Build this project in the trunk Stream.

Put this project in "Group1" on the release.



Add the Project located at "FlexDeploy/MyFolder/MyApp/MyPartialDeployProject" to the release.

Set the Priority of this project to 2.

Build this project in the "branch1" Stream.

Put this project in "Group2" on the release.

Optionally Request All Files when performing a build of a Partial Build project.

}Closing bracket

  

Parameters

Parameter

Required

Type

Description

authentication

Y

Object

The login information for the user connecting to FlexDeploy.

releaseName

Y

String

The name of the release containing the gate we want to complete.

releaseProjectDetails

Y

List

A list of projects and configurations to add to the release.

qualifiedProjectName

Y

String

The full path and name of a project to add to the release.

priority

N

String

The project's deployment priority in the release.

streamName

Y

String

The stream to build this project from.

groupName

N

String

The name of the group on the release to add this project to.

requestAllFilesNBooleanRequest All Files when building a Partial Build project

...