| |
Options |
Name |
Purpose |
|
|
|
CHARACTER AddAgent (character)
|
/* Add (start) a new MSAgent for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Add-a-multi-session-agent.html
@param character ABL Application Name
@return character Returned status as text */
|
|
|
|
OpenEdge.ApplicationServer.Util.OEManagerConnection Build (character, character, integer, character, character)
|
/* Creates a client connection using a valid URI
@param character Scheme
@param character Host
@param integer Port
@param character Username for Basic Auth
@param character Password for Basic Auth
@return OEManagerConnection */
|
|
|
|
OpenEdge.ApplicationServer.Util.OEManagerConnection Build (URI)
|
/* Creates a client connection using a valid URI
@param URI Server Uri with credentials for Basic Auth
@return OEManagerConnection */
|
|
|
|
CreateClient ()
|
/* Create the HttpClient and Credentials objects for this connection. */
|
|
|
|
Progress.Json.ObjectModel.JsonObject DeleteData (character)
|
/* Perform a termination action against the PAS instance; a valid URL
with all parameters must be passed in (excluding the server instance)
@param character RESTful API endpoint URL
@return JsonObject Data returned from server */
|
|
|
|
Progress.Json.ObjectModel.JsonObject FlushDeferredLog (character, integer)
|
/* Write any accumulated deferred log data of an MSAgent for an ABL Application to the configured output file
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Flush-deferred-log-buffer-to-agent-log-file.html
@param character ABL Application Name
@param integer Agent Process ID (PID)
@return JsonObject Object as server response */
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetAgentManagerProperties (character)
|
/* Get all the agent manager properties for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Get-agent-configuration-properties.html
@param character ABL Application Name
@return JsonObject Object with AgentManager properties */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetAgentMetrics (character, integer)
|
/* Get available agent metrics for an ABL Application
@param character ABL Application Name
@param integer Agent Process ID (PID)
@return JsonArray Object with agent metrics */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetAgents (character)
|
/* Get a listing of available MSAgents for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/List-agents.html
@param character ABL Application Name
@return JsonArray Array of MSAgent information */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetAgentSessions (character, integer)
|
/* Get a listng of agent (ABL) sessions for a single agent of an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Get-session-metrics.html
@param character ABL Application Name
@param integer Agent Process ID (PID)
@return JsonArray Array of ABL Sessions */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetAgentSessionStacks (character, integer, character)
|
/* Get the runtime stack information about a session of an MSAgent for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Dump-a-session-stack.html
@param character ABL Application Name
@param integer Agent Process ID (PID)
@param character Client Session ID (alphanumeric)
@return JsonArray Array of MSAgent information */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetAgentSessionStacks (character, integer, integer)
|
/* Get the runtime stack information about a session of an MSAgent for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Dump-a-session-stack.html
@param character ABL Application Name
@param integer Agent Process ID (PID)
@param integer ABL Session ID (numeric)
@return JsonArray Array of MSAgent information */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetAgentStacks (character, integer)
|
/* Get the runtime stack information about an MSAgent for an ABL Application
@param character ABL Application Name
@param integer Agent Process ID (PID)
@return JsonArray Array of MSAgent information */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetAgentThreads (character, integer)
|
/* Get a listing of agent (ABL) threads for an ABL Application;
Useful for calculating the lifetime of an ABLSession from its start time
@param character ABL Application Name
@param integer Agent Process ID (PID)
@return JsonArray Array of MSAgent threads */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetApplications ()
|
/* Get a listing of ABL Applications for a PAS instance
https://docs.progress.com/bundle/pas-for-openedge-reference/page/List-ABL-application-information.html
@return JsonArray Array of ABL Application information */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetClientSessions (character)
|
/* Get a listing of client (HTTP) sessions for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Get-session-information.html
https://docs.progress.com/bundle/pas-for-openedge-management/page/About-session-and-request-states.html
@param character ABL Application Name
@return JsonArray Array of client sessions */
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetData (character)
|
/* Perform a request for information from the PAS instance; a valid URL
with all parameters must be passed in (excluding the server instance)
@param character RESTful API endpoint URL
@return JsonObject Data returned from server */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetDynamicSessionLimit (character, integer)
|
/* Get a listing of session info (incl. the dynamic session limit) for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Get-dynamic-session-limit.html
@param character ABL Application Name
@param integer Agent Process ID (PID)
@return JsonArray Array of session information */
|
|
|
|
CHARACTER GetOpOutcome (JsonObject)
|
/* Return the operation outcome from a standard JSON response
@param JsonObject Server's JSON response
@return character Status as text */
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetSessionManagerProperties (character)
|
/* Get all the session manager properties for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Get-configuration-properties.html
@param character ABL Application Name
@return JsonObject Object with SessionManager properties */
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetSessionMetrics (character)
|
/* Get metrics about the session manager which comes from the collectMetrics flag
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Get-runtime-metrics.html
@param character ABL Application Name
@return JsonObject Abject of session metrics */
|
|
|
|
LogCommand (character, character)
|
/* Write a server command (Verb+URL) to the commands.log file
@param character Action or HTTP Verb
@param character Command bound for the OEManager webapp */
|
|
|
|
Progress.Json.ObjectModel.JsonObject MakeRequest (MethodEnum, character)
|
/* Perform a request to the PAS instance; expects an HTTP verb and valid URL
where all parameters must be passed in (excluding the server instance).
This handles various error conditions which may occur when attempting
to reach the server or obtain the expected status or JSON results.
@param MethodEnum HTTP Method (Verb)
@param character RESTful API endpoint URL
@return JsonObject Data returned from server */
|
|
|
|
Progress.Json.ObjectModel.JsonObject PostData (character)
|
/* Perform an update action against the PAS instance; a valid URL
with all parameters must be passed in (excluding the server instance)
@param character RESTful API endpoint URL
@return JsonObject Data returned from server */
|
|
|
|
Progress.Json.ObjectModel.JsonObject RefreshAgent (character, character)
|
/* Trigger a refresh (termination) of all sessions of an MSAgent for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Refresh-all-ABL-sessions-of-one-or-all-agents.html
@param character ABL Application Name
@param character Agent ID (alphanumeric)
@return JsonObject Object as server response */
|
|
|
|
Progress.Json.ObjectModel.JsonObject ResetAgentStats (character, integer)
|
/* Clear (reset) any accumulated agent stat data of an MSAgent for an ABL Application
@param character ABL Application Name
@param integer Agent Process ID (PID)
@return JsonObject Object as server response */
|
|
|
|
Progress.Json.ObjectModel.JsonObject ResetDeferredLog (character, integer)
|
/* Clear (reset) any accumulated deferred log data of an MSAgent for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Reset-deferred-log-buffer.html
@param character ABL Application Name
@param integer Agent Process ID (PID)
@return JsonObject Object as server response */
|
|
|
|
Progress.Json.ObjectModel.JsonObject StopAgent (character, character, character, character)
|
/* Stop (terminate) a single MSAgent for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Stop-a-multi-session-agent.html
@param character ABL Application Name
@param character Internal Agent ID (alphanumeric)
@param character Time to wait (ms) for current request to finish
@param character Time to wait (ms) after the current request
@return JsonObject Object as server response */
|
|
|
|
Progress.Json.ObjectModel.JsonObject TerminateAblSession (character, integer, integer, integer)
|
/* Terminate an agent (ABL) session for an ABL Application
@param character ABL Application Name
@param integer Agent Process ID (PID)
@param integer ABL Session ID (numeric)
@param integer Termination option [0-2]
@return JsonObject Object as server response */
|
|
|
|
Progress.Json.ObjectModel.JsonObject TerminateClientSession (character, integer, character)
|
/* Terminate a client (HTTP) session for an ABL Application
https://docs.progress.com/bundle/pas-for-openedge-reference/page/Terminate-a-session.html
@param character ABL Application Name
@param integer Termination option [0-2]
@param character Client Session ID (alphanumeric)
@return JsonObject Object as server response */
|