Versions Compared

Key

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

...

ParameterRequiredTypeDescription
environmentIdYLongThis is the environment id, not the environment name that is seen on most screens.
instanceIdinstanceIdsYArray of LongThe list of instances where the deployment will occur. Make sure to enter the instance id, not the instance name that is seen on most screens.
projectIdYLongThe Id of the project to deploy.
packageDetailsN*List<PackageInfo>Array of PackageInfo

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

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

See more info on PackageInfo below.

forceDeployNBooleanValues are true or false. Indicates that the deployment should occur even when the projectVersionId is already deployed to that instance. Defaults to false.
exceptionToWindowNBooleanValues are true or false. Indicates that the deployment is an exception to the deployment window. Defaults to false.
projectVersionIdNLongThe id of the project version to be deployed. If not specified, the most recently built projectVersionId will be deployed.
startTimeNDateTimeStringThe time when the deployment will be started.
workflowVersionOverrideNStringOptionally, the version of the workflow can be overridden.
inputs NArraySee Common Parameters below.
flexFieldsNArraySee Common Parameters below.
changeNumberN*StringTicket number for the given deployment, using the configured Change Management System.

...