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 workflow request. Workflow request id from return data can be used with Workflow Request API to determine when the execution is complete.
This page includes examples for Full and Partial deploy project builds.
...
Request
- If 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.
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. | ||||
| 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. | projectFiles | N | List<ProjectFile> | Only for partial deployment project builds. An array of objects with 2 fields each:path and scmRevision. |
| packageName | Y/N | String | Only Required for partial deployment project builds.Unique The name of the package to identify a build for partial deployments project. Defaults to the project version if no value is provided. If packageName is provided without projectFiles, files configured in that package will be used. If packageName is provided with projectFiles, then input is used for build and package definition is updated with this projectFiles list. If packageName and projectFiles are not provided for partial deployment project, then All Files build will be performed. . 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 |
|---|
| allFilesRequested |
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 | |
|---|---|---|---|
| createdBy | String | 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 | folderVersionId | long or nullthe 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. |
...