Versions Compared

Key

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

This POST service will promote existing project version to create new snapshot. This API was introduced with FlexDeploy 4.6.0.5.

...

Promote to Release JSON Request


{

"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",

"qualifiedProjectName": "FlexDeploy/Demo/Project1",

"projectVersion": "1.0.10",

Promote project version to release named Demo Release

Version belongs to project "FlexDeploy/Demo/Project1".

Exact project version name

Optionally, include any of this information.

Verify that your JSON is valid; check for trailing commas if you don't include this section.

"packageName": "ALM150"The package name associated with project version. Only applies for partial deploy 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 completeto promote version.

qualifiedProjectName

Y

String

The name of the gate to update the status onFully qualified project name.

packageName

N

StringThe

name of the executing snapshot that is waiting on the gate. If not provided, latest Stage Execution will be usedPackage name, only applies when using partial deployment and package based builds.

projectVersion

Y

StringThe updated status to apply to the gate. Options are [APPROVED, REJECTED]

Project version.

Example Request

Code Block
languagejs
themeRDark
{
   "authentication": 
    {
       "userId": "fdadmin",
       "password": "welcome1"
    },
   "releaseName": "Demo Release",
   "qualifiedProjectName": "FlexDeploy/Demo/Project1",
   "projectVersion": "1.0.10"
}

...