Versions Compared

Key

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

This POST service will remove projects and/or packages from a release in FlexDeploy.  This API returns the release id, which is a required input for some of the other APIs.

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

...

Note

The authenticated user must be a member of a group which has FlexDeploy Administrator privileges.


Remove Projects from 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" },

{ "qualifiedProjectName": "FlexDeploy/MyFolder/MyApp/MyPartialDeployProject" }

]

Add projects to the release named Demo Release.

A list of Projects to remove from the release.


Remove the Project located at "FlexDeploy/MyFolder/MyApp/MyProject" from the release.

Remove the Project located at "FlexDeploy/MyFolder/MyApp/MyPartialDeployProject" from the release.

}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

Array

An array of projects to remove from the release.

qualifiedProjectName

Y

String

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

...