Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

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 call to determine when the workflow is complete.

API URL

http://host:port/flexdeploy/rest/workflow/buildProject
Sample JSON Request
{
   "authentication":
    {
       "userId": "fdadmin",
       "password": "password1"
    },
   "environmentCode": "DEV",
   "forceBuild": "true",
   "qualifiedProjectName": "FlexDeploy/TestApp/MyProj",
   "streamName": "trunk",
   "workflowVersionOverride": "1.02",
   "inputs": [
    {
       "name": "input1",
       "value": "asd"
    },
    {
       "name": "input2",
       "value": "zxc"
    }]
}
Sample JSON Request for Partial Build
{
   "authentication":
    {
       "userId": "fdadmin",
       "password": "password1"
    },
   "environmentCode": "DEV",
   "forceBuild": "true",
   "qualifiedProjectName": "FlexDeploy/TestApp/MyProj",
   "streamName": "trunk",
   "workflowVersionOverride": "1.02",
   "inputs": [
    {
       "name": "input1",
       "value": "asd"
    },
    {
       "name": "input2",
       "value": "zxc"
    }],
   "projectFiles": [
	{
	  "path": "/java/xxt/oracle/apps/ak/xxperson/webui/xxPersonMainCO.java"
	},
	{
	  "path": "/java/xxt/oracle/apps/ak/xxperson/webui/managePersonCO.java",
      "scmRevision": "1515"
	}]
}

Notice that the projectFiles parameter is included to indicate to FlexDeploy that this request is for a Partial Build.

Parameters

Parameter

Required

Type

Description

authentication

Y

String

See Common Parameters below.

environmentCode

Y

String

This is the environment code, not the environment name that you see on most screens.

forceBuild

Y

Boolean

Values are true or false. Indicates that the build should occur even if there are not SCM changes

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.

workflowVersionOverride

N

String

Optionally the version of the workflow can be overridden.

inputs

N

List

See Common Parameters below.

projectFilesNListA parameter comprised of 2 fields: path and scmRevision. It is included to indicate a Partial Build.
path
N*StringFully qualified file path that is required only if the projectFiles parameter is used.
scmRevision
NLongOptionally 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.

Error rendering macro 'excerpt-include' : No link could be created for 'Workflow Execution REST API'.

  • No labels