Versions Compared

Key

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

...

Parameter

Required

Type

Description

authentication

Y

Object

See Common Parameters below.

environmentCode

Y

String

This is the environment code, not the environment name that you see on most screens.

qualifiedApplicationName

Y

String

The qualified application name starts with /FlexDeploy and includes any sub folders, and finally the project.

applicationVersion
NStringVersion of the application to be deployed. Defaults to the last successful build.

exceptionToWindow

N

Boolean

Values are true or false. Indicates that the deployment is an exception to the deployment window.

forceDeploy

N

Boolean

Values are true or false. Indicates that the deployment should occur even when the projectVersion is already deployed to that instance. Defaults to false.

startTime

N

DateTime

The time when the deployment will be started.

projectSettings

N

ListArray

The project settings is a list of the projects by name and includes the 2 sub-parameters below. If all values can be defaulted, the project setting for that project does not need to be included.

     projectName

N

String

The project to assign inputs into

     inputs

N

ListArray

See Common Parameters below.

flexFields

N

ListArray

See Common Parameters below.

changeTicketNStringTicket number for the given deployment, using the configured Change Management System.

Excerpt Include
Workflow Execution REST API (Version 0)
Workflow Execution REST API (Version 0)
nopaneltrue