Overview
This service will perform the same action found on the "Build Request Form". It will initiate a request to build 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.
URL
http://host:port/flexdeploy/rest/workflow/buildProject
Sample JSON Request
{
"authentication":
{
"userId": "fdadmin",
"password": "password1"
},
"environmentCode": "DEV",
"forceBuild": "true",
"qualifiedProjectName": "/FlexDeploy/TestApp/MyProj",
"streamName": "trunk",
"workflowVersionOverride": "1.02",
"inputs": [
{
"name": "input1",
"value": "asd"
},
{
"name": "input2",
"value": "zxc"
}]
}
Parameters
Parameter | Is Required | Type | Description |
---|---|---|---|
Authentication | Y |
| See Common Parameters |
environmentCode | Y | String | This is the environment code, not the environment name that you see on most screens. |
forceBuild |
| Boolean | Values are true or false. Indicates that the build should occur even if there are not SCM changes |
qualifiedProjectName | Y | String | The qualified project name starts with /FlexDeploy and includes any sub folder, then the application and finally the project. |
streamName | Y | String | The name of the Stream. |
WorkflowVersionOverride |
| String | Optionally the version of the workflow can be overridden. |
inputs |
|
| See Common Parameters |