Versions Compared

Key

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

...

Parameter

Required

Type

Description

authentication

Y

Object

The login information for the user connecting to FlexDeploy.

releaseName

Y

String

The name of the release being created or updated.

status

Y

String

An updated status for the release. Can be [NOTSTARTED, STARTED, SUSPENDED, COMPLETED, ABORTED]

description

N

String

A description to give to the release.

primaryManager

N

String

The username of the FlexDeploy user to assign as the Primary Manager for this release.

secondaryManager

N

String

The username of the FlexDeploy user to assign as the Secondary Manager for this release.

pipelineName

N

String

The name of a pipeline to associate to this release.

releaseProjectDetailsNArrayAn array of projects to be associated to the release.
  qualifiedProjectNameY*StringThe full path within FlexDeploy to a project.
  priorityNIntegerThe deploy priority for this project.
  streamNameNStringThe SCM stream to use when building this project. Defaults to the main stream.
  groupNameNString

A group on the release to put the project in.

  requestAllFilesNBooleanShould the project use all files? If true, don't specify packageName. If false, specify packageName.
  packageNameNStringThe name of the package to be built and deployed. Required if not using all files.
releaseCMSDetailsNArrayAn array of CMS properties to be configured on the release.
  instanceCodeY*StringThe instance code of a valid CMS instance
  overrideDefaultSettingsNBooleanOverride the CMS instance's configuration.
  overriddenDefaultConfigurationsY*Object

An object containing the "Default" properties for CMS on the release.

    requireChangeTicketForDeploymentY*BooleanSet this to true to require a change ticket for all deployments.
  overriddenEnvironmentConfigurationsNList

A list of environments and properties to override on this release.

    environmentCodeY*String

The environment code of a valid instance being used in this release.

    requireChangeTicketForDeploymentY*BooleanSet this to true to require a change ticket for deployments to this environment.

...