1 REST API for Server Manager

JD Edwards EnterpriseOne Server Manager provides REST API framework to perform common Server Manager operations.

This chapter contains the following topics:

1.1 Server Manager REST Enablement: Technical Details

You can use the Server Manager REST APIs from any REST client such as cURL, Ruby, Postman, and ARC.

This enables exposing the Server Manager Console and Agents functionality without the need to use the Server Manager UI.

The Server Manager REST APIs are certified with the latest versions of WebLogic Application Servers, starting with the 9.2.1 Tools release.

SMC REST Endpoint - https://<hostname>:<port>/manage/mgmtrestservice

For example, http://den00xlk.jdedwards.com:8999/manage/mgmtrestservice

The Server Manager REST APIs are invoked by the JD Edwards One Click Provisioning process internals to automate the provisioning of EnterpriseOne in Oracle Cloud.

The HTTP and HTTPS methods supported are:

  • POST (for all Create / Update/ Manage Operations)

  • GET (for all Read Operations)

  • PUT (for Upload Operation)

  • DELETE (for all Delete Operations)

1.2 Server Manager REST API Security

The following authentication schemes are supported:

  • Username and Password (for first request only)

  • Basic AUTHORIZATION Header (for first request and subsequent requests)

  • TOKEN Header (for subsequent requests)

  • TOKEN Cookie (for subsequent requests)

The existing Server Manager Console Authorization is applicable.

The following is a sample cURL Authenticate request using username and password:

curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"username":"jde_admin", "password":"password"}' http://den00xlk.jdedwards.com:8999/manage/mgmtrestservice/authenticate

1.3 Server Manager REST APIs

This section describes the list of Server Manager REST APIs and their description:

1.3.1 REST APIs for Authentication

This section contains the details of the REST APIs used for authentication.

1.3.1.1 authenticate

API Name authenticate
Description Authenticates the user. Returns a TOKEN value in the Response Header which is used to perform subsequent different operations.
REST Methods POST
Precondition Agent must be running.
Input Params Enter base64 Encoded username:password in the Authorization Header
Sample Request Basic amRlX2FkbWluOmpkZV9hZG1pbg==(above for jde_admin:jde_admin)or { "username":"jde_admin", "password":"password"}http://den60207jems.jdedwards.com:9182/manage/mgmtrestservice/authenticate
Return

Returns a TOKEN and it's Value in the HTTP Response Header.

Sample Response  
Exception Throws an exception if there is any problem in distributing the software component.

1.3.1.2 refresh

API Name refresh
Description Extends the lifetime of the above created TOKEN by 30 minutes for which a valid TOKEN should to be passed.
REST Methods POST
Precondition  
Input Params TOKEN header with a valid token value.
Sample Request TOKEN 0445ftpTuLjKSZrs6vo1u9o+Wp01Bn67acPfejjTA02e1I=MDA5MDIyMDEyamRlX2FkbWluZGVuMDB4bGsudXMub3JhY2xlLmNvbTEwLjg5LjI5LjEyMTE0NjY2OTI2NzUyNzE=http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/refresh
Return HTTP ACCEPTED STATUS returned.
Sample Response  
Exception  

1.3.1.3 changewlsinstancepwd

API Name changewlsinstancepwd
Description Changes the password on the Server Manager Agent side as well as the WebLogic side for all the domains within a WebLogic Server instance for the WegLogic administrator account.
REST Methods POST
Precondition AdminServers of all the domains in this WebLogic instance should be running, and the admin password for all the domains must be same.
Input Params wlsInstanceName, username, password, newPassword
Sample Request {"wlsInstanceName" : "WLS12.2.1","username" : "weblogic","password" : "welcome1","newPassword" : "welcome2"}
Return HTTPS status accepted is returned if successful.
Sample Response { "instanceName": "PS_JAS_7114", "targetType": "webserver"}
Exception Response.Status.INTERNAL_SERVER_ERROR

1.3.1.4 changedbschemapwd

API Name changedbschemapwd
Description Changes the password for individual schemas or db user.
REST Methods POST
Precondition instanceName, agentHostName,targetType,jdeHome,oraDbSchema,oraDbNewPwd
Input Params wlsInstanceName, username, password, newPassword
Sample Request {"instanceName" : "ordb_path_1","agentHostName" : "den00ugh","targetType" : "oradb","jdeHome" : "/u01/jde_agent_1/SCFHA","oraDbSchema" : "PS920DTA","oraDbNewPwd" : "ovsadmin#E1"}
Return HTTPS status 200 returned.
Sample Response  
Exception Response.Status.INTERNAL_SERVER_ERROR

1.3.1.5 changeadminpwd

API Name changeadminpwd
Description Changes password of the Server Manager Console.
REST Methods POST
Precondition  
Input Params username, password, newPassword
Sample Request {

"username" : "jde_admin",

"password" : "jde_admin",

"newPassword" : "jde_admin1"

}

http://den60207jems.jdedwards.com:9182/manage/mgmtrestservice/changeadminpwd

Return HTTP status 200 returned.
Sample Response  
Exception Throws exception if the operation fails for any reason.

1.3.1.6 changecomponent

API Name changecomponent
Description Updates Managed instance component to a new version.
REST Methods POST
Precondition Agent must be running.
Input Params instanceName, componentName,

pathCode(this is an optional input which is applicable only for bssv).

Sample Request { "componentName":"E1_HTMLServer_9.2.0.2_01-06-2016_10_36.jar", "instanceName":"SM_testServer_7011"}http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/changecomponent
Return HTTP status 200 returned.
Sample Response  
Exception Throws exception if the change component operation fails for any reason.

1.3.1.7 changecomponent64 (Release 9.2.3)

API Name changecomponent64
Description Updates Managed Instance component to a new version for 64-bit. Used for all types of component change with additional parameters for Deployment Server and Enterprise Server component change.
REST Methods POST
Precondition Agent must be running.
Input Params instanceName, componentName, foundationOption, jrePath, sysDBUsername, sysDBPassword.
Parameters instanceName: Name of the instance such as <machine name>_DEP or <machine name>_ENT.

componentName: Name of the .jar file used to change the component.

foundationOption: Required for the Deployment Server component change only.

Value: 0 - No MultiFoundation, component change only.

Update the system and OneWorld Client install with the contents in the .jar file.

1 - Component change and back up current system for MultiFoundation

Back up the current system and OneWorld client install in a version directory and update the system and OneWorld client install from the contents in the .jar file. Update the package build tables.

2 - Component download for MultiFoundation only

Create a version directory and copy the contents of the .jar file to the version directory to create the multi-foundation directory. Update the package build tables.

jrePath: Path to the jre location; leave blank if bitness is the same. Use only with the Deployment Server or Enterprise Server when changing the component to a different bitness such as changing from a 32-bit system to a 64-bit system. Also, use with the Deployment Server if foundationOption is set to '2' and system is 64-bit.

sysDBUsername: User name to the SYSTEM Datasource database. Required for the Deployment Server component change only and when foundationOption is set to 1' or '2'.

sysDBPassword: User password to the SYSTEM Datasourse database. Required for the Deployment Server component change only and when foundationOption is set to 1' or '2'.

Sample Request { "componentName":"9.2.3.0.Release64.DS.Win64_09-13-2018_07_48.jar", "instanceName":"den00los_DEP", "foundationOption": "1", "jrePath": "C:\\Program Files\\Java\\jre1.8.0_181", "sysDBUsername": "SY920", "sysDBPassword": "password" }http://den60212jems.jdedwards.com:9166/manage/mgmtrestservice/changecomponent64
Return HTTP status 200 returned.
Sample Response  
Exception Throws exception if the change component operation fails for any reason.

1.3.1.8 changecomponent64 (Release 9.2.4)

API Name changecomponent64
Description Updates Managed Instance component to a new version for 64-bit. Used for all types of component change with additional parameters for Deployment Server and Enterprise Server component change.
REST Methods POST
Precondition Agent must be running.
Input Params instanceName, componentName, foundationOption, jrePath, sysDBUsername, sysDBPassword, release.
Parameters instanceName: Name of the instance such as <machine name>_DEP or <machine name>_ENT.

componentName: Name of the .jar file used to change the component.

foundationOption: Required for the Deployment Server component change only.

Value: 0 - No MultiFoundation, component change only.

Update the system and OneWorld Client install with the contents in the .jar file.

1 - Component change and back up current system for MultiFoundation

Back up the current system and OneWorld client install in a version directory and update the system and OneWorld client install from the contents in the .jar file. Update the package build tables.

2 - Component download for MultiFoundation only

Create a version directory and copy the contents of the .jar file to the version directory to create the multi-foundation directory. Update the package build tables.

jrePath: Path to the jre location; leave blank if bitness is the same. Use only with the Deployment Server or Enterprise Server when changing the component to a different bitness such as changing from a 32-bit system to a 64-bit system. Also, use with the Deployment Server if foundationOption is set to '2' and system is 64-bit.

sysDBUsername: User name to the SYSTEM Datasource database. Required for the Deployment Server component change only and when foundationOption is set to 1' or '2'.

sysDBPassword: User password to the SYSTEM Datasourse database. Required for the Deployment Server component change only and when foundationOption is set to 1' or '2'.

release: Release of the deployment server environment such as E920 or E910.

Sample Request { "componentName":"9.2.3.0.Release64.DS.Win64_09-13-2018_07_48.jar", "instanceName":"den00los_DEP", "foundationOption": "1", "jrePath": "C:\\Program Files\\Java\\jre1.8.0_181", "sysDBUsername": "SY920",

"sysDBPassword": "password",

"release": "E920"}http://den60212jems.jdedwards.com:9166/manage/mgmtrestservice/changecomponent64
Return HTTP status 200 returned.
Sample Response  
Exception Throws exception if the change component operation fails for any reason.

1.3.1.9 changedbsyspwd

API Name changedbsyspwd
Description Changes the password of the Oracle Database SYS/SYSTEM.
REST Methods POST
Precondition oradb instance must be available.
Input Params  
Sample Request {"instanceName" : "ora101","agentHostName" : "BRIJESH-3.compute-jdeidcdev.oraclecloud.internal","targetType" : "oradb","jdeHome" : "/u01/jde_agent_1/SCFHA","oraDbNewPwd" : "ovsadmin#E1"}
Return HTTP status 200 returned.
Sample Response  
Exception Response.Status.INTERNAL_SERVER_ERROR.

1.3.1.10 dbschemacomponent

API Name dbschemacomponent
Description Retrieves deployed/currently deploying DB schema component name.
REST Methods GET
Precondition oradb instance must be available.
Input Params agentHostName,jdeHome,instanceName
Sample Request http://host:port/manage/mgmtrestservice/dbschemacomponent?agentHostName=BKALLERI-IN.oradev.jdedwards.com&jdeHome=D:\jde_agent_1\SCFHA&instanceName=ora109
Return HTTP status 200 returned.
Sample Response  
Exception None.

1.3.2 REST APIs for Provisioning

This section contains the details of the REST APIs used for provisioning.

1.3.2.1 createinstance

API Name createinstance
Description Creates any of the E1 instance. For example, HTML, RTE, AIS, ENTERPRISE, and BSSV Servers.
REST Methods POST
Precondition Agent must be running.

For Oradb Oracle Database should be up and running.

Input Params instanceName, targetType, agentHostName, jdeHome, wlsServerName, httpPort, componentName, InstallPath, pathCode( this is an optional input which is applicable only for the bssv) .
Sample Request Create Enterprise Server JSON Request

{"instanceName" : "ent778","installPath" : "/home/ent778","agentHostName" : "den00pad.jdedwards.com","targetType" : "entserver","jdeHome" : "/home/skaja/jde_Agent/SCFHA", "componentName" : "9.2.1.0.Release.ES.Linux_06-22-2016_10_21.jar","appComponentName" : "E1_APP_9.2.0.5_05-20-2016_01_07.jar","pathCodeDV" : "true","pathCodePS" : "false","pathCodePY" : "false","pathCodePD" : "false"}

Create HTML Instance

{"instanceName" : "HTML_8890","agentHostName" : "den60207jems.jdedwards.com","targetType" : "webserver","jdeHome" : "/slot/ems17481/oracle/jde_agent/SCFHA","componentName" : "E1_HTMLServer_9.2.1.0_06-22-2016_01_10.jar","wlsServerName" : "Testapi","httpPort" : "5438"}

Sample Request Create OradbComponent JSON Request

Note: This example is supported only for Oracle DB on Linux platform.

{"instanceName" : "ora01","agentHostName" : "BKALLERI-IN.jdedwards.com","targetType" : "oradb","jdeHome" : "/u01/jde_home_1/SCFHA"componentName" : "E1_ORACLEDB_9.2.0.5_05-20-2016_01_07.jar", "oradbInstance" : { "oraDBHost" : "localhost","oraDBPort" : "1521","oraDBSid" : "ORCL","oraDBPass" : "oracle123","oraDBJdePass" : "test123", "oraDBInstallDir": "/u01/test_v3","oraDBTableDir": "/u01/data/table","oraDBIndexDir": "/u01/data/index","oraSHARED" : true,"oraADF" : true,"oraOVR" : true, "oradbSchema" : { "oraPROD" : false, "oraPRIST" : true, "oraCRP" : false, "oraDEV" : false }, "oradbDemoSchema" : { "oraPRODDEMO" : false, "oraPRISTDEMO" : true, "oraCRPDEMO" : false, "oraDEVDEMO" : false } } }

Sample Request Create Web Component JSON Request

{"instanceName" : "EA_JS_8080","agentHostName" : "den60207jems.jdedwards.com","targetType" : "webserver","jdeHome" : "/slot/ems17481/oracle/jde_agent/SCFHA","componentName" : "E1_HTML Server 9.2.0.0 08-10-2015_07_22.jar","wlsServerName" : "AS_JS_8080","httpPort" : "8080"}http://den60207jems.jdedwards.com:9182/manage/mgmtrestservice/createinstance

Return HTTP status CREATED code returned.
Sample Response  
Exception Throws an exception if anything prevents the instance from being created successfully.

1.3.2.2 registerdepserver

API Name registerdepserver
Description Registers an existing Deployment Server instance.
REST Methods POST
Precondition Agent must be running.
Input Params targetType, agentHostname, jdeHome, depInstallPath, instanceName
Sample Request {"instanceName" : "DepServer92","agentHostName": "den60207jems.jdedwards.com","depInstallPath" : ""D:\\JDEdwards\\E920","jdeHome": "D:\\jde_agent_1\\SCFHA",}http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/registerdepserver
Return HTTP status 200 returned.
Sample Response  
Exception Throws an exception if there is any problem in input or from the registration of Deployment Server instance.

1.3.2.3 registerentserver

API Name registerentserver
Description Registers an existing Enterprise Server instance.
REST Methods POST
Precondition Agent must be running.
Input Params targetType, agentHostname, jdeHome, depInstallPath, instanceName
Sample Request {"instanceName" : "MyEntSvr","agentHostName" : "den00xlk.jdedwards.com","depInstallPath" : "/u01/jde920/e920","jdeHome" : "/u01/jde920/jde_home_1/SCFHA",}http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/registerentserver
Return HTTP status 200 returned.
Sample Response  
Exception Throws an exception if there is any problem in input or any problems from the registration of Deployment Server instance.

1.3.2.4 deleteinstance

API Name deleteinstance
Description Deletes any Managed instance.
REST Methods DELETE
Precondition Agent must be running.
Input Params instanceName
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/deleteinstance{"instanceName" : "HTML_8890"}
Return HTTP status 204 returned.
Sample Response  
Exception Throws an exception if anything prevents the instance from being deleted successfully.

1.3.2.5 registerwls

API Name registerwls
Description Registers a WebLogic Server instance.
REST Methods POST
Precondition Agent must be running.
Input Params targetType, instanceName, wlsInstallPath, wlsUsername, wlsPassword, agentHostName, jdeHome
Sample Request {"targetType" : "owl_1212","instanceName" : "Weblogic12c_1212","installPath" : "/slot/ems17481/oracle/Middleware","wlsUserName" : "weblogic","wlsPassword" : "welcome1","agentHostName" : "den60207jems.jdedwards.com ","jdeHome" : "/slot/ems17481/oracle/jde_agent/SCFHA"}http://den60207jems.jdedwards.com:9182/manage/mgmtrestservice/registerwls
Return HTTP status CREATED code returned.
Sample Response  
Exception Throws an exception if anything prevents the instance from being created successfully.

1.3.2.6 uploadcomponent

API Name uploadcomponent
Description Uploads software components to the Server Manager Console.
REST Methods PUT
Precondition  
Input Params file (file to be uploaded to the Server Manager Console.)
Sample Request curl -X PUT -H "TOKEN: 044FLzIuXTUDhoZt9qoxx2YKAh0jzBvyCPLTfMWCWm9xaA=MDA5MDM4MDEzamRlX2FkbWluZGhjcC1wdHAxLTEwLTE3Ny0xMzktODIuaWRjLm9yYWNsZS5jb20xMC4xNzcuMTM5LjgyMTQ3NDI3OTY4NDk3OQ==" -H "Cache-Control: no-cache" -H "Content-Type: multipart/form-data " -F "file=@" "http://dnvmtqa64.jdedwards.com :8999/manage/mgmtrestservice/uploadcomponent"
Return HTTP status 201 returned.
Sample Response  
Exception Throws an exception if there is any problem in uploading software component.

1.3.2.7 distributecomponent

API Name distributecomponent
Description Distributes Managed Component from Server Manager Console to any Server Manager Agent.
REST Methods POST
Precondition Agent must be running.
Input Params agentHostName, jdeHome, componentName
Sample Request {"agentHostName" : "den60207jems.jdedwards.com ","jdeHome" : "/slot/ems17481/oracle/jde_agent/SCFHA","componentName" : "E1_HTMLServer_9.2.0.0_08-10-2015_07_22.jar"}http://den60207jems.jdedwards.com:9182/manage/mgmtrestservice/distributecomponent
Return true/false
Sample Response  
Exception Throws an exception if there is any problem in distributing software component.

1.3.2.8 createwlsserver

API Name createwlsserver
Description Creates a J2EE container within a WebLogic Server instance.
REST Methods POST
Precondition Agent must be running.
Input Params wlsInstanceName, wlsDomainName, wlsServerName, httpPort, wlsNmMachineName
Sample Request { "wlsInstanceName": "wls12c3_ems17481", "wlsDomainName": "E1_domain", "wlsServerName": "Testapi", "httpPort": "5438", "wlsNmMachineName": "den60207jems"}http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/createwlsserver
Return HTTP status 201 returned.
Sample Response  
Exception Throws an exception if there is any problem in input or any problems from the creation of J2ee container within the WebLogic Server instance.

1.3.2.9 deletewlsserver

API Name deletewlsserver
Description Deletes a J2EE container within a WebLogic Server instance.
REST Methods DELETE
Precondition Agent must be running.
Input Params wlsInstanceName, wlsDomainName, wlsServerName
Sample Request {"wlsInstanceName" : "wls12c3_ems17481","wlsDomainName" : "E1_domain","wlsServerName" : "Testapi"}http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/deletewlsserver
Return HTTP status 204 returned.
Sample Response  
Exception Throws an exception if there is any problem in deleting the container.

1.3.2.10 deploypathcode

API Name deploypathcode
Description Deploys the path code.
REST Methods POST
Precondition Agent must be running.
Input Params agentHostName, jdeHome,instanceName,pathCode
Sample Request {"instanceName" : "ent790","agentHostName" : "dnptvm09.jdedwards.com","jdeHome" : "/u01/jde_agent_ent/SCFHA", "pathCode": "PY"}http://dnptvm09.jdedwards.com :8999/manage/mgmtrestservice/deploypathcode
Return HTTP status 201 returned.
Sample Response  
Exception Throws an exception if the operation fails for any reason..

1.3.2.11 iniconfig

API Name iniconfig
Description Gets INI config in JSON format for any E1 instances such as HTML, RTE, AIS, ENTERPRISE, BSSV servers, and so on.
REST Methods GET
Precondition Agent must be running.
Input Params instanceName , sectionName
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/iniconfig?instanceName=HTML_8890http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/iniconfig?instanceName=HTML_8890&sectionName=CACHE
Return Returns INI config requested in JSON format.
Sample Response  
Exception None.

1.3.2.12 gensmcsitekey

API Name gensmcsitekey
Description Generates and gets the Sitekey used by the security server and port used by the Server Manager Console.
REST Methods POST
Precondition Security Server must be configured in Server Manager.
Input Params passPhrase
Sample Request { "passPhrase": "Welcome__12" }http://host:port/manage/mgmtrestservice/gensmcsitekey
Return HTTP status 200 returned.
Sample Response { "result": { "CurrentKey": "ADWdBNmEmUD46O/IoOKxbb9rgJUvfo4UMk2rbRI+OQxiQX4RqnVRmHlINxSO9pukRGozvqGrlZ3XcQX34Nf8k=", "PreviousKey": "(not found in JDE.INI)" }}
Exception Throws an exception if the operation fails for any reason.

1.3.2.13 encr

API Name encr
Description Encrypts any textual data passed to this API.
REST Methods POST
Precondition Request body text will be encrypted, no params or attributes need to be passed. API expects text/plain input.
Input Params  
Sample Request MIME type is text/plain and entire Request Body will be encrypted and returned.
Return HTTP 200 status code and the Response contains the encrypted representation of the input Text.
Sample Response  
Exception Response.Status.INTERNAL_SERVER_ERROR.

1.3.2.14 decr

API Name decr
Description Decrypts any textual data passed to this API.
REST Methods POST
Precondition Request body text will be decrypted, no params or attributes need to be passed. API expects text/plain input.
Input Params  
Sample Request MIME type is text/plain and entire Request Body will be decrypted and returned. The data passed in must be previously encrypted by calling encr, only then can it be successfully decrypted by this API.
Return HTTP 200 status code and the Response contains the decrypted representation of the input Text.
Sample Response  
Exception Response.Status.INTERNAL_SERVER_ERROR.

1.3.2.15 createoradbinstance (Release 9.2.1.2)

API Name createoradbinstance
Description Creates JDE schema on a DBCS or Compute DB.
REST Methods POST
Precondition Agent must be running.
Input Params instanceName

agentHostName

targetType

jdeHome

componentName

oraDBHost

oraDBPort

oraDBSid

oraDBPdbName

oraDBPass

oraDBJdePass

oraSHARED

oraADF

oraOVR

oraASM

oraRTE

oraPROD

oraPRIST

oraCRP

oraDEV

oraPRODDEMO

oraPRISTDEMO

oraCRPDEMO

oraDEVDEMO

oraDBJdbcUrl

oraDBInstallDir

oraDBIndexDir

oraDBTableDir

Sample Request {"instanceName": "compute_v2","agentHostName": "den00ugh","targetType": "oradb","jdeHome": "/u01/jde_agent_1/SCFHA","componentName": "E1_ORACLEDB_9.2.1.1_11-29-2016_18_39.jar","oradbInstance":{"oraDBHost": "localhost","oraDBPort": "1521","oraDBSid": "jdeorcl","oraDBPdbName" : "PDB1","oraDBPass": "ovsadminE1","oraDBJdePass": "test123","oraDBInstallDir": "/u01/compute_v2","oraDBTableDir": "/u01/data/table","oraDBIndexDir": "/u01/data/index","oraDBJdbcUrl": "jdbc:oracle:thin:@(DESCRIPTION =(ADDRESS = (PROTOCOL = TCP)(HOST = den00ugh)(PORT = 1521))(CONNECT_DATA = (SERVER = DEDICATED)(SERVICE_NAME = jdeorcl)))","oraSHARED": true,"oraADF": true,"oraOVR": true,"oraASM": false,"oraRTE": true,"oradbSchema":{"oraPROD": false,"oraPRIST": false,"oraCRP": false,"oraDEV": true},"oradbDemoSchema":{"oraPRODDEMO": false,"oraPRISTDEMO": false,"oraCRPDEMO": false,"oraDEVDEMO": true}}}
Return HTTP status 201 returned.
Sample Response  
Exception 400 or 409 for error.

1.3.2.16 createweblogicdomain (Release 9.2.1.2)

API Name createweblogicdomain
Description Creates weblogic domain, start nodemanager, and machine ins reachable state.
REST Methods POST
Precondition Agent must be running.
Input Params

wlsInstanceNamewlsDomainNamewlsDomainListenPortwlsNmListenPort(optinal) by default 5556)wlsDomainMode(optional)

Sample Request { "wlsInstanceName" : "WLS_1213", "wlsDomainName" : "tdomain1", "wlsDomainListenPort" : "7012", "wlsNmListenPort" : "5563"}
Return HTTP status 201 returned.
Sample Response  
Exception Throws Exception if anything prevents creation of weblogic domain.

1.3.2.17 dbdeleteschema (Release 9.2.1.2)

API Name dbdeleteschema
Description Deletes the deployed schemas from an ORADB instance.
REST Methods DELETE
Precondition Agent must be running.
Input Params

instanceNameagentHostNametargetTypejdeHome

Sample Request {"instanceName" : "ora100","agentHostName" : "dasdbcompute.compute-emeaaujdedev.oraclecloud.internal","targetType" : "oradb","jdeHome" : "/u01/jde_home/SCFHA"}
Return HTTP status 202 returned.
Sample Response  
Exception 304 or 400 for error.

1.3.2.18 dbdeleteschemastatus (Release 9.2.1.2)

API Name dbdeleteschemastatus
Description Retrieves current status for a previous call to dbdeleteschema.
REST Methods GET
Precondition Agent must be running.
Input Params

agentHostName,jdeHome,instanceName.

Sample Request agentHostName=jdedb.compute-emeaaujdedev.oraclecloud.internal&jdeHome=/u01/jde_home_1/SCFHA&instanceName=jde_jdedb
Return HTTP status 202 returned.
Sample Response  
Exception 400 for error.

1.3.2.19 createadfinstance (Release 9.2.1.2)

API Name createadfinstance
Description Creates an ADF Server instance.
REST Methods POST
Precondition Agent must be running.The Oracle Database should be up and running for Oradb.
Input Params

instanceName, componentName, agentHostName, jdeHome, wlsServerName, httpPort.

Sample Request {"instanceName" : "SM_adfserver_9005","componentName" : "E1_ADF_Foundation_1.4.0_23_99.par","agentHostName" : "den01ful.us.jdedwards.com","jdeHome" : "/scratch/sm_agent/SCFHA","wlsServerName" : "adfserver_9005","httpPort" : "9005"}
Return HTTP status CREATED code returned.
Sample Response  
Exception HTTP conflict if an instance with same name exists.

1.3.2.20 createorchinstance (Release 9.2.1.2)

API Name createorchinstance
Description Creates an Orchestrator Studio Server instance.
REST Methods POST
Precondition Agent must be running.
Input Params instanceName, componentName, agentHostName, jdeHome, wlsServerName, httpPort.
Sample Request {"instanceName" : "SM_iotserver_9055","componentName" : "E1_IoT_Foundation_1.4.0_23_99.par","agentHostName" : "den01ful.us.jdedwards.com","jdeHome" : "/scratch/sm_agent/SCFHA","wlsServerName" : "iotserver_9055","httpPort" : "9055"}
Return HTTP status CREATED code returned.
Sample Response  
Exception HTTP CONFLICT if an instance with the same name exists.

1.3.2.21 createmssqldbinstance (Release 9.2.2)

API Name createmssqldbinstance
Description Creates an MS SQL DB instance.
REST Methods POST
Precondition Agent must be running.
Input Params instanceName, componentName, agentHostName.
Sample Request {"instanceName": "mssql_win1", "agentHostName": "den00lhy.us.jdedwards.com", "targetType": "mssqldb", "jdeHome": "C:\\jde_sqldb_agent\\SCFHA", "componentName": "E1_SQLDB_9.2.1.4_2017-07-28_17-22.jar", "mssqldbInstance": { "mssqlDBHost": "den00lhy\\jderest", "mssqlDBInstallDir": "C:\\jde921", "mssqlDBDataDir": "C:\\jde921\\Data", "mssqlDBLogDir": "C:\\jde921\\Log", "mssqlDBPort": "", "mssqlDBPass": "Tools123", "mssqlDBJdePass": "", "mssqlSHARED": true, "mssqlRTE": false, "mssqldbSchema": { "mssqlPROD": false, "mssqlPRIST": false, "mssqlCRP": false, "mssqlDEV": false }, "mssqldbDemoSchema": { "mssqlPRODDEMO": false, "mssqlPRISTDEMO": false, "mssqlCRPDEMO": false, "mssqlDEVDEMO": false } }}
Return HTTP status CREATED code returned.
Sample Response  
Exception HTTP CONFLICT if an instance with the same name exists.

1.3.2.22 createdb2dbinstance (Release 9.2.2.4)

API Name createdb2dbinstance
Description Creates an IBM i DB instance.
REST Methods POST
Precondition Agent must be running.
Input Params instanceName, componentName, agentHostName.
Sample Request { "instanceName": "4dbins", "agentHostName": "denqas1.jdedwards.com", "targetType": "db2db", "jdeHome": "/den00rpn/jde_home_denqas1_Agent/SCFHA", "componentName": "E1_AS400DB_9.2.2.4_2018-03-21_16-38.jar", "db2dbInstance": { "db2DBHost": "denqas1", "db2DBOWPass": "test", "db2SHARED": true, "db2RTE": false, "db2dbSchema": { "db2PROD": false, "db2PRIST": true, "db2CRP": false, "db2DEV": true }, "db2dbDemoSchema": { "db2PRODDEMO": false, "db2PRISTDEMO": true, "db2CRPDEMO": false, "db2DEVDEMO": false } } }}
Return HTTP status 201 Created code returned.
Sample Response  
Exception HTTP CONFLICT if an instance with the same name exists.

1.3.3 REST APIs for Monitoring

This section contains the details of the REST APIs used for monitoring.

1.3.3.1 homesupdatestatus

API Name homesupdatestatus
Description API to get the status of the Managed Homes whether update is required or not. Returns result only for the running agent.
REST Methods GET
Precondition Agent must be running.
Input Params  
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/homesupdatestatus
Return HTTP Status 200 and returns list of Managed Homes requiring update (agentHostName,jdeHome)
Sample Response { "managedHomesSet": [ "dnsvrtdev06.jdedwards.com ,C:\\jde_Agent_SM9205_xif\\SCFHA" ]}
Exception Throws an exception if the operation fails for any reason.

1.3.3.2 servergroupinfo

API Name servergroupinfo
Description Provides information about server group including server group names, members and description.
REST Methods GET
Precondition None
Input Params TOKEN header with a valid token value.
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/servergroupinfo
Return HTTP 200 status code and the response containing the server group information. See sample response.
Sample Response [ { "serverGroupName": "default", "serverGroupInstances": [ "E900EntSvr", "E910EntServer", "EA_AIS_9090", "EA_JS_5050", "EA_JS_7070", "EA_JS_8080" ], "serverGroupDescription": "The default server group." }, { "serverGroupName": "negative_group", "serverGroupInstances": [], "serverGroupDescription": "Negative Server Group" }]
Exception None.

1.3.3.3 homesinfo

API Name homesinfo
Description Retrieves information for all Managed Homes.
REST Methods GET
Precondition  
Input Params None
Sample Request https://host:port/manage/mgmtrestservice/homesinfo
Return HTTP status 200 returned.
Sample Response { "result": [ { "jdeHome": "C:\\jde_home_agent_SM9205\\SCFHA", "agentHostName": "den00xif.jdedwards.com " }, { "jdeHome": "C:\\jde_Agent_SM9205_xif\\SCFHA", "agentHostName": "dnsvrtdev06.jdedwards.com " }, { "jdeHome": "C:\\jde_home_SM9205\\SCFMC", "agentHostName": "den00xif.jdedwards.com " } ]}
Exception None.

1.3.3.4 agentinfo

API Name agentinfo
Description Returns all the information about a particular agent.
REST Methods GET
Precondition Agent must be running.
Input Params agentHostName, jdeHome
Sample Request https://host:port/manage/mgmtrestservice/agentinfo?agentHostName=den00xif.jdedwards.com&jdeHome=C:\jde_home_agent_SM9205\SCFHA
Return HTTP status 200 returned.
Sample Response {"agentHostName": "den00xif.jdedwards.com ", "jdeHome": "C:\\jde_home_agent_SM9205\\SCFHA","result": { "agentJavaVersion": "1.8", "agentType": "STANDALONE_AGENT", "agentHostPort": "14503", "state": "RUNNING", "platform": "windows", "agentBuildNumber": "1" }}
Exception None.

1.3.3.5 instancesinfo

API Name instancesinfo
Description Gets information about each managed instance created in the Server Manager Console. Returns unknown state for instances under offline agent.
REST Methods GET
Precondition Agent must be running.
Input Params  
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/instancesinfo
Return Set of instance details with information of each component such as instanceName, targetType, and status.
Sample Response { "result": true,
"instancesInfo": [ { "instanceName": "DS_REST_PS1", "targetType": "depserver", "status": "RUNNING" }, { "instanceName": "home", "targetType": "mgmtconsole", "status": "RUNNING" }, { "instanceName": "WLS_12_RoM", "targetType": "owl_1212", "status": "STOPPED" }, { "instanceName": "DS_dnsvrtdev06", "targetType": "depserver", "status": "RUNNING" }, { "instanceName": "RTE_TEST_J2EE_P", "targetType": "rteserver", "status": "UNKNOWN" }, { "instanceName": "WLS1221_P", "targetType": "owl_1212", "status": "RUNNING" } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.3.6 wlsdomaininfo

API Name wlsdomaininfo
Description Lists the domains in a WebLogic Server instance.
REST Methods GET
Precondition Agent must be running.
Input Params wlsInstanceName
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/wlsdomaininfo?wlsInstanceName=weblogic1213
Return HTTP status 200 and returns the list of WebLogic Server domains in the WebLogic Server instance.
Sample Response { "wlsInstanceName": "tqa_923_lnx_wls_den60206jems_23600", "result": { "E1domain": [ "den60206jems.jdedwards.com" ], "SMCdomain": [ "den60206jems.jdedwards.com" ] }}
Exception Throws an exception incase of problems.

1.3.3.7 wlsserverinfo

API Name wlsserverinfo
Description Gets information about WebLogic Server.
REST Methods GET
Precondition Agent must be running.
Input Params wlsInstanceName
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/wlsserverinfo?wlsInstanceName=WLS1221_xif
Return HTTP status 200 returned.
Sample Response { "wlsInstanceName": "WLS1221_xif", "wlsInstancesInfo": [ { "AdminServer": { "canonicalName": "jde:domainName=base_domain,instanceName=WLS1221_xif,j2eeType=J2EEServer,metricName=owl_J2EEServer,name=AdminServer,targetType=owl_1212", "pattern": false, "domainPattern": false, "propertyPattern": false, "propertyListPattern": false, "propertyValuePattern": false, "keyPropertyListString": "instanceName=WLS1221_xif,name=AdminServer,domainName=base_domain,j2eeType=J2EEServer,targetType=owl_1212,metricName=owl_J2EEServer", "canonicalKeyPropertyListString": "domainName=base_domain,instanceName=WLS1221_xif,j2eeType=J2EEServer,metricName=owl_J2EEServer,name=AdminServer,targetType=owl_1212", "keyPropertyList": { "instanceName": "WLS1221_xif", "targetType": "owl_1212", "name": "AdminServer", "domainName": "base_domain", "metricName": "owl_J2EEServer", "j2eeType": "J2EEServer" }, "domain": "jde" },
Sample Response (continued) "SMC_Server_EOne_MC_SM9205_Console": { "canonicalName": "jde:domainName=base_domain,instanceName=WLS1221_xif,j2eeType=J2EEServer,metricName=owl_J2EEServer,name=SMC_Server_EOne_MC_SM9205_Console,targetType=owl_1212", "pattern": false, "domainPattern": false, "propertyPattern": false, "propertyListPattern": false, "propertyValuePattern": false, "keyPropertyListString": "instanceName=WLS1221_xif,name=SMC_Server_EOne_MC_SM9205_Console,domainName=base_domain,j2eeType=J2EEServer,targetType=owl_1212,metricName=owl_J2EEServer", "canonicalKeyPropertyListString": "domainName=base_domain,instanceName=WLS1221_xif,j2eeType=J2EEServer,metricName=owl_J2EEServer,name=SMC_Server_EOne_MC_SM9205_Console,targetType=owl_1212", "keyPropertyList": { "instanceName": "WLS1221_xif", "targetType": "owl_1212", "name": "SMC_Server_EOne_MC_SM9205_Console", "domainName": "base_domain", "metricName": "owl_J2EEServer", "j2eeType": "J2EEServer" }, "domain": "jde" } },
Sample Response (continued) { "J2EE_BSSV_37200": { "canonicalName": "jde:domainName=bssv_domain,instanceName=WLS1221_xif,j2eeType=J2EEServer,metricName=owl_J2EEServer,name=J2EE_BSSV_37200,targetType=owl_1212", "pattern": false, "domainPattern": false, "propertyPattern": false, "propertyListPattern": false, "propertyValuePattern": false, "keyPropertyListString": "instanceName=WLS1221_xif,name=J2EE_BSSV_37200,domainName=bssv_domain,j2eeType=J2EEServer,targetType=owl_1212,metricName=owl_J2EEServer", "canonicalKeyPropertyListString": "domainName=bssv_domain,instanceName=WLS1221_xif,j2eeType=J2EEServer,metricName=owl_J2EEServer,name=J2EE_BSSV_37200,targetType=owl_1212", "keyPropertyList": { "instanceName": "WLS1221_xif", "targetType": "owl_1212", "name": "J2EE_BSSV_37200", "domainName": "bssv_domain", "metricName": "owl_J2EEServer", "j2eeType": "J2EEServer" }, "domain": "jde" },
Sample Response (continued) "J2EE_BSSV_37100": { "canonicalName": "jde:domainName=bssv_domain,instanceName=WLS1221_xif,j2eeType=J2EEServer,metricName=owl_J2EEServer,name=J2EE_BSSV_37100,targetType=owl_1212", "pattern": false, "domainPattern": false, "propertyPattern": false, "propertyListPattern": false, "propertyValuePattern": false, "keyPropertyListString": "instanceName=WLS1221_xif,name=J2EE_BSSV_37100,domainName=bssv_domain,j2eeType=J2EEServer,targetType=owl_1212,metricName=owl_J2EEServer", "canonicalKeyPropertyListString": "domainName=bssv_domain,instanceName=WLS1221_xif,j2eeType=J2EEServer,metricName=owl_J2EEServer,name=J2EE_BSSV_37100,targetType=owl_1212", "keyPropertyList": { "instanceName": "WLS1221_xif", "targetType": "owl_1212", "name": "J2EE_BSSV_37100", "domainName": "bssv_domain", "metricName": "owl_J2EEServer", "j2eeType": "J2EEServer" }, "domain": "jde" },
Sample Response (continued) "AdminServer": { "canonicalName": "jde:domainName=bssv_domain,instanceName=WLS1221_xif,j2eeType=J2EEServer,metricName=owl_J2EEServer,name=AdminServer,targetType=owl_1212", "pattern": false, "domainPattern": false, "propertyPattern": false, "propertyListPattern": false, "propertyValuePattern": false, "keyPropertyListString": "instanceName=WLS1221_xif,name=AdminServer,domainName=bssv_domain,j2eeType=J2EEServer,targetType=owl_1212,metricName=owl_J2EEServer", "canonicalKeyPropertyListString": "domainName=bssv_domain,instanceName=WLS1221_xif,j2eeType=J2EEServer,metricName=owl_J2EEServer,name=AdminServer,targetType=owl_1212", "keyPropertyList": { "instanceName": "WLS1221_xif", "targetType": "owl_1212", "name": "AdminServer", "domainName": "bssv_domain", "metricName": "owl_J2EEServer", "j2eeType": "J2EEServer" }, "domain": "jde" } } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.3.8 wlsclustersinfo

API Name wlsclustersinfo
Description Gets information about the clusters in the WebLogic server.
REST Methods GET
Precondition Agent must be running.
Input Params wlsInstanceName
Sample Request https://host:port/manage/mgmtrestservice/wlsclustersinfo?wlsInstanceName=WLS1221_xif
Return HTTP status 200 returned.
Sample Response { "wlsInstanceName": "WLS1221_xif", "wlsInstancesInfo": [ { "NONE": { "canonicalName": "jde:domainName=base_domain,instanceName=WLS1221_xif,metricName=owl_cluster,name=NONE,targetType=owl_1212", "pattern": false, "domainPattern": false, "propertyPattern": false, "propertyListPattern": false, "propertyValuePattern": false, "keyPropertyListString": "instanceName=WLS1221_xif,name=NONE,domainName=base_domain,targetType=owl_1212,metricName=owl_cluster", "canonicalKeyPropertyListString": "domainName=base_domain,instanceName=WLS1221_xif,metricName=owl_cluster,name=NONE,targetType=owl_1212", "keyPropertyList": { "instanceName": "WLS1221_xif", "name": "NONE", "domainName": "base_domain", "targetType": "owl_1212", "metricName": "owl_cluster" }, "domain": "jde" }
Sample Response (continued) }, { "NONE": { "canonicalName": "jde:domainName=bssv_domain,instanceName=WLS1221_xif,metricName=owl_cluster,name=NONE,targetType=owl_1212", "pattern": false, "domainPattern": false, "propertyPattern": false, "propertyListPattern": false, "propertyValuePattern": false, "keyPropertyListString": "instanceName=WLS1221_xif,name=NONE,domainName=bssv_domain,targetType=owl_1212,metricName=owl_cluster", "canonicalKeyPropertyListString": "domainName=bssv_domain,instanceName=WLS1221_xif,metricName=owl_cluster,name=NONE,targetType=owl_1212", "keyPropertyList": { "instanceName": "WLS1221_xif", "name": "NONE", "domainName": "bssv_domain", "targetType": "owl_1212", "metricName": "owl_cluster" }, "domain": "jde" } } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.3.9 applicationversion

API Name applicationversion
Description Retrieves app version of the deployed path code.
REST Methods GET
Precondition Agent must be running
Input Params agentHostName, jdeHome,instanceName
Sample Request http://dnptvm09.jdedwards.com:8999/manage/mgmtrestservice/applicationversion?agentHostName=dnptvm09.jdedwards.com&jdeHome=/u01/jde_agent_ent/SCFHA&instanceName=ent790
Return  
Sample Response  
Exception Throws an exception if the operation fails for any reason.

1.3.3.10 dbschemastatus

API Name dbschemastatus
Description Retrieves DB schema deployment status.
REST Methods GET
Precondition oradb instance must be available.
Input Params agentHostName,jdeHome,instanceName
Sample Request http://host:port/manage/mgmtrestservice/dbschemastatus?agentHostName=BKALLERI-IN.oradev.jdedwards.com&jdeHome=D:\jde_agent_1\SCFHA&instanceName=ora109
Return HTTP status 201 returned.
Sample Response  
Exception None..

1.3.3.11 pathcodes

API Name pathcodes
Description Retrieves all the deployed pathcodes for the respective

Enterprise Server instance.

REST Methods GET
Precondition Agent must be running.
Input Params agentHostName, jdeHome,instanceName
Sample Request http://dnptvm09.jdedwards.com:8999/manage/mgmtrestservice/pathcodes?agentHostName=dnptvm09.jdedwards.com&jdeHome=/u01/jde_agent_ent/SCFHA&instanceName=ent790
Return ["DV","PY"]
Sample Response  
Exception Throws an exception if the operation fails for any reason.

1.3.3.12 targettype

API Name targettype
Description Gets the target type of a Managed Instance.
REST Methods GET
Precondition Agent must be running.
Input Params instanceName
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/targettype?instanceName=HTML_8890
Return String - targetType
Sample Response { "instanceName": "PS_JAS_7114", "targetType": "webserver"}
Exception Throws an exception if the change component operation fails for any reason.

1.3.3.13 instancestate

API Name instancestate
Description Gets the state of Managed instance.
REST Methods GET
Precondition Agent must be running.
Input Params instanceName
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/instancestate?instanceName=HTML_8890
Return String - instanceState
Sample Response { "instanceName": "PS_JAS_7114", "instanceState": "STOPPED"}
Exception Throws an exception if the change component operation fails for any reason.

1.3.3.14 consolecomponents

API Name consolecomponents
Description Gets the Managed Components on the SM Console.
REST Methods GET
Precondition  
Input Params  
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/consolecomponents
Return Set of managedComponents with information about each component such as targetType, componentName, version, and platform.
Sample Response { "managedComponentsSet": [ { "targetType": "agentInstallers", "componentName": "agentPackage7.jar", "version": "7", "platform": "windows,os400,aix,hpux,hpia64,solaris,linux" }, { "targetType": "rteserver", "componentName": "E1_TransactionServer_9.2.0.5_05-13-2016_01_19.jar", "version": "9.2.0.5", "platform": "windows,os400,aix,hpux,hpia64,solaris,linux" }, { "targetType": "rteserver", "componentName": "E1_TransactionServer_9.2.0.4_05-18-2016_06_04.jar", "version": "9.2.0.4", "platform": "windows,os400,aix,hpux,hpia64,solaris,linux" }, { "targetType": "depserver", "componentName": "9.2.0.5.Release.DS.Win32_06-08-2016_09_23.jar", "version": "9.2.0.5", "platform": "windows" }, { "targetType": "depserver", "componentName": "9.2.0.4.Debug.DS.Win32_05-18-2016_07_26.jar", "version": "9.2.0.4", "platform": "windows" } ]}
Exception Throws Exception if for any reason the operation fails.

1.3.3.15 agentcomponents

API Name agentcomponents
Description Gets the Managed Components on the particular Server Manager Agent.
REST Methods GET
Precondition Agent must be running.
Input Params agentHostName, jdeHome
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/agentcomponents?agentHostName=den60207jems.jdedwards.com&jdeHome=/slot/ems17481/oracle/jde_agent/SCFHA
Return Set of managedComponents with information about each component such as targetType, componentName, version, and platform.
Sample Response { "agentHostName": "den00kni.jdedwards.com", "jdeHome": "C:\\jde_home_kni_1\\SCFHA", "managedComponentsSet": [ { "targetType": "rteserver", "componentName": "E1_TransactionServer_9.2.0.5_05-13-2016_01_19.jar", "version": "9.2.0.5" }, { "targetType": "depserver", "componentName": "9.2.0.5.Release.DS.Win32_06-08-2016_09_23.jar", "version": "9.2.0.5" }, { "targetType": "rteserver", "componentName": "E1_TransactionServer_9.2.0.4_05-18-2016_06_04.jar", "version": "9.2.0.4" } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.3.16 smcsecurityserverconf

API Name smcsecurityserverconf
Description Gets the security server and port used by Server Manager Console.
REST Methods GET
Precondition None
Input Params None
Sample Request

http://host:port/manage/mgmtrestservice/smcsecurityserverconf

Return HTTP status 200 returned.
Sample Response { "result": [ "den00xlk.jdedwards.com", "6010" ]}
Exception Throws an exception if the operation fails for any reason .

1.3.3.17 dbschemaflags

API Name dbschemaflags
Description Retrieves all the DB Schema flags.
REST Methods GET
Precondition oradb instance must be available.
Input Params agentHostName,jdeHome,instanceName
Sample Request http://host:port/manage/mgmtrestservice/dbschemaflags?agentHostName=BKALLERI-IN.oradev.jdedwards.com &jdeHome=D:\jde_agent_1\SCFHA&instanceName=ora109
Return HTTP status 200 returned.
Sample Response  
Exception None.

1.3.3.18 deploydbschema

API Name deploydbschema
Description Deploys additional schemas.
REST Methods POST
Precondition oradb instance must be available
Input Params  
Sample Request {"instanceName" : "ora100","agentHostName" : "JDE-BRIJESH-2.compute-jdeidcdev.oraclecloud.internal","targetType" : "oradb","jdeHome" : "/u01/jde_agent_1/SCFHA", "oradbInstance" : { "oradbSchema" : { "oraPRIST" : true }, "oradbDemoSchema" : { "oraPRISTDEMO" : true } } }
Return HTTP status 201 returned.
Sample Response  
Exception None.

1.3.3.19 getinstanceaccessinfo (Release 9.2.2.2)

API Name getinstanceaccessinfo
Description Gets the access configuration information of the managed instance.
REST Methods GET
Precondition Agent must be running
Input Params instanceName
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/ getinstanceaccessinfo?instanceName=HTML_8890
Return

HTTP Status 200 Returned

Sample Response { "instanceName": " HTML_8890", "result": { "port": "8890", "sslEnabled": "false", "hostNameOrIP": " den60207jems.jdedwards.com ", "fullyQualifiedDomainName": " den60207jems.jdedwards.com " }}
Exception None

1.3.4 REST APIs for Manage and Update Operations

This section contains the details of the REST APIs used for management and update operations.

1.3.4.1 startinstance

API Name startinstance
Description Starts all the managed instances within a Server Manager Console.
REST Methods POST
Precondition Agent must be running.
Input Params instanceName
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/startinstanc{"instanceName" : "HTML_8890"}
Return HTTP status 200 returned.
Sample Response  
Exception Throws exception in case of problems.

1.3.4.2 stopinstance

API Name stopinstance
Description Stops any managed instance.
REST Methods POST
Precondition Agent must be running.
Input Params instanceName
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/stopinstance{"instanceName" : "HTML_8890"}
Return HTTP status 200 returned.
Sample Response  
Exception Throws exception incase of problems.

1.3.4.3 startallinstances

API Name startallinstances
Description Starts all the managed instances within a Server Manager Console.
REST Methods POST
Precondition targetType can be set to allwebserver to start only the Web Targets. Else all managed targets will be started.
Input Params  
Sample Request {"targetType" : "allwebserver",} This is optional, only required to start only the Web Instances, else every managed target will be started.
Return HTTP status 200 returned.
Sample Response  
Exception Response.Status.INTERNAL_SERVER_ERROR

1.3.4.4 stopallinstances

API Name stopallinstances
Description Stops all the managed instances within a Server Manager Console.
REST Methods POST
Precondition targetType can be set to allwebserver to stop only the Web Targets. Else all managed targets will be stopped.
Input Params  
Sample Request {"targetType" : "allwebserver",} This is optional, only required to stop the Web Instances, else every managed target will be stopped.
Return HTTP status 200 returned.
Sample Response  
Exception Response.Status.INTERNAL_SERVER_ERROR

1.3.4.5 stopwlsserver

API Name stopwlsserver
Description Stops the J2ee container within a WebLogic Server instance.
REST Methods POST
Precondition Agent must be running.
Input Params wlsInstanceName, wlsDomainName, wlsServerName
Sample Request {"wlsInstanceName": "JAS_9001","wlsDomainName": "E1_domain","wlsServerName": "J2EE_JAS_9001"}http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/stopwlsserver
Return HTTP status 200 returned.
Sample Response  
Exception Throws an exception if it is not possible to stop the J2ee container for any reason.

1.3.4.6 startwlsserver

API Name startwlsserver
Description Starts the J2ee container within a WebLogic Server instance.
REST Methods POST
Precondition Agent must be running.
Input Params wlsInstanceName, wlsDomainName, wlsServerName
Sample Request {"wlsInstanceName": "wls12c3_ems17481","wlsDomainName": "E1_domain","wlsServerName": "Testapi"}http://den60207jems.jdedwards.com :9182/manage/mgmtrestservicestartwlsserver
Return HTTP status 200 returned.
Sample Response  
Exception Throws an exception if it is not possible to stop the J2ee container for any reason.

1.3.4.7 updateagent

API Name updateagent
Description Updates the selected Managed Home component to the new version.
REST Methods POST
Precondition Agent must be running
Input Params agentHostName, jdeHome
Sample Request {"agentHostName" : "den60207jems.jdedwards.com ","jdeHome" : "/slot/ems17481/oracle/jde_agent/SCFHA"}http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/updateagent
Return HTTP status 200 returned.
Sample Response  
Exception Throws an exception if the operation fails for any reason.

1.3.4.8 updateallagents

API Name updateallagents
Description Updates all the required Managed Homes to new version.
REST Methods POST
Precondition Agent must be running.
Input Params  
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/updateallagents
Return HTTP status 200 returned.
Sample Response  
Exception Throws an exception if the operation fails for any reason.

1.3.4.9 updateIniconfig

API Name updateIniconfig
Description Updates INI config through JSON for any E1 Instances such as HTML, RTE, AIS, ENTERPRISE, BSSV servers, and so on.
REST Methods POST
Precondition Agent must be running.
Input Params instanceName , sectionName, iniConfig
Sample Request http://den60207jems.jdedwards.com :9182/manage/mgmtrestservice/updateiniconfig
Return Updated INI config section is returned.
Sample Response  
Exception None.

1.3.4.10 updatejdesystem

API Name updatejdesystem
Description Runs the final wiring script to update the hostname/ip/port for different servers like SMC/ENT/DEP/JAS/BSSV/AIS/BIP.

Note. This API can be used for cloud provisioning only.

REST Methods POST
Precondition oradb instance must be available.
Input Params  
Sample Request {"instanceName" : "ora100","agentHostName" : "JDE-BRIJESH-2.compute-jdeidcdev.oraclecloud.internal","targetType" : "oradb","jdeHome" : "/u01/jde_agent_1/SCFHA", "jdeSystemHostInfo" : { "jdeAdfPrt":"7071", "jdeAisIp":"192.168.1.2", "jdeAisNam":"testais", "jdeAisPrt":"7070", "jdeDbNam":"testdb", "jdeDpNam":"testdp", "jdeEntNam":"testent", "jdeJasNam":"testjas", "jdeJasIp":"192.168.1.2", "jdeJasPrt":"80", "jdeOvrIp":"192.168.1.2", "jdeOvrNam":"testovr", "jdeOvrPrt":"97101", "jdeSmNam":"testsmc", "jdeWlsAdminPass":"test123" }}
Return HTTP status 200 returned.
Sample Response  
Exception Response.Status.INTERNAL_SERVER_ERROR

1.3.4.11 updatesmcsecurityserver

API Name updatesmcsecurityserver
Description Updates security server and port used by the Server Manager Console.
REST Methods POST
Precondition Agent must be running.
Input Params securityServerName, securityServerPort
Sample Request { "securityServerName" : "den00kmx.jdedwards.com", "securityServerPort" : "6017"}http://host:port/manage/mgmtrestservice/updatesmcsecurityserver
Return HTTP status 200 returned.
Sample Response  
Exception Throws an exception if the operation fails for any reason.

1.3.4.12 updatemultijdesystem (Release 9.2.1.2)

API Name updatemultijdesystem
Description Updates the E1 tables such as OCM,DSM,and so on to work with multiple ENT and JAS servers.
REST Methods POST
Precondition  
Input Params instanceName

agentHostName

targetType

jdeHome

jdeAdfPrt

jdeAisIp

jdeAisNam

jdeAisPrt

jdeDbNam

jdeDpNam

jdeEntNam

jdeJasNam

jdeJasIp

jdeJasPrt

jdeOvrIp

jdeOvrNam

jdeOvrPrt

jdeSmNam

jdeWlsAdminPass

jdeAddEntNam

jdeAddEntPathCode

jdeAddEntObjType

jdeAddJasNam

jdeAddJasPrt

jdeAddEntPrt

jdeChgdbHost jdeChgdbPathcode

jdeChgdbTns

Sample Request {"instanceName" : "compute_v1","agentHostName" : "den00ugh","targetType" : "oradb","jdeHome" : "/u01/jde_agent_1/SCFHA", "jdeSystemHostInfo" : { "jdeAdfPrt":"7071", "jdeAisIp":"", "jdeAisNam":"", "jdeAisPrt":"7070", "jdeDbNam":"", "jdeDpNam":"", "jdeEntNam":"", "jdeJasNam":"", "jdeJasIp":"", "jdeJasPrt":"", "jdeOvrIp":"", "jdeOvrNam":"", "jdeOvrPrt":"", "jdeSmNam":"", "jdeWlsAdminPass":"", "jdeAddEntNam" : "", "jdeAddEntPathCode" :" ", "jdeAddEntObjType" : "", "jdeAddJasNam" : "jdehtml1310-wls-1A", "jdeAddJasPrt":"8001", "jdeAddEntPrt":"6012,6013", "jdeChgdbHost":"test1,test2", "jdeChgdbPathcode":"DV920,PD920", "jdeChgdbTns":"tns1,tns2" }}
Return

HTTP Status 200 Returned

Sample Response  
Exception Response.Status.INTERNAL_SERVER_ERROR

1.3.4.13 updateinstanceaccessinfo (Update 9.2.2.2)

API Name updateinstanceaccessinfo
Description Updates the access configuration information of the managed instance.
REST Methods POST
Precondition Agent must be running.
Input Params  
Sample Request {"instanceName" : " HTML_8890","sslEnabled" : "false","port":8890,"hostNameOrIP" : " den60207jems.jdedwards.com ","fullyQualifiedDomainName" : " den60207jems.jdedwards.com"}
Return HTTP status 204 returned.
Sample Response  
Exception None.

1.3.5 REST APIs for Runtime Metrics (Tools Update Release 9.2.2)

This section contains the details of the REST APIs used for runtime metrics.

1.3.5.1 instanceinfometric

API Name instanceinfometric
Description Displays the instance uptime and online users' information for HTML, AIS, and RTE server. Additionally it will also display the user login status for the HTML server.
REST Methods GET
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request  
Return HTTP status 200 returned.
Sample Response Standalone (responses…){ "instanceInformation": { "totalOnlineUsers": "0", "nodesInformation": [ { "nodeName": "singleton", "instanceUptime": "20 hours, 3 minutes", "onlineUsers": "0", "userLoginStatus": "Enabled" } ] }}Cluster{ "instanceInformation": { "totalOnlineUsers": "0", "nodesInformation": [ { "nodeName": "VC_MS1", "instanceUptime": "19 hours, 48 minutes", "onlineUsers": "0" }, { "nodeName": "VC_MS2", "instanceUptime": "19 hours, 48 minutes", "onlineUsers": "0" } ] }}
Exception Throws an exception if the operation fails for any reason.

1.3.5.2 javamemoryusage

API Name javamemoryusage
Description Displays the Java memory usage data for HTML, AIS, and RTE server.
REST Methods GET
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request  
Return HTTP status 200 returned.
Sample Response Standalone{ "javaMemoryUsage": [ { " nodeName ": "singleton", "heapMemoryUsed": "146627000", "committedHeapMemory": "911736832", "maximumAllowedMemory": "954728448" } ]}Cluster{ "javaMemoryUsage": [ { " nodeName ": "VC_MS1", "heapMemoryUsed": "106951784", "committedHeapMemory": "157810688", "maximumAllowedMemory": "239075328" }, { " nodeName ": "VC_MS2", "heapMemoryUsed": "107283504", "committedHeapMemory": "142606336", "maximumAllowedMemory": "239075328" } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.5.3 callobjectstats

API Name callobjectstats
Description Displays the call object statistics of the HTML server.
REST Methods GET
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request  
Return HTTP status 200 returned.
Sample Response { "callObjectStats": [ { "enterpriseServer": "DEN00MBX:6017", "businessFunctionName": "[init-remote-env]", "totalInvocations": "1", "firstTime": "849", "averageTime": "849", "shortestTime": "849", "longestTime": "849", "totalTime": "0", "timeoutErrors": "0", "appErrors": "0", "sysErrors": "0" }]}
Exception Throws an exception if the operation fails for any reason.

1.3.5.4 jdbjpooledconnections

API Name jdbjpooledconnections
Description Displays the details of JDBj Pooled Database connections of the HTML web server.
REST Methods GET
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request  
Return HTTP status 200 returned.
Sample Response { "instanceName": "JasVohs8009", "jdbjPooledDatabaseConnections": { "totalPooledConnections": "30", "jdbjPooledDbConnectionList": [ { "webserver": "JasVohs8009_MS1", "jdbjConnectionURL": "JDEORCL_SY920", "pooledDbConnectionCount": "5" }, { "webserver": "JasVohs8009_MS1", "jdbjConnectionURL": "jdeorcl_SY920", "pooledDbConnectionCount": "5" }, { "webserver": "JasVohs8009_MS1", "jdbjConnectionURL": "jdeorcl_PY920", "pooledDbConnectionCount": "5" }, { "webserver": "JasVohs8009_MS1", "jdbjConnectionURL": "jdeorcl_JDE", "pooledDbConnectionCount": "5" }, { "webserver": "JasVohs8009_MS1", "jdbjConnectionURL": "jdeorcl_OL920", "pooledDbConnectionCount": "5" }, { "webserver": "JasVohs8009_MS1", "jdbjConnectionURL": "jdeorcl_DD920", "pooledDbConnectionCount": "5" } ] }}
Exception Throws an exception if the operation fails for any reason.

1.3.5.5 rungc

API Name rungc
Description Executes the garbage collection, and clears up the HEAP memory used for the given instance.
REST Methods DELETE
Precondition Server Manager and Agent must be running.
Input Params instanceName
Sample Request { "instanceName" : "AIS_VC8001"}
Return HTTP status 200 returned.
Sample Response { "instanceName": "JAS_OEL", "javaMemoryUsage": [ { "BEFORE-heapMemoryUsed": "198448816", "AFTER-HeapMemoryUsed": "55078512" } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.5.6 updateloglevel

API Name updateloglevel
Description Enables the user to change the log level of the logs present in the given instance. It will also execute the synchronizing task for JAS, AIS, Orchestrator, and ADF instances.
REST Methods POST
Precondition Server Manager and Agent must be running.
Input Params instanceName, logginLevel, logName.
Sample Request {"instanceName" : "Jas_7501","loggingLevel" : "APP""logName" : "E1LOG"}Valid Log Level Values: SEVERE, WARN, APP, DEBUGTarget types not having this Metric: jdbcserver
Return HTTP status 200 returned.
Sample Response  
Exception Throws an exception if the operation fails for any reason.

1.3.5.7 jdbjdatabasecaches

API Name jdbjdatabasecaches
Description Displays the JDBj Database caches for the given HTML instance.
REST Methods GET
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request  
Return HTTP status 200 returned.
Sample Response { "instanceName": "jasVC", "jdbjDatabaseCachesDetail": [ { "nodeId": "JAS_MS2", "cacheName": "JDBj Service Cache", "cacheHitRatio": "0.0", "cacheSize": "0", "cacheAccesses": "0", "cacheHits": "0", "cacheMisses": "0" }, { "nodeId": "JAS_MS2", "cacheName": "Data Dictionary Glossary Text", "cacheHitRatio": "0.0", "cacheSize": "0", "cacheAccesses": "0", "cacheHits": "0", "cacheMisses": "0" }, ]}
Exception Throws an exception if the operation fails for any reason.

1.3.5.8 clearjdbjdatabasecaches

API Name clearjdbjdatabasecaches
Description Clears the JDBj Database cache(s) for the given HTML instance.
REST Methods DELETE
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request { "instanceName" : "jasVC", "jdbjDatabaseCacheName" : "ALL","nodeId" : "JAS_MS2"}

Valid Cache Names: "ALL", "Data Dictionary Glossary Text", "Data Dictionary Alpha Cache", "Row Column Cache", "JDBj Security Cache", "JDBj Service Cache", "JDBj OCM Cache", "Serialized Objects", "Menu Cache"

Note: nodeId key value in the request body is required only for clustered instances. Multiple cache name values can be given with comma separated valid cache names.

Return HTTP status 200 returned.
Sample Response  
Exception Throws an exception if the operation fails for any reason.

1.3.5.9 cleardatacache (Release 9.2.3.4)

API Name cleardatacache
Description Provides the functionality to clear Form Extension, Personalized Form and Search Group caches in case of an HTML server. Clears Orchestration and Notification, Form Service and Data Service, and Read Data caches in the case of an AIS server.
REST Methods DELETE
Precondition Server Manager Console must be running.

Managed AIS and HTML server instances must be running.

Managed AIS and HTML server runtime metrics should be working.

Input Params instanceName - Name of the Managed Instance

or

targetType - Target Type of the Managed Instance (either the REST server for the AIS server or the webserver for the HTMLserver)

Sample Request { "instanceName" : "xxxx_yyyy"OR"targetType" : "webserver or restserver"}
Return HTTP OK or HTTP FORBIDDEN (no body).
Sample Response  
Exception Throws an exception if the managed instance is not running or if the managed instance name is not valid. Check the Server Manager Console, AIS server or HTML server logs for more details. When you run the managed instances by using the targetType, ensure that the preconditions are met for each of the managed instances of REST server or webserver against which the API is run.

1.3.5.10 entserverinstanceinfo

API Name entserverinstanceinfo
Description Provides the instance information for the Enterprise Server.
REST Methods GET
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request  
Return HTTP status 200 returned.
Sample Response { "instanceName": "rajespybl0905", "entServerInstanceInfoDetail": [ { "instanceUptime": "23 days, 17 hours, 57 minutes", "networkJobs": "6", "kernelJobs": "11", "zombieProcesses": "0", "securityKernelUsers": "0", "callObjectUsers": "0", "instanceLevelCPU": "0", "intanceLevelMemory": "4789" } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.5.11 entserverprocessmetric

API Name entserverprocessmetric
Description Provides detailed information of all the processes of Enterprise Server. Connected users tag in the response will be shown only for Call Object and Security Kernel processes as other process types doesn't have this information.
REST Methods GET
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request  
Return HTTP status 200 returned.
Sample Response { "instanceName": "rajespybl0905", "entServerProcessMetricDetail": [{ "generalInformation": { "processName": "SECURITY KERNEL", "processType": "Kernel Process", "rangeIndex": "3", "processId": "22892", "processIndex": "6", "startTime": "6/4/17 3:30 AM", "lastMessageTime": "6/6/17 10:31 AM", "messagesReceived": "51163", "outstandingRequests": "0", "parentProcessId": "2176", "iSeriesJobNumber": "0", "processUserId": "1001", "osGroupId": "1002", "osUsername": "jde920", "osStatus": "1", "memory": "182", "cpu": "0", "threads": "1", "jdeCaches": "0", "totalOpenJDBTransactions": "3", "manualOpenJDBTransactions": "0", "dataPointers": "0", "tablesOrViews": "7", "jdbTableCaches": "0", "databaseConnections": "1" }, "connectedUsers": [ { "userName": "JDE", "originatingMachine": "rajespybl0905", "signOnTime": "6/ 6/2017 10:29:46", "originatingProcessId": "12205", "originatingProcessName": "CALL OBJECT KERNEL" } ], "threadDetail": { "threadId": "-175184128", "threadIndex": "6", "threadName": "MAIN_THREAD" } },
Sample Response { "generalInformation": { "processName": "CALL OBJECT KERNEL", "processType": "Kernel Process", "rangeIndex": "5", "processId": "12205", "processIndex": "17", "startTime": "6/6/17 5:49 AM", "lastMessageTime": "6/6/17 10:31 AM", "messagesReceived": "4386", "outstandingRequests": "0", "parentProcessId": "2059", "iSeriesJobNumber": "0", "processUserId": "1001", "osGroupId": "1002", "osUsername": "jde920", "osStatus": "1", "memory": "305", "cpu": "0", "threads": "7", "jdeCaches": "0", "totalOpenJDBTransactions": "24", "manualOpenJDBTransactions": "0", "dataPointers": "0", "tablesOrViews": "0", "jdbTableCaches": "7", "databaseConnections": "5" }, "connectedUsers": [ { "userName": "JDE", "operatingMachine": "rajweb2205.compute-a473400.oraclecloud.internal", "environment": "JPY920", "signOnTime": "6/ 6/2017 10:29:46", "lastActiveTime": "6/ 6/2017 10:30:00", "jdeCaches": "0", "totalOpenJdbTransaction": "24", "manualOpenJdbTransaction": "0", "dataPointers": "0" } ], "threadDetail": { "threadId": "-378537152", "threadIndex": "17", "threadName": "SYS:Response Msg Listener" } } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.5.12 cleartablecache

API Name cleartablecache
Description Provides the feature to clear table cache for ES. User can clear single table cache, multiple table cache or even ALL table caches.
REST Methods DELETE
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request {"tableName" : "F0113","environmentName" : "JDV920"}

Note: Entering the tableName and environmentName as "ALL" will clear all table caches.

Return HTTP status 200 returned.
Sample Response { "tableName": "ALL", "environmentName": "ALL", "clearTableCache": [ { "instanceName": "rajespdbl0905", "status": "SUCCESS", "statusMessage": "Cleared table cache with success." }, { "instanceName": "rajespybl0905", "status": "SUCCESS", "statusMessage": "Cleared table cache with success." } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.5.13 configsummary

API Name configsummary
Description Provides detailed information of the configuration INIs for the given instance.
REST Methods GET
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request  
Return HTTP status 200 returned.
Sample Response { "instanceName": "aisStand7505", "configurationSummary": [ { "description": "Display Environment", "group": "Display Information", "iniSection": "BASIC CONFIG", "name": "DisplayEnvironment", "value": "false" }, { "description": "Display Role", "group": "Display Information", "iniSection": "BASIC CONFIG", "name": "DisplayRole", "value": "false" } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.5.14 useractivity

API Name useractivity
Description Provides the detailed information of the logged in users for HTML, AIS and Enterprise Server. This API fetches the details of all the users if an input value is not provided
REST Methods GET
Precondition Server Manager and Agent must be running.
Input Params  
Sample Request {{protocol}}://{{ip}}:{{port}}/manage/mgmtrestservice/useractivity?username=JDE&environmentName=JPY920

Note: User can give multiple username and environment in the request URL with comma separated values.

Return  
Sample Response { "userActivityDetail": [ { "userName": "JDE", "targetType": "EnterpriseOne AIS Server Sessions", "instanceName": "ais8003", "jvmNodeId": "-", "jasSessionId": "4129547715806897956", "clientDevice": "Chrome (196.15.23.36)", "environmentName": "JPY920", "userRole": "*ALL", "loginTime": "6/16/17 9:14 AM", "lastActiveTime": "6/16/17 9:14 AM", "jasServer": "https://jdewebraj01:8001" }, { "userName": "JDE", "targetType": "EnterpriseOne HTML Server Sessions", "instanceName": "html8001", "jvmNodeId": "html8001_MS1", "htmlServerSessionId": "3950964184071149568", "clientMachine": "jdewebraj01.compute-a473400.oraclecloud.internal (10.16.117.142)", "environmentName": "JPY920", "userRole": "SYSADMIN", "loginTime": "6/16/17 9:14 AM", "idleTime": "63", "remoteEnvironments": "RAJESPYBL0905:6017 PID: 18181" },
Sample Response { "userName": "JDE", "targetType": "EnterpriseOne HTML Server Sessions", "instanceName": "html8001", "jvmNodeId": "html8001_MS1", "htmlServerSessionId": "4980954325618865152", "clientMachine": "idc-blr-proxy-fw1-v60-itr.oracle.com (196.15.23.36)", "environmentName": "JPY920", "userRole": "SYSADMIN", "loginTime": "6/16/17 9:14 AM", "idleTime": "57", "remoteEnvironments": "RAJESPYBL0905:6017 PID: 20612" }, { "userName": "JDE", "targetType": "Enterprise Server Resources", "instanceName": "rajespybl0905", "processName": "SECURITY KERNEL", "processID": "11709", "jdelogFileSize": "1,728", "debugLogSize": "92", "activeUsers": "1" }, { "userName": "JDE", "targetType": "Enterprise Server Resources", "instanceName": "rajespybl0905", "processName": "CALL OBJECT KERNEL", "processID": "20612", "jdelogFileSize": "1,110", "debugLogSize": "92", "activeUsers": "1" } ]}
Exception Throws an exception if the operation fails for any reason.

1.3.6 REST APIs for Health Check (Tools Update Release 9.2.2)

This section contains the details of the REST APIs used for health check.

1.3.6.1 health

API Name health
Description Provides the health check summary of the instances.
REST Methods POST
Precondition Server Manager and Agent must be running.
Input Params instanceName
Sample Request { "instanceName" : "Give_instace_Name"}Example 2:{"targetType": "webserver"}

Example: Health Check on All servers registered on the particular Host{"agentHostName" : "den00ktt.us.jdedwards.com"}Example: Health Check on based on Server Group{"serverGroup":"default"}Example: Health Check on all servers registered on this Server MangerSend Empty request or {}

Return Throws an exception if the operation fails for any reason.
Sample Response Sample example for HTML Server Health Check response:{ "reportType": "Health Status for JDE Instances", "instanceHealths": [ { "instanceName": "smagenttestHtml", "healthStatus": "Passed", "instanceHealthChecks": [ { "HealthCheckName": "Login", "Result": "Passed" }, { "HealthCheckName": "Interactive App", "Result": "Passed" }, { "HealthCheckName": "UBE", "Result": "Passed" }, { "HealthCheckName": "OVR", "Warning": "OVR not configured", "Result": "Passed" } ], "targetType": "webserver", "executedOn": "11 Aug 2017 12:32:16 GMT", "instanceStatus": "RUNNING", "healthCheckUser": "JDE", "healthCheckEnv": "JDV920" } ]}
Exception Throws an exception if the operation fails for any reason.