Versions Compared

Old Version 1

changes.mady.by.user Jack Reynebeau

Saved on

compared with

New Version 2

changes.mady.by.user Jack Reynebeau

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Info
titleAPI URL
http://host:port/flexdeploy/rest/properties/updateProperties
Info

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

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

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

}

Parameters

Parameter

Required

Type

Description

authentication

Y

String

See Common Parameters below.

properties

Y

List

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

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.

propertyName

Y

String

See Common Parameters below.

updatedValue

Y

String

See Common Parameters below.

isExpression
YBooleanSee Common Parameters below.

Insert excerpt
Update Properties REST API
Update Properties REST API
nopaneltrue