This article contains a list of REST API commands that pertain to IBM MQ processes.
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.
|
Jump ahead: |
Search Processes
GET /ibmmq/processes
Purpose: Finds a process (on a specific node and queue manager, if specified).
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/ibmmq/processes?nodeName=LEUNAME&qmgrName=LEUNAME&attributes=%2A" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
[
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "LEUNAME",
"name": "SYSTEM.DEFAULT.PROCESS",
"uri": "/rest/v1/ibmmq/processes/LEUNAME/LEUNAME/SYSTEM.DEFAULT.PROCESS",
"general": {
"description": "Test Description option for Multiple",
"applId": "App123",
"applType": "WINDOWS NT",
"qsgDisp": "QMgr"
},
"extended": {
"userData": "",
"envData": ""
},
"state": {
"lastUpdated": 1644509962000,
"alterDate": "2021-11-18",
"alterTime": "23.43.30"
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": []
},
"customProperties": {}
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "LEUNAME",
"name": "Test.New.process.Options11",
"uri": "/rest/v1/ibmmq/processes/LEUNAME/LEUNAME/Test.New.process.Options11",
"general": {
"description": "Description For Process",
"applId": "Process123",
"applType": "WINDOWS NT",
"qsgDisp": "QMgr"
},
"extended": {
"userData": "",
"envData": ""
},
"state": {
"lastUpdated": 1644509962000,
"alterDate": "2021-09-09",
"alterTime": "06.47.30"
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": []
},
"customProperties": {}
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "LEUNAME",
"name": "Test.New.process121",
"uri": "/rest/v1/ibmmq/processes/LEUNAME/LEUNAME/Test.New.process121",
"general": {
"description": "Test Process",
"applId": "Test12",
"applType": "WINDOWS NT",
"qsgDisp": "QMgr"
},
"extended": {
"userData": "",
"envData": ""
},
"state": {
"lastUpdated": 1644509962000,
"alterDate": "2021-09-09",
"alterTime": "06.39.01"
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": []
},
"customProperties": {}
}
]
Read Process Data
GET /ibmmq/processes/{nodeName}/{qmgrName}/{processName}
Purpose: Lists the properties of a specified process on the specified node and queue manager.
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/ibmmq/processes/LEUNAME/LEUNAME/SYSTEM.DEFAULT.PROCESS?attributes=%2A" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "LEUNAME",
"name": "SYSTEM.DEFAULT.PROCESS",
"uri": "/rest/v1/ibmmq/processes/LEUNAME/LEUNAME/SYSTEM.DEFAULT.PROCESS",
"general": {
"description": "Test Description option for Multiple",
"applId": "App123",
"applType": "WINDOWS NT",
"qsgDisp": "QMgr"
},
"extended": {
"userData": "",
"envData": ""
},
"state": {
"lastUpdated": 1644509962000,
"alterDate": "2021-11-18",
"alterTime": "23.43.30"
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": []
},
"customProperties": {}
}
Read MQ Object Authority Records
GET /ibmmq/processes/{nodeName}/{qmgrName}/{processName}/auth-recs
Purpose: Lists authority records for the process.
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/ibmmq/processes/LEUNAME/QA/SYSTEM.DEFAULT.PROCESS/auth-recs" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
{
"authRecs": [
{
"objectType": "process",
"objectName": "SYSTEM.DEFAULT.PROCESS",
"principalName": "jsmith@TEST",
"auths": [
"chg",
"dlt",
"dsp",
"inq",
"set"
]
},
{
"objectType": "process",
"objectName": "SYSTEM.DEFAULT.PROCESS",
"groupName": "mqm@LEUNAME",
"auths": [
"chg",
"dlt",
"dsp",
"inq",
"set"
]
}
],
"overallCompletionCode": 0,
"overallReasonCode": 0
}