This POST service will perform the same action found on the Build Request Form. It will initiate a request to build the project selected in the qualifiedProjectName. The service will return the workflowRequestId which can be used by the getWorkflowRequestStatus (version 0) call to determine when the workflow is complete.

This page includes examples for Full and buildProject 1531315662 deploy project builds.

Info

title	API URL

http://host:port/flexdeploy/rest/workflow/buildProject

Full Project

BuildSample

Build JSON Request
Anchor
Full
Full

{

"authentication": { "userId":"fdadmin", "password":"password1" },

Opening bracket

Authentication section, used on all types of requests.

Required parameters for full deployment.

If building a partial deployment project, see the Partial deployment example instead.

"environmentCode":"DEV",

"qualifiedProjectName":"/FlexDeploy/folder1/myApp/SimpleProj",

"streamName": "trunk",

Build in the DEV environment.

The full path of the FlexDeploy project to build.

Build from stream trunk.

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": true": false,

"releaseName": "Demo Release",

"relatedTickets":["DEMO-1","DEMO-2"],

"inputs": [
{

   "code":"input1","value": "xyz"

},
{

   "code":"inp2input2","value": "123"

}],

"flexFields":[

{

   "code":"buildffREQ", "value":"abcd1500"

}]

Version of the workflow to run. Defaults to the currently active version.

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

Name 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 "inp2input2" is being set to "123"

List of FlexFields FlexField Codes to set

A build-scoped FlexField named "buildffREQ" is being set to "abcd1500"

} Closing bracket

Partial Project

BuildSample

Build JSON Request
Anchor
Partial
Partial

{

"authentication": { "userId":"fdadmin", "password":"password1" },

Opening bracket

Authentication section, used on all types of requests.

Required parameters for partial deployment.

If building a full deployment project, see the full deployment example instead.

"environmentCode":"DEV",

"qualifiedProjectName":"/FlexDeploy/folder1/myApp/SimpleProj",

"streamName": "trunk",

"projectFiles":[

{

   "path": "/java/xxt/oracle/xxPersonMainCO.java"

},

{

   "path": "/java/xxt/oracle/apps/managePersonCO.java",

   "scmRevision": "1515"

}]

Build in the DEV environment.

The full path of the FlexDeploy project project to build.

Build from stream "trunk".

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": true": false,

"releaseName": "Demo Release",

"relatedTickets":["DEMO-1","DEMO-2"],

"inputs": [
{

   "code":"input1","value": "xyz"

},
{

   "code":"inp2input2","value": "123"

}],

"packageName": "ALM150",

"flexFields":[

{

   "code":"buildffREQ", "value":"abcd1500"

}]

Version of the workflow to run. Defaults to the currently active version.

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

Name 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 "inp2input2" 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 "buildffREQ" is being set to "abcd1500"

} Closing bracket

Info

title	Build All for Partial Deploy Project

If trying to build a Partial Deploy project with all of the files in the repository (equivalent to Build All 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.

Parameters

Parameter	Required	Type	Description
authentication	Y	Object	See Common Parameters below.
environmentCode	Y	String	This is the environment code, not the environment name that you see on most screens.
qualifiedProjectName	Y	String	The qualified project name starts with /FlexDeploy and includes any sub folder, then the application and finally the project.
streamName	Y	String	The name 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.
relatedTickets	N	String	List of Issue Tracking System tickets.
workflowVersionOverride	N	String	Optionally the version of the workflow can be overridden.
inputs	N

List

Array	See Common Parameters below.
flexFields	N	String	See Common Parameters below.
projectFiles	N

*

¹

List

Array

Required for partial deployment builds.

A list

An array of objects with 2 fields each: path and scmRevision.

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.

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 list.

releaseName

N

String

Name of the release to which this build is related to. If specified, a new snapshot is going to be created.

projectFiles is required only for partial deployment projects.
path is only required when using projectFiles.

Examples

Code Block

language	js
theme	Eclipse
title	Partial project build request with package name and files

{
    "authentication": { "userId":"fdadmin", "password":"welcome1" },
    "environmentCode":"DEV",
    "qualifiedProjectName":"/FlexDeploy/EBS/XXHR",
    "streamName": "trunk",
    "packageName" : "ALM200",
    "projectFiles":[
    {
       "path": "/java/xxt/oracle/apps/ak/xxperson/schema/server/xxPersonDetailsEO.xml"
    },
    {
       "path": "/java/xxt/oracle/apps/ak/xxperson/schema/server/xxPersonDetailsEOImpl.java"
    }]
}

Code Block

language	js
theme	Eclipse
title	Partial project build request with package name without files

{
    "authentication": { "userId":"fdadmin", "password":"welcome1" },
    "environmentCode":"DEV",
    "qualifiedProjectName":"/FlexDeploy/EBS/XXHR",
    "streamName": "trunk",
    "packageName" : "ALM200",
}

Code Block

language	js
theme	Eclipse
title	Regular project build request

{
    "authentication": { "userId":"fdadmin", "password":"welcome1" },
    "environmentCode":"DEV",
    "qualifiedProjectName":"/FlexDeploy/HR/HRJavaApp",
    "streamName": "trunk"
}

Insert excerpt

	Workflow Execution REST API (version 0)
	Workflow Execution REST API (version 0)
nopanel	true

Versions Compared

Old Version 28

New Version Current

Key

Full Project

Build JSON Request
Anchor
Full
Full

Partial Project

Build JSON Request
Anchor
Partial
Partial

Parameters

Examples

Page Comparison

Versions Compared

Old Version 28

New Version Current

Key

Full Project

Build JSON Request AnchorFullFull

Partial Project

Build JSON Request AnchorPartialPartial

Parameters

Examples

Build JSON Request
Anchor
Full
Full

Build JSON Request
Anchor
Partial
Partial