...
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 | 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. 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> | Required Only for partial deployment project builds. An array of objects with 2 fields each: |
| packageName | N | String | Only for partial deployment project builds. Unique name to identify a build for partial deployments project. Defaults to the project version if no value is provided. If package name packageName is provided without project filesprojectFiles, files configured in that project package will be used. If package name packageName is provided with project filesprojectFiles, 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. |
| 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
...
In response, we will receive the workflowRequestId, For example 10001..
| Code Block |
|---|
10001 |