This article contains a list of REST API commands that pertain to the workgroup server.
For a walk-through of the Navigator REST API using the demo site, see Using the REST API using the Navigator demo system. No installation is required. The article Performing REST API operations using the Swagger UI includes three detailed examples, as well as instructions for issuing plain text or JSON-formatted MQSC Commands through the REST API.
Read Workgroup Server Data
GET /manager
Purpose: Lists attributes of the Workgroup Server.
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/manager?attributes=%2A" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
{ "name": "MQM", "identity": { "nodeName": "us-east-2.compute.internal", "portNumber": 4010, "version": "10.4.0.0", "wgsVersion": 923, "platform": "UNIX", "alias": "", "description": "" }, "discovery": { "ipNetwork": "0.0.0.0", "ipPortNumber": 5010, "discoveryTimer": 1440, "refreshInterval": 10, "inclAuthRecs": "Disabled", "fullDiscOnConn": "On", "newObjEventsOnFullDisc": "Off" }, "extended": { "traceMode": "Disabled", "traceFlags": 0, "traceAgent": "Disabled", "uidToUpper": "On", "bufferSize": 0, "tcpNoDelay": "Off", "reuseAddr": "On", "keepAlive": "Off", "jobApproveReq": "Yes", "sheduleEnabled": "Yes" }, "limit": { "eventDepth": 1000, "acctDepth": 5000, "statDepth": 5000, "auditDepth": 0, "pendingCmdLimit": 15000, "maxClients": 200, "maxNodes": 100, "maxQMgrsNode": 50, "maxBrowse": 10000, "maxSuppConns": 32767 }, "state": { "lastUpdated": 1640941375000, "state": "Active", "processId": 18147, "authorization": "Disabled", "clientConns": 1, "agentConns": 12, "startTime": 1640941375000, "eventCounter": 46802, "lastAction": 0, "lastEventTime": 1630325809000, "discoveryTime": 30, "licenceExp": 1653019200000, "osInformation": "Linux Version: 3.10.0-1127.19.1.el7.x86_64, Architecture: amd64, Virt.machine: OpenJDK 64-Bit Server VM v.11 11.0.2+9", "dbInfo": "DBMS: Oracle; VER: Oracle Database 18c Express Edition Release 18.0.0.0.0 - Production; DRVR: Oracle JDBC driver; VER: 11.2.0.4.0", "portStatus": "LISTENING" } }
Search Workgroup Server Events
GET /manager/events
Purpose: List Workgroup Server events (of a particular type, if specified).
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/manager/events?eventType=QMgr" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response (partial)
[
{
"wgsName": "MQM",
"type": "QMgr",
"eventNo": 977,
"uri": "/rest/v1/events/QMgr/977",
"general": {
"eventTimeStamp": 1640943901000,
"nodeName": "LEUNAME",
"qmgrName": "Nastel1234"
},
"diagnostic": {
"eventIdentifier": 20017,
"userId": "",
"eventTime": 45166,
"reasonQualifier": 0,
"origUserId": "",
"objectName": ""
},
"extended": {
"eventDescription": "",
"command": 0,
"msgPutDate": "20211131",
"msgPutTime": "09450100"
},
"qmgr": {
"applType": "NO CONTEXT",
"applName": "",
"baseQName": "",
"objectQmgrName": "",
"xmitQName": "",
"adminTopicNames": "",
"topicString": "",
"baseType": "None",
"openOptions": 0,
"subOptions": 0
}
},
{
"wgsName": "MQM",
"type": "QMgr",
"eventNo": 976,
"uri": "/rest/v1/events/QMgr/976",
"general": {
"eventTimeStamp": 1640943901000,
"nodeName": "LEUNAME",
"qmgrName": "Nastel1234"
},
"diagnostic": {
"eventIdentifier": 20011,
"userId": "",
"eventTime": 45166,
"reasonQualifier": 0,
"origUserId": "",
"objectName": ""
},
"extended": {
"eventDescription": "",
"command": 0,
"msgPutDate": "",
"msgPutTime": ""
},
"qmgr": {
"applType": "NO CONTEXT",
"applName": "",
"baseQName": "",
"objectQmgrName": "",
"xmitQName": "",
"adminTopicNames": "",
"topicString": "",
"baseType": "None",
"openOptions": 0,
"subOptions": 0
}
},
{
"wgsName": "MQM",
"type": "QMgr",
"eventNo": 975,
"uri": "/rest/v1/events/QMgr/975",
"general": {
"eventTimeStamp": 1640942597000,
"nodeName": "LEUNAME",
"qmgrName": "EMIK"
},
"diagnostic": {
"eventIdentifier": 20017,
"userId": "",
"eventTime": 46470,
"reasonQualifier": 0,
"origUserId": "",
"objectName": ""
},
"extended": {
"eventDescription": "",
"command": 0,
"msgPutDate": "20211131",
"msgPutTime": "09231600"
},
"qmgr": {
"applType": "NO CONTEXT",
"applName": "",
"baseQName": "",
"objectQmgrName": "",
"xmitQName": "",
"adminTopicNames": "",
"topicString": "",
"baseType": "None",
"openOptions": 0,
"subOptions": 0
}
}
]