deployProject (version 0)
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 (version 0)
call to determine when the workflow is complete.
This page lists examples for Full and deployProject (version 0)#Partial Deployment.
API URL
http://host:port/flexdeploy/rest/workflow/deployProject
Full Deployment Sample JSON Request | |
---|---|
{ "authentication": { "userId":"fdadmin", "password":"password1" }, | Opening bracket Authentication section, used on all types of requests. |
Required parameters for full deployment. If deploying with partial deployment, see the Partial deployment example instead. | |
| Deploy to the SOA1 and SOA2 instances Deploy to the DEV environment. The full path of the FlexDeploy project to run. |
Optionally, include any of this information. Verify that your json is valid; check for trailing commas if you don't include this section. | |
"code":"input1","value":"xyz"
"code":"inp2","value":123
"code":"Change","value":"101012"
"code":"field2","value":"123"
| Deploy project version 1.2 Equivalent to the "Exception to Window" checkbox in the UI. Defaults to false. Time should the deployment start Version of the workflow to run. Defaults to the currently active version. boolean equivalent to "Force Deploy" checkbox in the UI. Defaults to false. List of workflow Input Codes to set An input named "input1" is being set to "xyz" An input named "inp2" is being set to 123 List of FlexField Codes to set Setting FlexField "Change" to "101012" Setting FlexField "field2" to "123" Change Ticket number for configured Change Management System Setting the value of the Change Ticket to "REQ0010015" |
} | Closing bracket |
Partial Deployment Sample JSON Request | |
---|---|
{ "authentication": { "userId":"fdadmin", "password": "password1" }, | Opening bracket Authentication section, used on all types of requests. |
Required parameters for partial deployment. If deploying with full deployment, see the full deployment example above. | |
"packageName":"Jul_2017", "priority":"1", "useLatestPackageVersion" : "true"
"packageName":"Jun_2017", "priority": "2", "projectVersion" : "1.0.21"
| Deploy to the SOA1 and SOA2 instances Deploy to the DEV environment. The full path of the FlexDeploy project to run. List of packages to deploy Deploy package Jul_2017, with priority 1. useLatestPackageVersion will make sure that latest version of the Package Jul_2017 is deployed. Deploy package Jun_2017 with version 1.0.21, with priority 2. Package Name is not unique, so projectVersion or useLatestPackageVersion is necessary. |
Optionally, include any of this information. Verify that your json is valid; check for trailing commas if you don't include this section. | |
"code":"input1","value":"xyz"
"code":"inp2","value":123
"code":"Change","value":"101012"
"code":"field2","value":123
| Equivalent to the "Exception to Window" checkbox in the UI. Defaults to false. Time should the deployment start Version of the workflow to run. Defaults to the currently active version. boolean equivalent to "Force Deploy" checkbox in the UI. Defaults to false. List of workflow Input Codes to set An input named "input1" is being set to "xyz" An input named "inp2" is being set to 123 List of FlexFields Codes to set Setting FlexField "Change" to "101012" Setting FlexField "field2" to 123 Change Ticket number for configured Change Management System Setting the value of the Change Ticket to "REQ0010015" |
} | Closing bracket |
Notice that the packageDetails
parameter is included to indicate to FlexDeploy that this request is for a Partial Deploy.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
| Y | Object | See Common Parameters below. |
| Y | String | This is the environment code, not the environment name that you see on most screens. |
| Y | String | The list of Instances where the deployment will occur. Instance codes are all capital letters. Make sure to enter the instance code, not the instance name. |
| Y | String | The qualified project name starts with /FlexDeploy and includes any sub folder, then the application and finally the project. |
packageDetails | N* | String | This is required for partial deploy, but not for full deployments. Included to indicate what should be deployed in a partial deploy. Full |
| N | Boolean | Values are true or false. Indicates that the deployment should occur even when the |
| N | Boolean | Values are true or false. Indicates that the deployment is an exception to the deployment window. Defaults to false. |
| N | String | The projectVersion to be deployed. If not specified, the most recently built This parameter is ignored for partial deployments. See |
| N | DateTime | The time when the deployment will be started. |
| N | String | Optionally, the version of the workflow can be overridden. |
| N | Array | See Common Parameters below. |
| N | Array | See Common Parameters below. |
changeTicket | N* | String | Ticket number for the given deployment, using the configured Change Management System. |
Common Parameters
Authentication
The authentication
parameter is comprised of 2 fields.
userId
– a valid user id for FlexDeploypassword
– the associated password
Inputs
This is a list of code/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
This is a list of the code/value
pairs for the Flexfields (not the Display Name). 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.
Example Deploy Request
{ "authentication": { "userId":"chandresh", "password":"welcome1" }, "instanceCodes":["ADF1213"], "environmentCode":"QA", "qualifiedProjectName":"/FlexDeploy/ADF/HR/FusionHRDemo", "forceDeploy":"false", "inputs": [ { "code":"RESTART_SERVER", "value":"true" }, { "code":"COMMENT", "value":"Deploying from REST API" } ] }
- style