1. REST API for Server Manager Guide
  2. usersession/sendMessage

usersession/sendMessage

API Name

 usersession/sendMessage

Description

Performs passed action on passed instance information for passed database drivers.

Note: This API will send the passed message to passed session Id. please make sure passed session Id is valid and at least one open active app.

REST Methods

 POST

Precondition

 Server Manager Console must be running.

Input Params

TOKEN: Header returned as a response to the /authenticate Server Manager REST API Call.

TOKEN: Cookie returned as a response to the /authenticate Server Manager REST API Call.

AUTHORIZATION: Base64 encoded Basic username:password combination necessary for Authentication.

message: The Message which needs to be sent to passed instance and session Id.

instanceName: The Managed Instance Name.

sessionId: Session Id where the message needs to be sent.

agentHostName: The Agent Host Name for instance.

jdeHome: The Agent jde Home for instance.

Sample Request

curl --location --request POST 'https://ems4296.ad1.fusionappsdphx1.oraclevcn.com:9016/manage/mgmtrestservice/usersession/sendMessage?instanceName=tqa_926_lnx_jas_ems4071_24696&agentHostName=ems4071.ad1.fusionappsdphx1.oraclevcn.com&jdeHome=%2Fslot%2Fems15587%2Foracle%2Fjde_agent_web%2FSCFHA&sessionId=3444851491212081152&message=test%20message' \

--header 'Authorization: Basic amRlX2FkbWluOmpkZV9hZG1pbg==' \

--header 'Cookie: SMCONSOLE_SSID=hQYVbQ7QV6yijlvwdozJikopOYGc3SIZLApgfJgDrkaqq6hKx55_!-688809719'

Return

 HTTP status 200 is returned.

Sample Response

 NA

Exception

302: Found the Managed Instance with the passed in Instance Name.

404: Unable to find the Managed Instance with the passed in Instance Name.

403: Forbidden Status Code is returned if the Authentication information passed with the Request is not valid.