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 specified with the project Id. The service will return the workflowRequestId which can be used by the getWorkflowRequestStatus call to determine the workflow is complete.
API URL
http://host:port/flexdeploy/rest/v1/project/{Id}/deploy
Request
| Parameter | Required | Type | Description |
|---|---|---|---|
| environmentId | Y | Long | This is the environment id, not the environment name that is seen on most screens. |
| instanceId | Long | The 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. | |
| projectId | Long | The Id of the project to deploy. | |
| Parameter | Required | Type | Description |
|---|---|---|---|
| environmentId | Y | Long | This is the environment id, not the environment name that is seen on most screens. |
| instanceId | Y | Long | The 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. |
| projectId | Y | Long | The Id of the project to deploy. |
| packageDetails | N* | List<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. |
| forceDeploy | N | Boolean | Values are true or false. Indicates that the deployment should occur even when the projectVersionId 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. |
| projectVersionId | N | Long | The id of the project version to be deployed. If not specified, the most recently built projectVersionId will be deployed. |
| 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 | Array | See Common Parameters below. |
| flexFields | N | Array | See Common Parameters below. |
| changeNumber | N* | String | Ticket number for the given deployment, using the configured Change Management System. |