updateProperties (version 0)

This POST service will perform the same action found on the Properties tab on a Project or an Environment-Instance definition. It will initiate a request to update a property selected from the code. Each JSON request can update any number of properties across multiple Projects and Environment-Instances.

API URL

http://host:port/flexdeploy/rest/properties/updateProperties

Note that you must provide either the qualifiedProjectName OR the environmentCode AND instanceCode.

Sample JSON Request for Project Properties
{
   "authentication":
    {
       "userId": "fdadmin",
       "password": "password1"
    },
   "properties": [
    {
       "qualifiedProjectName": "/FlexDeploy/EBS/EBSPartial/Partial1",
       "code": "FDEBS_APPLICATION_SHORT_NAME",
       "value": "FD_PROJECT_NAME",
       "isExpression": "true"
    },
    {
       "qualifiedProjectName": "/FlexDeploy/EBS/EBSPartial/Partial2",
       "code": "FDEBS_JAVA_ROOT_SOURCE_DIR",
       "value": "java",
       "isExpression": "false"
    }]
}
Sample JSON Request for Environment-Instance Properties
{
   "authentication":
    {
       "userId": "fdadmin",
       "password": "password1"
    },
   "properties": [
    {
       "environmentCode": "BLD",
       "instanceCode": "BUILDADF",
       "code": "FDJDEV_INSTALL_HOME",
       "value": "'/oracle/Middleware/Oracle_Home/' + FD_ENVIRONMENT_CODE",
       "isExpression": "true"
    },
    {
       "environmentCode": "BLD",
       "instanceCode": "BUILDEBS",
       "code": "FDEBS_DB_USER",
       "value": "apps",
       "isExpression": "false"
    }]
}
Sample JSON Request for Different Scoped Properties
{
   "authentication":
    {
       "userId": "fdadmin",
       "password": "password1"
    },
   "properties": [

    {
       "environmentCode": "BLD",
       "instanceCode": "BUILDADF",
       "code": "FDJDEV_INSTALL_HOME",
       "value": "'/oracle/Middleware/Oracle_Home/' + FD_ENVIRONMENT_CODE",
       "isExpression": "true"
    },
    {
       "qualifiedProjectName": "/FlexDeploy/EBS/EBSPartial/Partial1",
       "code": "FDEBS_JAVA_ROOT_SOURCE_DIR",
       "value": "java",
       "isExpression": "false"
    }]

}

Parameters

Parameter

Required

Type

Description

authentication

Y

Object

See Common Parameters below.

properties

Y

Array


environmentCode

N

String

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

instanceCode

N

String

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

qualifiedProjectName

N

String

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

code

Y

String

See Common Parameters below.

value

Y

String

See Common Parameters below.

isExpression
YBooleanSee 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

code

This is the Property Code, and not the Display Name that you see on most screens, that the request will update the value for. To copy the Property Code to your clipboard click on the clipboard icon to the right of any property.

value

This is the new value that will be assigned to the respective property.

IsExpression

This is a required, boolean value indicating whether or not the value is an expression (true) or a literal value. On the FlexDeploy screens the properties have a button that toggles to indicate whether a value is an expression or a literal value .