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 7 Next »

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 workflowRequestId which can be used by the getWorkflowRequestStatus call to determine when the workflow is complete.

API URL

http://host:port/flexdeploy/rest/workflow/buildApplication
Sample JSON Request
{
   "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


See Common Parameters below.

environmentCode

Y

String

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

forceBuild


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



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



The project name.

streamName

Y

String

The name of the Stream.

inputs



See Common Parameters below.

Common Parameters

Authentication

The authentication parameter is comprised of 2 fields.

  • userId – a valid user id for FlexDeploy
  • password – the associated password

Inputs

This is a list of name/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.

FlexFields

Applicable only for deployProject and deployApplication. This is a list of name (Display Name of FlexField)/value pairs for the Flexfields. 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. Read more about FlexFields.

  • No labels