Overview

This service will perform the same action found on the "Deployment Request Form" off the project screen. It will initiate a request to deploy 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.

URL

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

Sample JSON Request

{
   "authentication": 
    {
       "password":"fdadmin",
       "userId": "password1"
    },
   "environmentCode":"DEV",
   "exceptionToWindow":"true",
   "forceDeploy": "true",
   "instanceCodes":["soa1","soa2"],
   "projectVersion": "1.2",
   "qualifiedProjectName":"/FlexDeploy/folder1/myApp/SimpleProj",
   "startTime":"2015-03-16T21:17:52-06:00",
   "workflowVersionOverride":"1.8",
   "inputs": [
    {
      "name":"input1","value": "xyz"
    },
    {
      "name":"inp2","value": "123"
    }]
   "flexFields": [
    {
      "name": "Change","value":"101012"
    },
    {
      "name": "field2","value":"123"
    }]
}

Parameters

Parameter	Required	Type	Description
Authentication	Y		See Common Parameters.
environmentCode	Y	String	This is the environment code, not the environment name that you see on most screens.
exceptionToWindow		Boolean	Values are true or false. Indicates that the deployment is an exception to the deployment window.
forceDeploy		Boolean	Values are true or false. Indicates that the deployment should occur even when the projectVersion is already deployed to that instance.
instanceCodes	Y		See Common Parameters.
projectVersion		String	The projectVersion to be deployed. If not specified, the most recently built projectVersion will be deployed.
qualifiedProjectName	Y	String	The qualified project name starts with /FlexDeploy and includes any sub folder, then the application and finally the project.
StartTime		DateTime	The time when the deployment will be started.
WorkflowVersionOverride		String	Optionally, the version of the workflow can be overridden.
inputs			See Common Parameters.
flexFields			See Common Parameters.

buildApplication

Overview

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

URL
http://host:port/flexdeploy/rest/workflow/buildApplication

Sample JSON Request

{

"authentication":

{

"userId": "fdadmin",

"password": "password123"

},

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