Versions Compared

Key

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

This POST service will perform the same action found on the Build Request Form off the application screen. It will initiate a request to build the application selected in the qualifiedApplicationName. The service will return the workflowRequestIdapplicationRequestId which can be used by the getWorkflowRequestStatusgetApplicationRequestStatus call to determine when the workflow is complete.

...

Code Block
languagejs
titleSample JSON Request
linenumberstrue
{
   "authentication":
    {
      "userId": "fdadmin",
      "password": "password1"
    },
   "environmentCode": "",
   "forceBuild": "true",
   "qualifiedApplicationName": "/FlexDeploy/folder1/myApp",
   "projectSettings": [
    {
       "projectName": "SimpleProj",
       "streamName": "trunk",
      "inputs": [
       {
          "name": "inp1", "value": "value1"
       },
       {
          "name": "inp2", "value": "value2"
       }]
    },
    {
       "projectName": "SimpleTest",
       "streamName": "trunk",
       "inputs": [
        {
           "name": "input1",
           "value": "val1"
        },
        {
           "name": "input2",
           "value": "val2"
       }]
   }]
}

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.

qualifiedApplicationName

Y

String

The qualified application name starts with /FlexDeploy and includes any sub folders, and finally the project.

projectSettings

N

List

The project settings is a list of the projects by name and includes the 3 sub-parameters below. If all values can be defaulted, the project setting for that project does not need to be included.

projectName

N*

String

The project name. Is required only if the projectSettings are included.

streamName

N*

String

The name of the Stream. Is required only if the projectSettings are included.

inputs

N

List

See Common Parameters below.

...