Server Manager REST APIs

If you are using a Microsoft Windows based Server Manager Agent, use this input format for the jdeHome parameter: jdeHome=C:\jde_home_2\SCFHA

For example, https://jdesmc.example.com:8998/manage/mgmtrestservice/instancestate?instanceName=tqa_923_lnx_jas_jdesmc_21500&agentHostName=jdeSMAserver.example.com&jdeHome=C:\jde_home_2\SCFHA

Example Request URL: https://jdesmc.example.com:8998/manage/mgmtrestservice/updateloglevel

Example Request: {"instanceName":"tqa_923_lnx_jas_jdesmc_21500","agentHostName":"jdesma.example.com","jdeHome" : "C:\\jde_home_2\\SCFHA","loggingLevel":”APP","logName":"E1LOG"}

These tables describe the list of Server Manager REST APIs and their descriptions:

• REST APIs for Authentication

  REST API Name	REST API Description
  authenticate	Authenticates the user. Returns a TOKEN value in the Response Header which is used to perform subsequent different operations.
  refresh	Extends the lifetime of the above created TOKEN by 30 minutes. You must pass a valid TOKEN for the same.
  changewlsinstancepwd	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 WebLogic administrator account.
  changedbschemapwd	Changes the password of the individual schemas or the database user.
  changeadminpwd	Changes password of the Server Manager Console.
  changecomponent	Updates the managed instance component to a new version.
  changecomponent64 (Release 9.2.3)	Updates the managed instance component to a new version for 64-bit. (Release 9.2.3)
  changecomponent64 (Release 9.2.4)	Updates the managed instance component to a new version for 64-bit. (Release 9.2.4)
  changecomponent64 (Release 9.2.6)	Updates the managed instance component to a new version for 64-bit. (Release 9.2.6)
  changecomponent64 (Release 9.2.7.0)	Updates the managed instance component to a new version for 64-bit. (Release 9.2.7.0)
  dbschemacomponent	Retrieves the deployed or the current deploying DB schema component name.
  changedbsyspwd	Changes the locally stored password of the database instance to a new password.
  dbschemacomponent	Retrieves the deployed or the current deploying DB schema component name.

• REST APIs for Provisioning

  REST API Name	REST API Description
  createinstance	Creates the EnterpriseOne instance. For example, HTML, RTE, AIS, ENTERPRISE, and BSSV Servers.
  registerdepserver	Registers an existing Deployment Server instance.
  registerentserver	Registers an existing Enterprise Server instance.
  deleteinstance	Deletes any managed instance.
  registerwls	Registers a WebLogic Server instance.
  uploadcomponent	Uploads software components to the Server Manager Console.
  distributecomponent	Distributes the managed component from the Server Manager Console to any of the Server Manager Agent.
  createwlsserver	Creates a J2EE container within a WebLogic Server instance.
  deletewlsserver	Deletes a J2EE container within a WebLogic Server instance.
  deploypathcode	Deploys the path code.
  iniconfig	Gets INI config in JSON format for any of the EnterpriseOne instances such as HTML, RTE, AIS, ENTERPRISE, BSSV servers, and so on.
  gensmcsitekey	Generates and gets the sitekey used by the security server and the port used by the Server Manager Console.
  encr	Encrypts any textual data passed to this API.
  decr	Decrypts any textual data passed to this API.
  createoradbinstance (Release 9.2.1.2)	Creates JDE schema on DBCS or Compute DB.
  createweblogicdomain (Release 9.2.1.2)	Creates a WebLogic domain, starts the node manager, and creates a machine that is in a reachable state.
  dbdeleteschema (Release 9.2.1.2)	Deletes the deployed schemas from an ORADB instance.
  dbdeleteschemastatus (Release 9.2.1.2)	Retrieves current status for a previous call to dbdeleteschema.
  createadfinstance (Release 9.2.1.2)	Creates an ADF Server instance.
  createorchinstance (Release 9.2.1.2)	Creates an Orchestrator Studio Server instance.
  createmssqldbinstance (Release 9.2.2)	Creates an MS SQL DB instance.
  createdb2dbinstance (Release 9.2.2.4)	Creates an IBM i DB instance.
  wlsinstanceserversinfo	Returns information about the server for the WebLogic managed instance within the Server Manager Console.
  instanceexist	Checks if the managed instance with the passed 'Instance Name' exists within the Server Manager Console.
  createautonomousdb (Release 9.2.5.3)	Creates JDE schema on an Autonomous DB instance in Oracle Cloud Infrastructure.

• REST APIs for Monitoring

  REST API Name	REST API Description
  homesupdatestatus	Gets the status of the Managed Homes on the Server Manager Console. Response includes information about Managed Home that requires an update or if it is already updated.
  servergroupinfo	Provides information about server group including server group names, members, and description.
  homesinfo	Retrieves information for all the Managed Homes.
  agentinfo	Returns information about a particular agent.
  instancesinfo	Gets information about each managed instance created in the Server Manager Console. Returns unknown state for the instances that are under the offline agent.
  wlsdomaininfo	Lists the domains in a particular WebLogic Server instance.
  wlsserverinfo	Gets information about the WebLogic Server.
  wlsclustersinfo	Gets information about the clusters in the WebLogic server.
  applicationversion	Retrieves the app version of the deployed path code.
  dbschemastatus	Retrieves the deployment status of the DB schema.
  pathcodes	Retrieves all the path codes deployed for the respective Enterprise Server instance.
  targettype	Gets the target type of a managed instance.
  instancestate	Gets the state of the managed instance.
  consolecomponents	Gets the managed components on the Server Manager Console.
  agentcomponents	Gets the managed components on a particular Server Manager Agent.
  smcsecurityserverconf	Gets the security server and the port used by Server Manager Console.
  dbschemaflags	Retrieves all of the DB schema flags.
  deploydbschema	Deploys additional schemas.
  getinstanceaccessinfo (Release 9.2.2.2)	Gets the access configuration information of the managed instance.
  agentinfo (Release 9.2.8.2)	Returns information about a particular agent.
  weblogicinfo (Release 9.2.8.2)	Returns information about a particular weblogic server.
  weblogicdomaininfo (Release 9.2.8.2)	Returns information about a weblogic domains which are configured in the middleware.

• REST APIs for Manage and Update Operations

  REST API Name	REST API Description
  startinstance	Starts all the managed instances within a Server Manager Console.
  stopinstance	Stops any managed instance.
  startallinstances	Starts all the managed instances within a Server Manager Console.
  stopallinstances	Stops all the managed instances within a Server Manager Console.
  stopwlsserver	Stops the J2ee container within a WebLogic Server instance.
  startwlsserver	Starts the J2ee container within a WebLogic Server instance.
  updateagent	Updates the selected Managed Home component to the new version.
  updateallagents	Updates all the required Managed Homes to new version.
  updateIniconfig	Updates INI config through JSON for any EnterpriseOne instances such as HTML, RTE, AIS, ENTERPRISE, BSSV servers, and so on.
  updatejdesystem	Runs the final wiring script to update the hostname/ip/port for different servers such as SMC, ENT, DEP, JAS, BSSV, AIS, and BIP.
  updatesmcsecurityserver	Updates security server and port used by the Server Manager Console.
  updatemultijdesystem (Release 9.2.1.2)	Updates the EnterpriseOne tables such as OCM, DSM, and so on to work with multiple ENT and JAS servers.
  updateinstanceaccessinfo (Update 9.2.2.2)	Updates the access configuration information of the managed instance.

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

  REST API Name	REST API Description
  instanceinfometric	Displays the instance uptime and online users' information of the HTML, AIS, and RTE servers. Additionally, it will also display the user login status for the HTML server.
  javamemoryusage	Displays the Java memory usage data of the HTML, AIS, and RTE servers.
  callobjectstats	Displays the call object statistics of the HTML server.
  jdbjpooledconnections	Displays the details of the JDBj Pooled Database connections of the HTML server.
  rungc	Executes the garbage collection, and clears up the HEAP memory used for the given instance.
  updateloglevel	Enables the user to change the log level of the logs present in the given instance. It will also execute the synchronizing task for the JAS, AIS, Orchestrator, and ADF instances.
  jdbjdatabasecaches	Displays the JDBj Database caches for the given HTML instance.
  clearjdbjdatabasecaches	Clears the JDBj Database caches for the given HTML instance.
  cleardatacaches (Release 9.2.3.4)	Provides the functionality to clear Form Extension, Personalized Form, and Search Group caches for the HTML server. In case of an AIS server, it clears orchestration and notification, form service and data service, and read data caches.
  entserverinstanceinfo	Provides instance information of the Enterprise Server.
  entserverprocessmetric	Provides detailed information of all the processes of the Enterprise Server. Connected users who are tagged in the response will be shown only for Call Object and Security Kernel processes because other process types do not have this information.
  cleartablecache	Provides feature to clear table cache for the Enterprise Server. The user can choose to clear single cache, multiple table cache, or even caches for all the tables.
  configsummary	Provides detailed information about the configuration INIs for a given instance.
  useractivity	Provides detailed information about the logged-in users of the HTML, AIS, and the Enterprise servers.

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

  API Name	Description
  health	Provides a health check summary of the instances.

• REST APIs for Centralized Configuration (Tools Update Release 9.2.7)

  API Name	Description
  saveCentraizedConfiguration	Saves the configuration for e1central.properties file.

• REST APIs for TLS Automation (Tools Update Release 9.2.8)

  API Name	Description
  uploaddistributecert	Uploads the certificate and keyStore files to Server Manager Console and its running Agents.
  validatetlsconfig	Validates the trustStore and keyStore files with the provided passwords.
  applytlsconfigandrestart	Applies the TLS configuration to Server Manager Console and its running Agents. Also, restarts the Server Manager Console and Agents.
  gettlsconfiginfo	Gets the TLS configuration information.

• REST APIs for Server Manager Server Group (Tools Update Release 9.2.8)

  API Name	Description
  servergroupinfo	Retrieves the server group information (Name and Description).
  servergroupinfo	Creates new Server group. Returns Error if invalid group name is passed or group already exists.
  servergroupinfo/{serverGroupName}	Provides the list of target types and their configuration for passed server group.
  servergroupinfo/{serverGroupName}/{targetType}	Provides configuration for passed target Type and passed server group. This will return the metric type equivalent to UI.
  servergroupinfo/{serverGroupName}/{targetType}/metricType	Provide the configuration and respective value for all metric type.
  servergroupinfo/{serverGroupName}/{targetType}	Updates the passed configuration to respective group, target type, and metric type if it is valid.
  servergroupinfo/{serverGroupName}	Deletes the server group if no instance is associated with that group.
  servergroupinfo/{serverGroupName}	Changes the server group for an instance.
  copySMCSecurityServerSitekey	Copies Sitekey from the Server Manager Console's Security Server to the target Instance.

• REST APIs for Server Manager Save and Restore Configuration (Tools Update Release 9.2.8.2)

  API Name	Description
  saveInstanceConfiguration	Saves configuration of a particular instance.
  listinstanceconfiguration	Retrieves list of saved configuration for an instance in the Server Manager Console.
  downloadinstanceconfiguration	Downloads the saved configuration of an instance in the Server Manager Console.
  restoreinstanceconfiguration	Restores configuration of a particular instance for a given configuration file name.
  deleteinstanceconfiguration	Deletes the configuration of a particular instance for the provided configuration file name.
  uploadconfiguration	Uploads or imports configuration to an existing instance.

• REST APIs for Server Manager Console Driver Update (Tools Update Release 9.2.8.2)

  API Name	Description
  databasedrivers	Provides the database drivers information for Server Manager Console.
  databasedrivers	Uploads a database driver for Server Manager Console.
  databasedrivers/{databaseDriver Type}	Provides the instance information for passed database driver Type for Server Manager Console.
  databasedrivers/{databaseDriver Type}	Provides the instance information for passed database driver Type for Server Manager Console.
  databasedrivers/{databaseDriver Type}	Performs passed action on passed instance information for passed database drivers.
  usersession/sendMessage	Performs passed action on passed instance information for passed database drivers.
  getComponentHistory	Gets the Change Component history for passed instance.
  usersession/sessiondetails	Gets the session details for passed instance.
  usersession/terminatehtmlsession	Terminates passed session from passed server instance.

• REST APIs for Server Manager User Log Configuration (Tools Update Release 9.2.9)

  API Name	Description
  logs/userlogconfiguration	Gets all log configuration for logged in user.
  logs/userlogconfiguration	Deletes log configuration for logged in user.
  logs/userlogconfiguration	Creates a new log configuration for logged in user.
  logs/userlogconfiguration	Updates user specific log for passed user.
  logs/logFiles	Gets the log file details for logged in user.
  logs/logFiles/deletelogFiles	Deletes the passed log file if logged in user has permission to delete that file.
  logs/logFiles/download	Downloads the passed log file if logged in user has right access.
  usergroups	Creates passed User Group.
  usergroups	Gets the list of User Groups available in the system.
  usergroups/{userGroup}	Deletes the specified User Group.
  usergroups/{userGroup}	Gets the permission of passed Group.
  users	Gets the list of EnterpriseOne users.
  users/{user}	Deletes the passed user.
  users/{user}	Adds a new user in Server Manager Console.
  usergroups/{userGroup}/permission/{action}	Updates the passed permission in for that group.
  usergroups/{userGroup}/users/grantPermission/	Assigns userGroup to the user.
  usergroups/{userGroup}/permission/revokePermission	Removes the user group assigned to a user.
  importUsers	Imports the new changes in Server Manager Console.