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 API Name
REST API Description
Authenticates the user. Returns a TOKEN value in the Response Header which is used to perform subsequent different operations.
Extends the lifetime of the above created TOKEN by 30 minutes. You must pass a valid TOKEN for the same.
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.
Changes the password of the individual schemas or the database user.
Changes password of the Server Manager Console.
Updates the managed instance component to a new version.
Updates the managed instance component to a new version for 64-bit. (Release 9.2.3)
Updates the managed instance component to a new version for 64-bit. (Release 9.2.4)
Updates the managed instance component to a new version for 64-bit. (Release 9.2.6)
Updates the managed instance component to a new version for 64-bit. (Release 9.2.7.0)
Retrieves the deployed or the current deploying DB schema component name.
Changes the locally stored password of the database instance to a new password.
Retrieves the deployed or the current deploying DB schema component name.
REST API Name
REST API Description
Creates the EnterpriseOne instance. For example, HTML, RTE, AIS, ENTERPRISE, and BSSV Servers.
Registers an existing Deployment Server instance.
Registers an existing Enterprise Server instance.
Deletes any managed instance.
Registers a WebLogic Server instance.
Uploads software components to the Server Manager Console.
Distributes the managed component from the Server Manager Console to any of the Server Manager Agent.
Creates a J2EE container within a WebLogic Server instance.
Deletes a J2EE container within a WebLogic Server instance.
Deploys the path code.
Gets INI config in JSON format for any of the EnterpriseOne instances such as HTML, RTE, AIS, ENTERPRISE, BSSV servers, and so on.
Generates and gets the sitekey used by the security server and the port used by the Server Manager Console.
Encrypts any textual data passed to this API.
Decrypts any textual data passed to this API.
Creates JDE schema on DBCS or Compute DB.
Creates a WebLogic domain, starts the node manager, and creates a machine that is in a reachable state.
Deletes the deployed schemas from an ORADB instance.
Retrieves current status for a previous call to dbdeleteschema.
Creates an ADF Server instance.
Creates an Orchestrator Studio Server instance.
Creates an MS SQL DB instance.
Creates an IBM i DB instance.
Returns information about the server for the WebLogic managed instance within the Server Manager Console.
Checks if the managed instance with the passed 'Instance Name' exists within the Server Manager Console.
Creates JDE schema on an Autonomous DB instance in Oracle Cloud Infrastructure.
REST API Name
REST API Description
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.
Provides information about server group including server group names, members, and description.
Retrieves information for all the Managed Homes.
Returns information about a particular agent.
Gets information about each managed instance created in the Server Manager Console.
Returns unknown state for the instances that are under the offline agent.
Lists the domains in a particular WebLogic Server instance.
Gets information about the WebLogic Server.
Gets information about the clusters in the WebLogic server.
Retrieves the app version of the deployed path code.
Retrieves the deployment status of the DB schema.
Retrieves all the path codes deployed for the respective
Enterprise Server instance.
Gets the target type of a managed instance.
Gets the state of the managed instance.
Gets the managed components on the Server Manager Console.
Gets the managed components on a particular Server Manager Agent.
Gets the security server and the port used by Server Manager Console.
Retrieves all of the DB schema flags.
Deploys additional schemas.
Gets the access configuration information of the managed instance.
Returns information about a particular agent.
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
Starts all the managed instances within a Server Manager Console.
Stops any managed instance.
Starts all the managed instances within a Server Manager Console.
Stops all the managed instances within a Server Manager Console.
Stops the J2ee container within a WebLogic Server instance.
Starts the J2ee container within a WebLogic Server instance.
Updates the selected Managed Home component to the new version.
Updates all the required Managed Homes to new version.
Updates INI config through JSON for any EnterpriseOne instances such as HTML, RTE, AIS, ENTERPRISE, BSSV servers, and so on.
Runs the final wiring script to update the hostname/ip/port for different servers such as SMC, ENT, DEP, JAS, BSSV, AIS, and BIP.
Updates security server and port used by the Server Manager Console.
Updates the EnterpriseOne tables such as OCM, DSM, and so on to work with multiple ENT and JAS servers.
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
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.
Displays the Java memory usage data of the HTML, AIS, and RTE servers.
Displays the call object statistics of the HTML server.
Displays the details of the JDBj Pooled Database connections of the HTML server.
Executes the garbage collection, and clears up the HEAP memory used for the given instance.
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.
Displays the JDBj Database caches for the given HTML instance.
Clears the JDBj Database caches for the given HTML instance.
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.
Provides instance information of the Enterprise Server.
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.
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.
Provides detailed information about the configuration INIs for a given instance.
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
Provides a health check summary of the instances.
-
REST APIs for Centralized Configuration (Tools Update Release 9.2.7)
API Name
Description
Saves the configuration for e1central.properties file.
- REST APIs for TLS Automation (Tools Update Release 9.2.8)
API Name Description Uploads the certificate and keyStore files to Server Manager Console and its running Agents.
Validates the trustStore and keyStore files with the provided passwords.
Applies the TLS configuration to Server Manager Console and its running Agents. Also, restarts the Server Manager Console and Agents.
Gets the TLS configuration information.
- REST APIs for Server Manager Server Group (Tools Update Release 9.2.8)
API Name Description Retrieves the server group information (Name and Description).
Creates new Server group. Returns Error if invalid group name is passed or group already exists.
Provides the list of target types and their configuration for passed server group. Provides configuration for passed target Type and passed server group. This will return the metric type equivalent to UI.
Provide the configuration and respective value for all metric type.
Updates the passed configuration to respective group, target type, and metric type if it is valid.
Deletes the server group if no instance is associated with that group.
Changes the server group for an instance.
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 Saves configuration of a particular instance.
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 Provides the database drivers information for Server Manager Console.
Uploads a database driver for Server Manager Console.
Provides the instance information for passed database driver Type for Server Manager Console.
Provides the instance information for passed database driver Type for Server Manager Console.
Performs passed action on passed instance information for passed database drivers.
Performs passed action on passed instance information for passed database drivers.
getComponentHistory Gets the Change Component history for passed instance.