Versions Compared

Version Old Version 20 New Version 21
Changes made by

Karl Henselin

Karl Henselin

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 Deployment Request Form off the project screen. It will initiate a request to deploy the project selected in the qualifiedProjectName. The service will return the workflowRequestId which can be used by the getWorkflowRequestStatus call to determine when the workflow is complete.

...

Info

Notice that the packageDetails parameter is included to indicate to FlexDeploy that this request is for a Partial Deploy.

Parameters

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

Parameter

Required

Type

Description

authentication

Y

String

See Common Parameters below.

environmentCode

Y

String

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

instanceCodes

Y

String

See Common Parameters below.

qualifiedProjectName

Y

String

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

forceDeploy

Y

Boolean

.

packageDetailsN*String

This is required for partial deploy, but not for full deployments.

Included to indicate what should be deployed in a partial deploy.

Full packageName from build is required for this parameter to be used. The deployment priority is optional; if it is not indicated, then FlexDeploy will deploy the packages in the order they are provided in the JSON request.

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.

exceptionToWindow

N

Boolean

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

projectVersion

N

String

The projectVersion to be deployed. If not specified, the most recently built projectVersion will be deployed.

This parameter is ignored for partial deployments. See packageDetails for partial deployments.

startTime

N

DateTime

The time when the deployment will be started.

workflowVersionOverride

N

String

Optionally, the version of the workflow can be overridden.

inputs

N

List

See Common Parameters below.

flexFields

N

List

See Common Parameters below.

...