This POST 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.
This page includes examples for Full and buildProject deploy project builds.
API URL
http://host:port/flexdeploy/rest/workflow/buildProject
Full Project BuildSample JSON Request | |
|---|---|
{ "authentication": { "userId":"fdadmin", "password": "password1" }, | Opening bracket Authentication section, used on all types of requests. |
Required parameters for full deployment. If building a partial deployment project, see the Partial deployment example instead. | |
"environmentCode":"DEV", "qualifiedProjectName":"/FlexDeploy/folder1/myApp/SimpleProj", "streamName": "trunk", | Build in the DEV environment. The full path of the FlexDeploy project to build. Build from stream trunk. |
Optionally, include any of this information. Verify that your json is valid; check for trailing commas if you don't include this section. | |
"workflowVersionOverride":"1.8", "forceBuild": true, "inputs": | Version of the workflow to run. Defaults to the currently active version. boolean equivalent to "Force Build" checkbox in the UI. Defaults to false. List of workflow inputs to set An input named "input1" is being set to "xyz" An input named "inp2" is being set to 123 |
| } | Closing bracket |
Partial Project BuildSample JSON Request | |
|---|---|
{ "authentication": { "userId":"fdadmin", "password": "password1" }, | Opening bracket Authentication section, used on all types of requests. |
Required parameters for partial deployment. If building a full deployment project, see the full deployment example instead. | |
"environmentCode":"DEV", "qualifiedProjectName":"/FlexDeploy/folder1/myApp/SimpleProj", "streamName": "trunk", "projectFiles": [ { "path": "/java/xxt/oracle/xxPersonMainCO.java" }, { "path": "/java/xxt/oracle/apps/managePersonCO.java", "scmRevision": "1515" } ] | Build in the DEV environment. The full path of the FlexDeploy project to build. Build from stream "trunk". List of project files to include in the build, and optionally their versions. Include the file with path "/java/xxt/oracle/xxPersonMainCO.java" Include SCM revision 1515 of file managePersonCO.java/ |
Optionally, include any of this information. Verify that your json is valid; check for trailing commas if you don't include this section. | |
"workflowVersionOverride":"1.8", "forceBuild": true, "inputs": | Version of the workflow to run. Defaults to the currently active version. boolean equivalent to "Force Build" checkbox in the UI. Defaults to false. List of workflow inputs to set An input named "input1" is being set to "xyz" An input named "inp2" is being set to 123 |
| } | Closing bracket |
Parameters
Parameter | Required | Type | Description |
|---|---|---|---|
| Y | Object |
|
| Y | String | This is the environment code, not the environment name that you see on most screens. |
| Y | String | The qualified project name starts with /FlexDeploy and includes any sub folder, then the application and finally the project. |
| Y | String | The name of the Stream. |
| N | Boolean | Values are true or false. Indicates that the build should occur even if there are not SCM changes. Defaults to false. |
| N | String | Optionally the version of the workflow can be overridden. |
| N | List | See Common Parameters below. |
projectFiles | N* | List | Required for partial deployment builds. A list of objects with 2 fields each: |
path | Y* | String | Fully qualified file path that is required inside the projectFiles parameter. |
scmRevision | N | Long | Optionally include the revision number that you would like to use for the build. If it is not indicated, then FlexDeploy will use the latest revision as the default. |