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.
...
Attributes | Type | Description |
|---|---|---|
| warningMessage | String | Indicates any warning message in the event where the request was successful but no build was initiated. For example: No changes found in source control |
| warningCode | String | Matching warning code for the warning message. |
workflowRequests | Array | Array of workflow request objects|
| allFilesRequested | boolean | Bug created to remove this - FLEXDEPLOY-4587 |
| createdBy | String | |
| createdOn | Date Time | |
| deploymentStrategy | String or null | |
| environmentId | long | |
| finishDeployment | any | |
| flexField1 | any | |
| flexField2 | any | |
| flexField3 | any | |
| flexField4 | any | |
| flexField5 | any | |
| flexField6 | any | |
| flexField7 | any | |
| flexField8 | any | |
| flexField9 | any | |
| flexField10 | any | |
| folderId | long | |
| folderRequestId | long or null | |
| folderVersionId | long or null | |
| forceDeploy | boolean | |
| 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 | |
| projectStreamId | long | |
| projectVersionId | long | |
| projectWorkflowId | long | |
| 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 | |
| workflowRequestId | long | |
| workflowType | ENUM | BUILD, |
| 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 |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project not found |
| 500 | Unexpected internal server error |
Example
...
In response, we will receive an array of workflowRequestsa data object with information about the request.
| Code Block | ||
|---|---|---|
| ||
{
"createdBy": "fdadmin",
"updatedOn": "2022-04-26T20:23:08.579+0000",
"warningMessagecreatedOn": null,
"warningCode": null,
"workflowRequests": [
{
"packageName"2022-04-26T20:23:08.501+0000",
"updatedBy": "fdadmin",
"versionNumber": 2,
"projectWorkflowId": 4103,
"relDefinitionId": null,
"folderName "folderVersionId": "Human Resources",
"releaseSnapshotIdnull,
"workflowVersionOverride": null,
"workflowRequestStatus "requestStatus": "READY",
"folderRequestId": "folderIdnull,
"requestedStartTime": 10001null,
"exceptionToWindow "isException": false,
"flexField1": null,
"flexField2": null,
"flexField3": null,
"flexField4": null,
"flexField5": null,
"flexField6": null,
"releaseDefinitionIdflexField7": null,
"cmsissues "flexField8": ""null,
"workflowRequestId "flexField9": 12019null,
"projectName "flexField10": "ProcessHRRequest"null,
"projectStreamId "groupRequestId": 10502null,
"projectVersionName "stopOnPkgError": "1.0.9",
"requestAllFilesfalse,
"allFilesRequested": false,
"projectVersionId "pipelineStageStepExecId": 30001null,
"environmentId "relSnapshotId": 11016null,
"folderRequestId "pipelineStageExecId": null,
"flexFields "deploymentStrategy": []null,
"folderPath "newWeight": "FlexDeploy/Human Resources",
"projectIdnull,
"oldWeight": 10501null,
"requestedBy "routeRule": "fdadmin"null,
"requestedStartTime "finishDeployment": null,
"force "predeployWorkflowExecId": falsenull,
"stopOnPackageError "predeployRequestedStartTime": null,
"workflowOverrideVersion "instances": null,
"folderId": 4743642,
"workflowRequestId": 275337,
"projectId": 3501,
"environmentId": 11595,
"workflowId": 4122,
"folderVersionIdinputs": null,
"projectStreamId": 3502,
"forceDeploy": false,
"projectVersionId": 16786148,
"workflowType": }
]"BUILD",
"triggerType": "MANUAL",
"priority": 1
} |