This POST service will perform the same action found on the Build Request Form. It will initiate a request to build the project with the given Id. 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 Partial deploy project builds.
Full Project Build JSON Request | |
|---|---|
Required parameters for full deployment. If building a partial deployment project, see the Partial deployment example instead. | |
| Build in the environment with Id 11001. Build from stream with Id 12345. |
Optionally, include any of this information. Verify that your json is valid; check for trailing commas if you don't include this section. | |
"code":"input1","value": "xyz"
"code":"input2","value": "123"
"code":"REQ", "value":"1500"
| Version of the workflow to run. Defaults to the currently active version. boolean equivalent to Force Build checkbox in the UI. Defaults to false. Id of the release to which this build is related to. If specified, a new snapshot is going to be created. List of Issue Tracking Tickets. List of workflow Input Codes to set An input named "input1" is being set to "xyz" An input named "input2" is being set to "123" List of FlexField Codes to set A build-scoped FlexField named "REQ" is being set to "1500" |
| } | Closing bracket |
Partial Project Build JSON Request | |
|---|---|
Required parameters for partial deployment. If building a full deployment project, see the full deployment example instead. | |
"path": "/java/xxt/oracle/xxPersonMainCO.java"
"path": "/java/xxt/oracle/apps/managePersonCO.java", "scmRevision": "1515"
| Build in the environment with Id 11101. Build from stream with Id 12345. 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. | |
"code":"input1","value": "xyz"
"code":"input2","value": "123"
"code":"REQ", "value":"1500"
| Version of the workflow to run. Defaults to the currently active version. boolean equivalent to "Force Build" checkbox in the UI. Defaults to false. Id of the release to which this build is related to. If specified, a new snapshot is going to be created. List of Issue Tracking Tickets. List of workflow Input Codes to set An input named "input1" is being set to "xyz" An input named "input2" is being set to "123" Package name to be used for partial deployment project build. List of FlexField Codes to set A build scoped FlexField named "REQ" is being set to "1500" |
| } | Closing bracket |
Build All for Partial Deploy Project
If trying to build a Partial Deploy project with all of the files in the repository (equivalent to Build All button in the UI), then simply remove the "projectFiles" list, and the REST API will detect that the project is meant for partial deploys automatically and perform the build with all of the files.
Request
Parameter | Required | Type | Description |
|---|---|---|---|
| environmentId | Y | Long | This is the environment Id, not the environment name that you see on most screens. |
| streamId | Y | Long | The Id of the Stream. |
| forceBuild | N | Boolean | Values are true or false. Indicates that the build should occur even if there are not SCM changes. Defaults to false. |
| allFiles | N | Boolean | Use true, if all files type build is requested. |
| relatedTickets | N | String | List of Issue Tracking System tickets. |
| workflowVersionOverride | N | String | Optionally the version of the workflow can be overridden. |
| inputs | N | List<Input> | See Common Parameters below. |
| flexFields | N | List<FlexField> | See Common Parameters below. |
| projectFiles | N | List<ProjectFile> | Required for partial deployment builds. An array of objects with 2 fields each: |
| packageName | N | String | Unique name to identify a build for partial deployments project. Defaults to the project version if no value is provided. If package name is provided without project files, files configured in that project will be used. If package name is provided with project files, then input is used for build and package definition is updated with this projectFiles list. |
| releaseId | N | String | Id of the release to which this build is related to. If specified, a new snapshot is going to be created. |
Input
This is a list of code/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 supplied.
Attribute | Required | Type | Description |
|---|---|---|---|
| code | Y | String | The code of the Input |
| value | N | String | The value of the Input |
FlexField
This is a list of the code/value pairs for the FlexFields (not the Display Name). Not all FlexFields need to be supplied. If a FlexField has a default value or options that are acceptable for the workflow to run, it does not need to be changed.
Attribute | Required | Type | Description |
|---|---|---|---|
| code | Y | String | The code of the FlexField |
| value | N | String | The value of the FlexField |
ProjectFile
Attribute | Required | Type | Description |
|---|---|---|---|
| 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. |
Response
Attributes | Type | Description |
|---|---|---|
workflowRequestId | String | Returns just String for workflow request id that was submitted. |
Response Codes
HTTP Code | Description |
|---|---|
| 201 | Project was built successfully |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Project not found |
| 500 | Unexpected internal server error |
Example
We can build a Project with Id 10004 with this request:
API URLs
http://host:port/flexdeploy/rest/v1/project/10004/build
Sample JSON Request
{
"environmentId": 11101 ,
"forceBuild": true,
"allFiles": true,
"workflowVersionOverride": null,
"streamId": 11210,
"inputs": [
{
"code":"input1","value": "xyz"
},
{
"code":"input2","value": "123"
}],
"projectFiles":[
{
"path": "/java/xxt/oracle/xxPersonMainCO.java"
},
{
"path": "/java/xxt/oracle/apps/managePersonCO.java",
"scmRevision": "1515"
}],
"packageName": "ALM150",
"relatedTickets": null,
"flexFields": [{
"code": "Build FlexField" ,
"value": 10
}],
"releaseId": 27003
}
In response, we will receive the workflowRequestId:
10001