System Web Services

Universal Controller supports the following RESTful-based web services for system operations, which are listed alphabetically on this page

• Retrieve System Details

Formatting specifications for each web service, including details about parameter requirements, are provided.

Retrieve System Details

	Description
URI	http://host_name/uc/resources/status
HTTP Method	GET
Description	Retrieves Universal Controller system status/information.
Example URI	http://localhost:8080/uc/resources/status
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	See Retrieve System Details: Example Response, below.

Retrieve System Details: Example Response

JSON

JSON Response

JSON Response

{
  "build": "build.190",
  "buildDate": "08-31-2020_1026",
  "databaseConnections": "Server (0/5) Client (0/5) Reserved (0/2)",
  "databaseName": "qa_con_mysql",
  "databaseType": "MySQL",
  "databaseURL": "jdbc:mysql://qa-db007.stone.branch/",
  "license": ">[Distributed Agents: 3/3] [z/OS Agents: 2/2] [Expiry Date: 2020-05-14 [Days: 45]] [UPPS: true] [USAP: true] [Customer: Pre 6.9 License Migrated.]",
  "licenseExpired": false,
  "memoryFree": "806.90 MB (79.19%)",
  "memoryMaximum": "1019.00 MB",
  "memoryUsed": "212.10 MB (20.81%)",
  "nodeId": "qa-con-mysql.stone.branch:8080-qa_con_mysql",
  "nodeMode": "Active",
  "nodeTime": "2020-11-08 14:09:54 -0400 (America/New_York)",
  "nodeUptime": "7 Days 19 Hours 57 Minutes 41 Seconds",
  "release": "6.9.0.0"
}

XML

XML Response

XML Response

<status>
	<build>build.190</build>
	<buildDate>08-31-2020_1026</buildDate>
	<databaseConnections>Server (0/5) Client (0/5) Reserved (0/2)</databaseConnections>
	<databaseName>qa_con_mysql</databaseName>
	<databaseType>MySQL</databaseType>
	<databaseURL>jdbc:mysql://qa-db007.stone.branch/</databaseURL>
	<license>>[Distributed Agents: 3/3] [z/OS Agents: 2/2] [Expiry Date: 2020-12-14 [Days: 45]] [UPPS: true] [USAP: true] [Customer: Pre 6.9 License Migrated.]</license>
	<licenseExpired>false</licenseExpired>
	<memoryFree>806.90 MB (79.19%)</memoryFree>
	<memoryMaximum>1019.00 MB</memoryMaximum>
	<memoryUsed>212.10 MB (20.81%)</memoryUsed>
	<nodeId>qa-con-mysql.stone.branch:8080-qa_con_mysql</nodeId>
	<nodeMode>Active</nodeMode>
	<nodeTime>2020-11-08 14:09:54 -0400 (America/New_York)</nodeTime>
	<nodeUptime>7 Days 19 Hours 57 Minutes 41 Seconds</nodeUptime>
	<release>6.9.0.0<release>
</status>

Retrieve System Details Properties

The System Details properties match the fields on the System Details widget which displays, by default, on the Universal Controller Home dashboard.

Property	UI Field Name	Description
build	Build	Build number for this version of the Controller.
buildDate	Build Date	Date when this build was created.
databaseConnections	Database Connections	Information on the database connections required for Universal Controller to execute an SQL task or a Stored Procedure Task.
databaseName	Database Name	Name of the database used by this Controller.
databaseType	DatabaseType	Type of database used by this Controller.
databaseURL	Database URL	URL of the database used by this Controller.
license	License	License information for the Universal Controller: Distributed Agents z/OS Agents Expiry Date Tasks Monthly Executions Cluster Nodes UPPS USAP Customer Environment
licenseExpired	n/a	Indication (true or false) that your Universal Controller license has expired.
memoryFree	Memory Free	Amount of memory available for use by this Controller.
memoryMaximum	Memory Maximum	Maximum amount of memory for this Controller.
memoryUsed	Memory Used	Amount of memory currently being used by this Controller.
nodeId	Node Id	URL of the Controller.
nodeMode	Node Mode	Current mode of the Controller. Valid values: Active Passive Offline
nodeTime	Node Time	Time of day on the Controller when the details were retrieved.
nodeUptime	Node Uptime	Amount of time the Controller has been running.
release	Release	Release level of the Controller.