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 workflow request. Workflow request id from return data can be used by the getWorkflowRequestStatus call with Workflow Request API to determine when the workflow execution is complete.
This page includes examples for Full and Partial deploy project builds.
| Info | ||
|---|---|---|
| ||
|
Request
Required parameters for full deployment.
If building a partial deployment project, see the Partial deployment example instead.
{
"environmentId":11001,
"streamId": 12345,
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.
"workflowVersionOverride":"1.8",
"forceBuild": false,
"releaseId": 14001,
"relatedTickets":["DEMO-1","DEMO-2"],
"inputs": [{
"code":"input1","value": "xyz"},{
"code":"input2","value": "123"}],
"flexFields":[
{
"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"
Partial Project Build JSON Request
Required parameters for partial deployment.
If building a full deployment project, see the full deployment example instead.
{
"environmentId":11101,
"streamId": 12345,
"projectFiles":[
{
"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.
"workflowVersionOverride":"1.8",
"forceBuild": false,
"releaseId": 14001,
"relatedTickets":["DEMO-1","DEMO-2"],
"inputs": [{
"code":"input1","value": "xyz"},{
}],
"packageName": "ALM150",
"flexFields":[
{
"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
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"
Build All for Partial Deploy Project
...
- trying to build a Partial Deploy project with all of the files in the repository (equivalent to Build - All Files 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/N | Long | This is the environment Id, not the environment name that you see on most screens. It is required if the build instance is associated to multiple environments. If only one environment is associated to the build instance, it is not required. | ||||
| streamId | Y/N | Long | The Id of the Stream that you want to build. If only one stream is present, you don't need to specify 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. Defaults to the currently active version. | ||||
| inputs | N | List<Input> | See Common Parameters below. | ||||
| flexFields | N | List<FlexField> | See Common Parameters below. | ||||
| projectFilespackageName | Y/N | List<ProjectFile>String | Required for partial deployment project 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 listThe name of the package to build. The package must already exist. |
| 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 |
Attributes | Type | Description |
|---|
path that is required inside the projectFiles parameter.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|
| allFilesRequested | boolean | If it was a partial deploy project and the "(All Files)" Package was selected True otherwise False |
| createdBy | String | the name of the user that created the build request |
| createdOn | Date Time | The time the request was received |
| deploymentStrategy | String or null | |
| environmentId | long | The environment on which the build is being performed |
| finishDeployment | any | |
| flexField1 | any | |
| flexField2 | any | |
| flexField3 | any | |
| flexField4 | any | |
| flexField5 | any | |
| flexField6 | any | |
| flexField7 | any | |
| flexField8 | any | |
| flexField9 | any | |
| flexField10 | any | |
| folderId | long | the closest parent folder to the project |
| force | boolean | indicates if force deploy or force build was selected on the request |
| groupRequestId | long or null | |
| inputs | array | |
| instances | array | |
| isException | boolean | |
| newWeight | any | |
| oldWeight | any | |
| pipelineStageExecId | long or null | long if it was a release build, otherwise null |
| pipelineStageStepExecId | long or null | long if it was a release build, otherwise null |
| predeployRequestedStartTime | any | |
| predeployWorkflowExecId | long or null | long if there was a predeploy workflow that executed, otherwise null |
| priority | long | |
| projectId | long | The ID of the project |
| projectStreamId | long | The ID of the project Stream |
| projectVersionId | long | The ID of the Project Version |
| projectWorkflowId | long | The ID of the ProjectWorkflow |
| relDefinitionId | long or null | long if it was a release build, otherwise null |
| relSnapshotId | long or null | long if it was a release build, otherwise null |
| requestedStartTime | any | null unless a delayed start time was given |
| requestStatus | ENUM | READY, |
| routeRule | any | |
| stopOnPkgError | boolean | |
| triggerType | ENUM | MANUAL |
| updatedBy | string | |
| updatedOn | date time with zone | |
| versionNumber | long | |
| workflowId | long | The ID of the Workflow |
| workflowRequestId | long | The ID of the WorkflowRequest |
| workflowType | ENUM | BUILD, DEPLOY, PREDEPLOY, TEST, OTHER, TEST_DEFINITION, UTILITY |
| workflowVersionOverride | any | null unless a workflow version override was specified for this request. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | No changes were detected, no build initiated. |
| 201 | Project build was built initiated successfully |
| 400 | Bad request |
| 401Unauthorized | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project not found |
| 500 | Unexpected internal server error |
Example
We can build a Project with Id 10004 with this request:
| Info | ||
|---|---|---|
| ||
|
Sample JSON Request
| Code Block | ||
|---|---|---|
| ||
{
"environmentId": 11101 11595,
"forceBuild": true false,
"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:
...
"streamId": 3502
} |
In response, we will receive a data object with information about the request.
| Code Block | ||
|---|---|---|
| ||
{
"createdBy": "fdadmin",
"updatedOn": "2022-04-26T20:23:08.579+0000",
"createdOn": "2022-04-26T20:23:08.501+0000",
"updatedBy": "fdadmin",
"versionNumber": 2,
"projectWorkflowId": 4103,
"relDefinitionId": null,
"folderVersionId": null,
"workflowVersionOverride": null,
"requestStatus": "READY",
"requestedStartTime": null,
"isException": false,
"flexField1": null,
"flexField2": null,
"flexField3": null,
"flexField4": null,
"flexField5": null,
"flexField6": null,
"flexField7": null,
"flexField8": null,
"flexField9": null,
"flexField10": null,
"groupRequestId": null,
"stopOnPkgError": false,
"pipelineStageStepExecId": null,
"relSnapshotId": null,
"pipelineStageExecId": null,
"deploymentStrategy": null,
"newWeight": null,
"oldWeight": null,
"routeRule": null,
"finishDeployment": null,
"predeployWorkflowExecId": null,
"predeployRequestedStartTime": null,
"instances": null,
"folderId": 4743642,
"workflowRequestId": 275337,
"projectId": 3501,
"environmentId": 11595,
"workflowId": 4122,
"inputs": null,
"projectStreamId": 3502,
"force": false,
"projectVersionId": 16786148,
"workflowType": "BUILD",
"triggerType": "MANUAL",
"priority": 1
} |