Page Comparison

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

title	API URLs

http://host:port/flexdeploy/rest/v1/project/(Id)/build

...

Full Project Build JSON

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.Id of the release to which this build is related to.

boolean equivalent to Force Build checkbox in the UI. Defaults to false.

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.

{

"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"

},
{

   "code":"input2","value": "123"

}],

"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 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

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

Use true, if all files type build is requested

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	.
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: `path` and `scmRevision`.
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

Returns just String for workflow request id that was submitted.

Attributes	Type	Description	workflowRequestId	String
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

Response Codes

HTTP Code	Description
200	No changes were detected, no build initiated.
201	Project was built 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

title	API URLs

http://host:port/flexdeploy/rest/v1/project/10004/build

Sample JSON Request

Code Block

theme	Eclipse

{
    "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:an array of workflowRequests

Code Block

theme	Eclipse

{
    "warningMessage": null,
    "warningCode": null,
    "workflowRequests": [
        {
            "packageName": null,
            "folderName": "Human Resources",
            "releaseSnapshotId": null,
            "workflowRequestStatus": "READY",
            "folderId": 10001,
            "exceptionToWindow": false,
            "releaseDefinitionId": null,
            "cmsissues": "",
            "workflowRequestId": 12019,
            "projectName": "ProcessHRRequest",
            "projectStreamId": 10502,
            "projectVersionName": "1.0.9",
            "requestAllFiles": false,
            "projectVersionId": 30001,
            "environmentId": 11016,
            "folderRequestId": null,
            "flexFields": [],
            "folderPath": "FlexDeploy/Human Resources",
            "projectId": 10501,
            "requestedBy": "fdadmin",
            "requestedStartTime": null,
            "force": false,
            "stopOnPackageError": null,
            "workflowOverrideVersion": null,
            "folderVersionId": null
        }
    ]
}

Versions Compared

Old Version 1

New Version Current

Key

Request

Partial Project Build JSON Request

Request

Input

FlexField

ProjectFile

Response

Response Codes

Example