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

API URL

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

Sample JSON Request

{
   "authentication": 
    {
       "userId":"fdadmin",
       "password": "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"
    }]
}

Sample JSON Request for Partial Deploy

{
   "authentication": 
    {
       "userId":"fdadmin",
       "password": "password1"
    },
   "environmentCode":"DEV",
   "exceptionToWindow":"true",
   "forceDeploy": "true",
   "instanceCodes":[SOA1","SOA2"],
   "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"
    }],
   "packageDetails": [
	{
	  "packageName": "build-pkg-1",
      "priority": "2"
	},
    {
	  "packageName": "build-pkg-2"
	}]
}

Notice that the packageDetails parameter is included to indicate to FlexDeploy that this request is for a Partial Deploy.

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.
`exceptionToWindow`	N	Boolean	Values are true or false. Indicates that the deployment is an exception to the deployment window.
`forceDeploy`	Y	Boolean	Values are true or false. Indicates that the deployment should occur even when the `projectVersion` is already deployed to that instance.
`instanceCodes`	Y	String	See Common Parameters below.
`projectVersion`	N	String	The projectVersion to be deployed. If not specified, the most recently built `projectVersion` will be deployed. This parameter is ignored for partial deployments. See `packageDetails` for partial deployments.
`qualifiedProjectName`	Y	String	The qualified project name starts with /FlexDeploy and includes any sub folder, then the application and finally the project.
`startTime`	N	DateTime	The time when the deployment will be started.
`workflowVersionOverride`	N	String	Optionally, the version of the workflow can be overridden.
`inputs`	N	List	See Common Parameters below.
`flexFields`	N	List	See Common Parameters below.
`packageDetails`	N	String	Included to indicate a Partial Deploy. Full `packageName` from build is required for this parameter to be used. The deployment `priority` is optional; if it is not indicated, then FlexDeploy will deploy the packages in the order they are provided in the JSON request.

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