- style
buildProject
- Kari Draheim (Unlicensed)
- Chandresh Patel
- Erick Jones
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.
API URL
http://host:port/flexdeploy/rest/workflow/buildProject
{
"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 | 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 |
Authentication
The authentication parameter is comprised of 2 fields.
- userId – a valid user id for FlexDeploy
- password – the associated password
Inputs
This is a list of name/value pairs for the inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the workflow to run, it does not need to be changed.
Flex Fields
Applicable only for deployProject and deployApplication. This is a list of name (Display Name of FlexField)/value pairs for the FlexFields. Not all FlexFields need to be supplied. If a flex field has a default value or options that are acceptable for the workflow to run, it does not need to be changed.
InstanceCodes
The list of instances where the deployment will occur.
Related content
- style