Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Full Project BuildSample 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": false,

"releaseName": "Demo Release",

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

"inputs": [
{

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

},
{

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

}],

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

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 FlexField Codes to set

A build-scoped FlexField named "REQ" is being set to "1500"

}Closing bracket

...

Partial Project BuildSample 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 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": 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 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 FlexField Codes to set

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

}Closing bracket


Info
titleBuild 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.

...