Namespace "wmq"
Using bmm/wmq/Admin, you can script the management of IBM MQ based objects, including queues, channels, topics, processes, listeners, etc. While scripting management of IBM MQ objects can be simple and easy using the MainView Middleware Administrator IBM MQ API, you must still understand the IBM MQ object properties which you want to specify. This can be made easier by reading and understanding AttrDefs.xml that comes with MainView Middleware Administrator. AttrDefs contains a schema for all possible properties of IBM MQ objects. For instance, it contains specifications for properties of Queues, Channels, Queue Managers, etc.
AttrDefs is used by the MainView Middleware Administrator user interface to aid in deciding what type of editor to be used for a value (text box vs. combo box), which values should be displayed for selection (e.g. Queue persistence allows either "Persistent" or "Not Persistent), etc.
As a scripter, you must know and understand these properties and how you specify them in your script. For instance, to specify that a queue should be persistent, you need to know the property name (DefPersistence) and that you would use the integer value 1 to specify that the queue should be persistent.
For instance:
QName: "PERSTISTENTQ",
DefPersistence: 1
});
Is an example of how you would create a new local queue with a default persistence of "persistent." The REST equivalent would be to POST this JSON to /wmq/localqueues :
"QName": "PERSISTENTQ",
"DefPersistence": 1
}
So it is required that you understand AttrDefs.
AttrDefs.xml
AttrDefs.xml is an XML file located in the etc folder of the installation directory that contains a schema for all possible properties for any type of object within IBM MQ. It is important to understand that in cases where there are "sub-types" (e.g. Channel and Queue), the properties are not broken out by sub-type.
Object types are specified in a "Type" element with the "name" attribute, e.g. here is the Type element for "Queue":
<Type name="Queue">
... Queue properties go here ...
</Type> <!-- Type name="Queue" -->
Properties of IBM MQ objects are specified in "Attribute" elements. The following example shows the Attribute element for "DefPersistence":
<Attributename="DefPersistence"
mqsc="DEFPSIST"
display="Default Persistence"
category="General"
required="false"
id="185"
indexed="true"
writable="true">
... properties of the attribute go here
</Attribute>
This section includes:
- Alias Queue Operations
- Application Connections Operations
- Authentication Information Object Operations
- Channel Authentication Record Operations
- Channel Operations
- Client Connection Channel Operations
- Cluster Operations
- Cluster Queue Operations
- Cluster Receiver Channel Operations
- Cluster Sender Channel Operations
- Communication Information Objects Operations
- Listener Operations
- Local Queue Operations
- Model Queue Operations
- MQTT Operations
- Namelist Operations
- Process Operations
- Queue Manager Operations
- Queue Operations
- Queue Handle Operations
- Receiver Channel Operations
- Remote Queue Operations
- Requester Channel Operations
- Sender Channel Operations
- Server Channel Operations
- Server Connection Channel Operations
- Service Operations
- Storage Class Operations
- Subscription Operations
- Topic Operations
- Messaging Operations
Alias Queue Operations
Get Alias Queues
REST
GET /wmq/connections/[conn]/aliasqueues?type=list
JavaScript
getAliasQueues()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all alias queues on the queue manager connection
Get Alias Queues Properties
REST
GET /wmq/connections/[conn]/aliasqueues/[?summarize=true&filter=[expr]]
JavaScript
getAliasQueuesAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all alias queues on the queue manager connection
Create Alias Queue
REST
POST o to /wmq/connections/[conn]/aliasqueues/
JavaScript
createAliasQueue(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the alias queue
Returns
None
Modify Alias Queue
REST
PUT o to /wmq/connections/[conn]/aliasqueues/[name]
JavaScript
modifyAliasQueue(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the alias queue
name – A string representing the name of the alias queue
Returns
None
Delete Alias Queue
REST
DELETE /wmq/connections/[conn]/aliasqueues/[name]
JavaScript
deleteAliasQueue(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the alias queue
Returns
None
Application Connections Operations
Get Application Connections
REST
GET /wmq/connections/[conn]/applconns?type=list
JavaScript
getApplConns()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the connection id of all application connections on the queue manager connection
Get Application Connections Properties
REST
GET /wmq/connections/[conn]/applconns/[?summarize=true&filter=[expr]]
JavaScript
getApplConnsAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all application connections on the queue manager connection
Get Application Connection Properties
REST
GET /wmq/connections/[conn]/applconns/[id]
JavaScript
getApplConnAttrs(id)
Parameters
conn – An argument specifying the connection name (REST only)
id – A connection id representing the application connection
Returns
A JavaScript object containing the attributes for the specified application connection id
Authentication Information Object Operations
Get Authentication Information Objects
REST
GET /wmq/connections/[conn]/authinfos?type=list
JavaScript
getAuthInfos()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all authentication information objects on the queue manager connection
Get Authentication Information Objects Properties
REST
GET /wmq/connections/[conn]/authinfos/[?summarize=true&filter=[expr]]
JavaScript
getAuthInfos({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all authentication information objects on the queue manager connection
Get Authentication Information Object Properties
REST
GET /wmq/connections/[conn]/authinfos/[name]
JavaScript
getAuthInfoAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – The name of the authentication information object
Returns
A JavaScript object containing the properties for the specified authentication information
Create Authentication Information Object
REST
POST o to /wmq/connections/[conn]/authinfos/
JavaScript
createAuthInfo(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the authentication information object
Returns
None
Modify Authentication Information Object
REST
PUT o to /wmq/connections/[conn]/authinfos/[name]
JavaScript
modifyAuthInfo(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the authentication information object
name – A string representing the name of the authentication information object
Returns
None
Delete Authentication Information Object
REST
DELETE /wmq/connections/[conn]/authinfos/[name]
JavaScript
deleteAuthInfo(name)
Parameters
name – A string representing the name of the authentication information object
Returns
None
Channel Authentication Record Operations
Get Channel Authentication Records Properties
REST
GET /wmq/connections/[conn]/chlauths/[?summarize=true&filter=[expr]]
JavaScript
getChannelAuths({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all channel authentication records on the queue manager connection
Get Channel Authentication Record Properties
REST
GET /wmq/connections/[conn]/chlauths/[name]
JavaScript
getChannelAuthAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the identifier of the channel authentication record in the format <profile>:<type>:<paramlist>
where <profile> - the channel profile
<type> - the numeric channel authentication record type
1 - BLOCKUSER
2 - BLOCKADDR
3 - SSLPEERMAP
4 - ADDRESSMAP
5 - USERMAP
6 - QMGRMAP
<paramlist> - a colon separated list of type-specific parameter list uniquely idenfitying the channel authentication record (for example, the Address value for a record of type ADDRESSMAP)
Returns
A JavaScript object containing the properties for the specified channel authentication record
Create Channel Authentication Record
REST
POST o to /wmq/connections/[conn]/chlauths/
JavaScript
createChannelAuth(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel authentication record
Returns
None
Modify Channel Authentication Record
REST
PUT o to /wmq/connections/[conn]/chlauths/[name]
JavaScript
modifyChannelAuth(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel authentication record
name – A string representing the name of the channel authentication record in the previously described format
Returns
None
Delete Channel Authentication Record
REST
DELETE /wmq/connections/[conn]/chlauths/[name]
JavaScript
deleteChannelAuth(name)
Parameters
name – A string representing the name of the channel authentication record in the previously described format
Returns
None
Channel Operations
Get Channels
REST
GET /wmq/connections/[conn]/channels?type=list
JavaScript
getChannels()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all channels on the queue manager connection
Get Channels Properties
REST
GET /wmq/connections/[conn]/channels/[?summarize=true&filter=[expr]]
JavaScript
getChannelsAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all channels on the queue manager connection
Get Channel Properties
REST
GET /wmq/connections/[conn]/channels/[name]
JavaScript
getChannelAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
Returns
A JavaScript object containing the properties for the specified channel on the queue manager connection
Get Channels Status
REST
GET /wmq/connections/[conn]/channels?type=status[&summarize=true&filter=[expr]]
JavaScript
getChannelsStatus({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the status for all channels on the queue manager connection
Get Channel Status
REST
GET /wmq/connections/[conn]/channels/[name]?type=status
JavaScript
getChannelStatus(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
Returns
A JavaScript object containing the status for the specified channel on the queue manager connection
Ping Channel
REST
POST o to /wmq/connections/[conn]/channels/[name]?type=status
JavaScript
pingChannel(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
o – A JSON object with the contents {"status":"ping"} (REST only)
Returns
None
Reset Channel
REST
PUT o to /wmq/connections/[conn]/channels/[name]?type=status
JavaScript
resetChannel(name, sequence)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
sequence – A number representing the new message sequence number (JavaScript only)
o – A JSON object with the contents {"status":"reset", "params":{"MsgSeqNumber":[sequence]}} (REST only)
Returns
None
Resolve Channel
REST
PUT o to /wmq/connections/[conn]/channels/[name]?type=status
JavaScript
resolveChannel(name, inDoubt)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
inDoubt – A number representing the Indoubt resolution (JavaScript only)
o – A JSON object with the contents {"status":"resolve", "params":{"InDoubt":[inDoubt]}} (REST only)
Returns
None
Start Channel
REST
PUT o to /wmq/connections/[conn]/channels/[name]?type=status
JavaScript
startChannel(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
o – A JSON object with the contents {"status":"start"} (REST only)
Returns
None
Stop Channel
REST
PUT o to /wmq/connections/[conn]/channels/[name]?type=status
JavaScript
stopChannel(name, o)
o is optional
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
o – A JSON object with the contents
status:"stop" (REST ONLY)
params:
{Mode:"", ChannelStatus: ""}
ChannelStatus 0(MQCHS_INACTIVE) | 6(MQCHS_STOPPED)
Mode 0(MQMODE_FORCE) | 1(MQMODE_QUIESCE) | 2(MQMODE_TERMINATE)
Returns
None
Client Connection Channel Operations
Create Client Connection Channel
REST
POST o to /wmq/connections/[conn]/clntconnchannels/
JavaScript
createClientConnChannel(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
Returns
None
Modify Client Connection Channel
REST
PUT o to /wmq/connections/[conn]/clntconnchannels/[name]
JavaScript
modifyClientConnChannel(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
name – A string representing the name of the channel
Returns
None
Delete Client Connection Channel
REST
DELETE /wmq/connections/[conn]/clntconnchannels/[name]
JavaScript
deleteClientConnectionChannel(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
Returns
None
Cluster Operations
Get Cluster Status
REST
GET /wmq/connections/[conn]/clusters
JavaScript
getClusterStatus()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing the cluster status of queue managers in clusters to which the queue manager connection belongs
Resume Cluster
REST
PUT o to /wmq/connections/[conn]/clusters/[name]
JavaScript
resumeCluster(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the cluster
o – A JSON object with the contents {"status":"resume"} (REST only)
Returns
None
Suspend Cluster
REST
PUT o to /wmq/connections/[conn]/clusters/[name]
JavaScript
suspendCluster(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the cluster
o – A JSON object with the contents {"status":"suspend"} (REST only)
Returns
None
Cluster Queue Operations
Get Cluster Queues
REST
GET /wmq/connections/[conn]/clusterqueues?type=list
JavaScript
getClusterQueues()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all cluster queues on the queue manager connection
Get Cluster Queues Properties
REST
GET /wmq/connections/[conn]/clusterqueues/[?summarize=true&filter=[expr]]
JavaScript
getClusterQueuesAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all cluster queues on the queue manager connection
Get Cluster Queue Properties
REST
GET /wmq/connections/[conn]/clusterqueues/[name]
JavaScript
getClusterQueueAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the cluster queue
Returns
A JavaScript object containing the properties for the specified cluster queue on the queue manager connection
Cluster Receiver Channel Operations
Create Cluster Receiver Channel
REST
POST o to /wmq/connections/[conn]/clusrcvrchannels/
JavaScript
createClusterReceiverChannel(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
Returns
None
Modify Cluster Receiver Channel
REST
PUT o to /wmq/connections/[conn]/clusrcvrchannels/[name]
JavaScript
modifyClusterReceiverChannel(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
name – A string representing the name of the channel
Returns
None
Delete Cluster Receiver Channel
REST
DELETE /wmq/connections/[conn]/clusrcvrchannels/[name]
JavaScript
deleteClusterReceiverChannel(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
Returns
None
Cluster Sender Channel Operations
Create Cluster Sender Channel
REST
POST o to /wmq/connections/[conn]/clussdrchannels/
JavaScript
createClusterSenderChannel(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
Returns
None
Modify Cluster Sender Channel
REST
PUT o to /wmq/connections/[conn]/clussdrchannels/[name]
JavaScript
modifyClusterSenderChannel(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
name – A string representing the name of the channel
Returns
None
Delete Cluster Sender Channel
REST
DELETE /wmq/connections/[conn]/clussdrchannels/[name]
JavaScript
deleteClusterSenderChannel(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
Returns
None
Communication Information Objects Operations
Get Communication Information Objects
REST
GET /wmq/connections/[conn]/comminfos?type=list
JavaScript
getCommInfos()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all communication information objects on the queue manager connection
Get Communication Information Objects Properties
REST
GET /wmq/connections/[conn]/comminfos/[?summarize=true&filter=[expr]]
JavaScript
getCommInfosAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all communication information objects on the queue manager connection
Get Communication Information Object Properties
REST
GET /wmq/connections/[conn]/comminfos/[name]
JavaScript
getCommInfoAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the communication information object
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript object containing the properties for the specified communication information object on the queue manager connection
Create Communication Information Object
REST
POST o to /wmq/connections/[conn]/comminfos/
JavaScript
createCommInfo(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the communication information object
Returns
None
Modify Communication Information Object
REST
PUT o to /wmq/connections/[conn]/comminfos/[name]
JavaScript
modifyCommInfo(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the communication information object
name – A string representing the name of the communication information object
Returns
None
Delete Communication Information Object
REST
DELETE /wmq/connections/[conn]/comminfos/[name]
JavaScript
deleteCommInfo(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the alias queue
Returns
None
Listener Operations
Get Listeners
REST
GET /wmq/connections/[conn]/listeners?type=list
JavaScript
getListeners()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all listeners on the queue manager connection
Get Listeners Properties
REST
GET /wmq/connections/[conn]/listeners/[?summarize=true&filter=[expr]]
JavaScript
getListenersAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all listeners on the queue manager connection
Get Listener Properties
REST
GET /wmq/connections/[conn]/listeners/[name]
JavaScript
getListenerAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the listener
Returns
A JavaScript object containing the properties for the specified listener on the queue manager connection
Get Listeners Status
REST
GET /wmq/connections/[conn]/listeners?type=status[&summarize=true&filter=[expr]]
JavaScript
getListenersStatus({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the status for all listeners on the queue manager connection
Get Listener Status
REST
GET /wmq/connections/[conn]/listeners/[name]?type=status
JavaScript
getListenerStatus(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the listener
Returns
A JavaScript object containing the status for the specified listener on the queue manager connection
Create Listener
REST
POST o to /wmq/connections/[conn]/listeners/
JavaScript
createListeners(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the listener
Returns
None
Modify Listener
REST
PUT o to /wmq/connections/[conn]/listeners/[name]
JavaScript
modifyListener(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the listener
name – A string representing the name of the listener
Returns
None
Delete Listener
REST
DELETE /wmq/connections/[conn]/listeners/[name]
JavaScript
deleteListener(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the listener
Returns
None
Start Listener
REST
PUT o to /wmq/connections/[conn]/listeners/[name]?type=status
JavaScript
startListener(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the listener
o – A JSON object with the contents {"status":"start"} (REST only)
Returns
None
Stop Listener
REST
PUT o to /wmq/connections/[conn]/listeners/[name]?type=status
JavaScript
stopListener(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the listener
o – A JSON object with the contents {"status":"stop"} (REST only)
Returns
None
Local Queue Operations
Get Local Queues
REST
GET /wmq/connections/[conn]/localqueues?type=list
JavaScript
getLocalQueues()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all local queues on the queue manager connection
Get Local Queues Properties
REST
GET /wmq/connections/[conn]/localqueues/[?summarize=true&filter=[expr]]
JavaScript
getLocalQueuesAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all local queues on the queue manager connection
Create Local Queue
REST
POST o to /wmq/connections/[conn]/localqueues/
JavaScript
createLocalQueue(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the local queue
Returns
None
Modify Local Queue
REST
PUT o to /wmq/connections/[conn]/localqueues/[name]
JavaScript
modifyLocalQueue(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the local queue
name – A string representing the name of the local queue
Returns
None
Delete Local Queue
REST
DELETE /wmq/connections/[conn]/localqueues/[name]
JavaScript
deleteLocalQueue(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the local queue
Returns
None
Model Queue Operations
Get Model Queues
REST
GET /wmq/connections/[conn]/modelqueues?type=list
JavaScript
getModelQueues()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all model queues on the queue manager connection
Get Model Queues Properties
REST
GET /wmq/connections/[conn]/modelqueues/[?summarize=true&filter=[expr]]
JavaScript
getModelQueuesAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all model queues on the queue manager connection
Create Model Queue
REST
POST o to /wmq/connections/[conn]/modelqueues/
JavaScript
createModelQueue(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the model queue
Returns
None
Modify Model Queue
REST
PUT o to /wmq/connections/[conn]/modelqueues/[name]
JavaScript
modifyModelQueue(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the model queue
name – A string representing the name of the model queue
Returns
None
Delete Model Queue
REST
DELETE /wmq/connections/[conn]/modelqueues/[name]
JavaScript
deleteModelQueue(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the model queue
Returns
None
MQTT Operations
Get Telemetry Channels Status
REST
GET /wmq/connections/[conn]/mqttchannels?type=status[&summarize=true&filter=[expr]]
Parameters
conn – An argument specifying the connection name
summarize:true – An optional argument specifying that a summarized list of properties should be returned
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the status for all MQTT channels on the queue manager connection
Get Telemetry Channels Properties
REST
GET /wmq/connections/[conn]/mqttchannels/[?summarize=true&filter=[expr]]
Parameters
conn – An argument specifying the connection name
summarize:true – An optional argument specifying that a summarized list of properties should be returned
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all MQTT channels on the queue manager connection
Get Channel Properties
REST
GET /wmq/connections/[conn]/mqttchannels/[name]
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
Returns
A JavaScript object containing the properties for the specified MQTT channel on the queue manager connection
Modify Telemetry Channel
REST
PUT o to /wmq/connections/[conn]/mqttchannels/[name]
Parameters
conn – An argument specifying the connection name
name – A string representing the name of the channel
Returns
None
Start Telemetry Channel
REST
PUT o to /wmq/connections/[conn]/mqttchannels/[name]?type=status
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
o – A JSON object with the contents {"status":"start"}
Returns
None
Stop Telemetry Channel
REST
PUT o to /wmq/connections/[conn]/mqttchannels/[name]?type=status
Parameters
conn – An argument specifying the connection name
name – A string representing the name of the channel
o – A JSON object with the contents {"status":"stop"}
Returns
None
Namelist Operations
Get Namelists
REST
GET /wmq/connections/[conn]/namelists?type=list
JavaScript
getNamelists()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all namelists on the queue manager connection
Get Namelists Properties
REST
GET /wmq/connections/[conn]/namelists/[?summarize=true&filter=[expr]]
JavaScript
getNamelistsAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all namelists on the queue manager connection
Get Namelist Properties
REST
GET /wmq/connections/[conn]/namelists/[name]
JavaScript
getNamelistAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the namelist
Returns
A JavaScript object containing the properties for the specified namelist on the queue manager connection
Create Namelist
REST
POST o to /wmq/connections/[conn]/namelists/
JavaScript
createNamelist(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the namelist
Returns
None
Modify Namelist
REST
PUT o to /wmq/connections/[conn]/namelists/[name]
JavaScript
modifyNamelist(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the namelist
name – A string representing the name of the namelist
Returns
None
Delete Namelist
REST
DELETE /wmq/connections/[conn]/namelists/[name]
JavaScript
deleteNamelist(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the namelist
Returns
None
Process Operations
Get Processes
REST
GET /wmq/connections/[conn]/processes?type=list
JavaScript
getProcesses()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all processes on the queue manager connection
Get Processes Properties
REST
GET /wmq/connections/[conn]/processes/[?summarize=true&filter=[expr]]
JavaScript
getProcessesAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all processes on the queue manager connection
Get Process Properties
REST
GET /wmq/connections/[conn]/processes/[name]
JavaScript
getProcessAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the process
Returns
A JavaScript object containing the properties for the specified process on the queue manager connection
Create Process
REST
POST o to /wmq/connections/[conn]/processes/
JavaScript
createProcess(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the process
Returns
None
Modify Process
REST
PUT o to /wmq/connections/[conn]/processes/[name]
JavaScript
modifyProcess(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the process
name – A string representing the name of the process
Returns
None
Delete Process
REST
DELETE /wmq/connections/[conn]/processes/[name]
JavaScript
deleteProcess(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the process
Returns
None
Queue Manager Operations
Get Queue Manager Properties
REST
GET /wmq/connections/[conn]/qmgr/
JavaScript
getQMgrAttrs()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing the properties for the queue manager associated with the queue manager connection
Get Queue Manager Status
REST
GET /wmq/connections/[conn]/qmgr?type=status
JavaScript
getQMgrStatus()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing the status for the queue manager associated with the queue manager connection
Modify Queue Manager
REST
PUT o to /wmq/connections/[conn]/qmgr/
JavaScript
modifyQMgr(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the queue manager
Returns
None
Ping Queue Manager
REST
POST o to /wmq/connections/[conn]/qmgr?type=status
JavaScript
pingQMgr()
Parameters
conn – An argument specifying the connection name (REST only)
o – A JSON object with the contents {"status":"ping"} (REST only)
Returns
None
Refresh Queue Manager
REST
PUT o to /wmq/connections/[conn]/qmgr?type=status
JavaScript
refreshQMgr(o)
Parameters
o – A JavaScript object representing the project
Returns
None
JSON fields
status: 'refresh'
RefreshType: [1|2|4] //corresponding to three types allowed
ObjectType: Integer // corresponding to IBM numeric definitions
ObjectName: String // trailing asterisks allowed for wildcard, asterisk by itself
RefreshInterval: Integer
CommandScope: String
IBM Docs on the call/parameter details: http://www.ibm.com/support/knowledgecenter/SSFKSJ_9.0.0/com.ibm.mq.ref.adm.doc/q088240_.htm
Get MQ Installation
REST
GET /wmq/connections/[conn]/qmgr/hosts/[host]/commands/dspmqinst
JavaScript
getMQInstallation()
Parameters
conn – An argument specifying the connection name (REST only)
host – An argument specifying the selected host for the connection (REST only)
Returns
A JavaScript array containing the MQ Installation parameters for the queue manager associated with the queue manager connection on the assigned host
Get MQ Version
REST
GET /wmq/connections/[conn]/qmgr/hosts/[host]/commands/dspmqver
JavaScript
getMQVersion()
Parameters
conn – An argument specifying the connection name (REST only)
host – An argument specifying the selected host for the connection (REST only)
Returns
A JavaScript array containing the MQ version information for the queue manager associated with the queue manager connection on the assigned host
Get Queue Manager Log Status
REST
GET /wmq/connections/[conn]/qmgr?type=logstatus
JavaScript
getQMgrLogStatus()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing the log status for the queue manager associated with the queue manager connection
Reset Queue Manager
REST
PUT o to /wmq/connections/[conn]/qmgr?type=status
JavaScript
resetQMgr(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the project
Returns
None
JSON fields
status: 'reset'
Action: [2|3|4|10|11] //corresponding to five action types allowed and their IBM numeric definitions
Child|Parent: String // Either child or parent queue manager for action type PubSub (4)
LogReduction: [-2|-1|1] // corresponding to three log reduction type for action type Reduce Log (10) and their IBM numeric definitions
ArchiveLog: String // archived log for action type Archive Log (11)
CommandScope: String
IBM Docs on the call/parameter details: https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.0.0/com.ibm.mq.ref.adm.doc/q088290_.html
Refresh Queue Manager Security
REST
PUT o to /wmq/connections/[conn]/qmgr?type=status
JavaScript
N/A
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the project
Returns
None
JSON fields
status: 'security'
SecurityType: [1|2|3|4] //corresponding to four security types allowed and their IBM numeric definitions
SecurityItem: [0|1|2|3|4|5|6|7|8|9|10|11] // corresponding to IBM numeric definitions
CommandScope: String
IBM Docs on the call/parameter details: https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.0.0/com.ibm.mq.ref.adm.doc/q088250_.html
Set Log
REST
PUT o to /wmq/connections/[conn]/qmgr?type=status
JavaScript
setLogQMgr(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the project
Returns
None
JSON fields
status: 'setlog'
ParameterType: 10|11 //corresponding to IBM numeric definitions and platform dependency
DeallocateInterval: Integer
LogCompression: [0|1|268435455] //corresponding to IBM numeric definitions
MaxArchiveLog: Integer
MaxConcurrentOffloads: Integer
MaxReadTapeUnits: Integer
OutputBufferCount: Integer
CommandScope: String
ArchiveLog: String
IBM Docs on the call/parameter details:
https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.0.0/com.ibm.mq.ref.adm.doc/q129110_.html
https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.0.0/com.ibm.mq.ref.adm.doc/q088400_.html
Switch Cluster Channels
REST
PUT o to /wmq/connections/[conn]/qmgr/runswchl
JavaScript
switchClusterChannels(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the project
Returns
None
JSON fields
ChannelName: String // the channel name or the channel name pattern
OptionalArgs: [‘none’|’skip’|’query’] // to skip transferring messages on switch, to only query channel state or to switch with no options
IBM Docs on the call/parameter details: https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.0.0/com.ibm.mq.ref.adm.doc/q083490_.html
Start Queue Manager
REST
PUT o to /wmq/connections/[conn]/qmgr/hosts/[host]/commands/start
JavaScript
startQMgr(host, o)
Parameters
conn – An argument specifying the connection name (REST only)
host – An argument specifying the selected host for the connection
o – A JavaScript object representing the project
Returns
None
JSON fields
Options: [‘start’|’multi’] //depending on whether starting a stand-alone or a multi-instance queue manager
Stop Queue Manager
REST
PUT o to /wmq/connections/[conn]/qmgr/hosts/[host]/commands/stop
JavaScript
stopQMgr(host, o)
Parameters
conn – An argument specifying the connection name (REST only)
host – An argument specifying the selected host for the connection
o – A JavaScript object representing the project
Returns
None
JSON fields
Options: [‘stop’|’standby’|’end_standby’] //depending on whether to stop normally, to stop and switch to the standby instance or whether to end a standby instance
Queue Operations
Get Queues
REST
GET /wmq/connections/[conn]/queues?type=list
JavaScript
getQueues()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all queues on the queue manager connection
Get Queues Properties
REST
GET /wmq/connections/[conn]/queues/[?summarize=true&filter=[expr]]
JavaScript
getQueuesAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all queues on the queue manager connection
Get Queue Properties
REST
GET /wmq/connections/[conn]/queues/[name]
JavaScript
getQueueAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the process
Returns
A JavaScript object containing the properties for the specified queue on the queue manager connection
Get Queues Status
REST
GET /wmq/connections/[conn]/queues/?type=status[&summarize=true&filter=[expr]]
JavaScript
getQueuesStatus({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the status for all queues on the queue manager connection
Get Queue Status
REST
GET /wmq/connections/[conn]/queues/[name]?type=status
JavaScript
getQueueStatus(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the process
Returns
A JavaScript object containing the status for the specified queue on the queue manager connection
Get Queues Statistics
REST
GET /wmq/connections/[conn]/queuestats/
JavaScript
getQueuesStatistics()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing the statistics for all queues on the queue manager connection
Clear Queue
REST
DELETE /wmq/connections/[conn]/queues/[name]/messages
JavaScript
clearQueue(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the queue
Returns
None
Queue Handle Operations
Get Queue Handles Status
REST
GET /wmq/connections/[conn]/queuehandles/
JavaScript
getQueueHandlesStatus()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing the status for all queue handles on the queue manager connection
Get Queue Handle Status
REST
GET /wmq/connections/[conn]/queuehandles/
JavaScript
getQueueHandleStatus(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the queue
Returns
A JavaScript object containing the status for the specified queue on the queue manager connection
Receiver Channel Operations
Create Receiver Channel
REST
POST o to /wmq/connections/[conn]/rcvrchannels/
JavaScript
createReceiverChannel(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
Returns
None
Modify Receiver Channel
REST
PUT o to /wmq/connections/[conn]/rcvrchannels/[name]
JavaScript
modifyReceiverChannel(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
name – A string representing the name of the channel
Returns
None
Delete Receiver Channel
REST
DELETE /wmq/connections/[conn]/rcvrchannels/[name]
JavaScript
deleteReceiverChannel(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
Returns
None
Remote Queue Operations
Get Remote Queues
REST
GET /wmq/connections/[conn]/remotequeues?type=list
JavaScript
getRemoteQueues()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all remote queues on the queue manager connection
Get Remote Queues Properties
REST
GET /wmq/connections/[conn]/remotequeues/[?summarize=true&filter=[expr]]
JavaScript
getRemoteQueuesAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all remote queues on the queue manager connection
Create Remote Queue
REST
POST o to /wmq/connections/[conn]/remotequeues/
JavaScript
createRemoteQueue(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the remote queue
Returns
None
Modify Remote Queue
REST
PUT o to /wmq/connections/[conn]/remotequeues/[name]
JavaScript
modifyRemoteQueue(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the remote queue
name – A string representing the name of the remote queue
Returns
None
Delete Remote Queue
REST
DELETE /wmq/connections/[conn]/remotequeues/[name]
JavaScript
deleteRemoteQueue(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the remote queue
Returns
None
Requester Channel Operations
Create Requester Channel
REST
POST o to /wmq/connections/[conn]/rqstrchannels/
JavaScript
createRequesterChannel(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
Returns
None
Modify Requester Channel
REST
PUT o to /wmq/connections/[conn]/rqstrchannels/[name]
JavaScript
modifyRequesterChannel(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
name – A string representing the name of the channel
Returns
None
Delete Requester Channel
REST
DELETE /wmq/connections/[conn]/rqstrchannels/[name]
JavaScript
deleteRequesterChannel(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
Returns
None
Sender Channel Operations
Create Sender Channel
REST
POST o to /wmq/connections/[conn]/sdrchannels/
JavaScript
createSenderChannel(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
Returns
None
Modify Sender Channel
REST
PUT o to /wmq/connections/[conn]/sdrchannels/[name]
JavaScript
modifySenderChannel(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
name – A string representing the name of the channel
Returns
None
Delete Sender Channel
REST
DELETE /wmq/connections/[conn]/sdrchannels/[name]
JavaScript
deleteSenderChannel(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
Returns
None
Server Channel Operations
Create Server Channel
REST
POST o to /wmq/connections/[conn]/svrchannels/
JavaScript
createServerChannel(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
Returns
None
Modify Server Channel
REST
PUT o to /wmq/connections/[conn]/svrchannels/[name]
JavaScript
modifyServerChannel(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
name – A string representing the name of the channel
Returns
None
Delete Server Channel
REST
DELETE /wmq/connections/[conn]/svrchannels/[name]
JavaScript
deleteServerChannel(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel
Returns
None
Server Connection Channel Operations
Create Server Connection Channel
REST
POST o to /wmq/connections/[conn]/svrconnchannels/
JavaScript
createServerConnChannel(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
Returns
None
Modify Server Connection Channel
REST
PUT o to /wmq/connections/[conn]/svrconnchannels/[name]
JavaScript
modifyServerConnChannel(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the channel
name – A string representing the name of the channel
Returns
None
Delete Server Connection Channel
REST
DELETE /wmq/connections/[conn]/svrconnchannels/[name]
JavaScript
deleteServerConnChannel(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the service
Returns
None
Service Operations
Get Services
REST
GET /wmq/connections/[conn]/services?type=list
JavaScript
getServices()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all services on the queue manager connection
Get Services Properties
REST
GET /wmq/connections/[conn]/services/[?summarize=true&filter=[expr]]
JavaScript
getServicesAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all services on the queue manager connection
Get Service Properties
REST
GET /wmq/connections/[conn]/services/[name]
JavaScript
getServiceAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the service
Returns
A JavaScript object containing the properties for the specified service on the queue manager connection
Get Services Status
REST
GET /wmq/connections/[conn]/services?type=status[&summarize=true&filter=[expr]]
JavaScript
getServicesStatus({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the status for all services on the queue manager connection
Get Service Status
REST
GET /wmq/connections/[conn]/services/[name]?type=status
JavaScript
getServiceStatus(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the service
Returns
A JavaScript object containing the status for the specified service on the queue manager connection
Create Service
REST
POST o to /wmq/connections/[conn]/services/
JavaScript
createService(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the service
Returns
None
Modify Service
REST
PUT o to /wmq/connections/[conn]/services/[name]
JavaScript
modifyService(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the service
name – A string representing the name of the service
Returns
None
Delete Service
REST
DELETE /wmq/connections/[conn]/services/[name]
JavaScript
deleteService(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the service
Returns
None
Start Service
REST
PUT o to /wmq/connections/[conn]/services/[name]?type=status
JavaScript
startService(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the service
o – A JSON object with the contents {"status":"start"} (REST only)
Returns
None
Stop Service
REST
PUT o to /wmq/connections/[conn]/services/[name]?type=status
JavaScript
stopService(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the service
o – A JSON object with the contents {"status":"stop"} (REST only)
Returns
None
Storage Class Operations
Get Storage Classes
REST
GET /wmq/connections/[conn]/storageclasses?type=list
JavaScript
getStorageClasses()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all storage classes on the queue manager connection
Get Storage Classes Properties
REST
GET /wmq/connections/[conn]/storageclasses/[?summarize=true&filter=[expr]]
JavaScript
getStorageClassesAttrs({ summarize:true,filter:[expr]})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all alias queues on the queue manager connection
Get Storage Class Properties
REST
GET /wmq/connections/[conn]/storageclasses/[name]
JavaScript
getStorageClassAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the storage class
Returns
A JavaScript object containing the properties for the specified storage class on the queue manager connection.
Create Storage Class
REST
POST o to /wmq/connections/[conn]/storageclasses/
JavaScript
createStorageClass(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the storage class
Returns
None
Modify Storage Class
REST
PUT o to /wmq/connections/[conn]/storageclasses/[name]
JavaScript
modifyStorageClass(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the storage class
name – A string representing the name of the storage class
Returns
None
Delete Storage Class
REST
DELETE /wmq/connections/[conn]/storageclasses/[name]
JavaScript
deleteStorageClass(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the storage class
Returns
None
Subscription Operations
Get Subscriptions
REST
GET /wmq/connections/[conn]/subscriptions?type=list
JavaScript
getSubscriptions()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all subscriptions on the queue manager connection
Get Subscriptions Properties
REST
GET /wmq/connections/[conn]/subscriptions/[?summarize=true&filter=[expr]]
JavaScript
getSubscriptionsAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all subscriptions on the queue manager connection
Get Subscription Properties
REST
GET /wmq/connections/[conn]/subscriptions/[name]
JavaScript
getSubscriptionAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the subscription
Returns
A JavaScript object containing the properties for the specified subscription on the queue manager connection
Get Subscriptions Status
REST
GET /wmq/connections/[conn]/subscriptions?type=status[&summarize=true&filter=[expr]]
JavaScript
getSubscriptionsStatus({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the status for all subscriptions on the queue manager connection
Get Subscription Status
REST
GET /wmq/connections/[conn]/subscriptions/[name]?type=status
JavaScript
getSubscriptionStatus(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the subscription
Returns
A JavaScript object containing the status for the specified subscription on the queue manager connection
Create Subscription
REST
POST o to /wmq/connections/[conn]/subscriptions/
JavaScript
createSubscription(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the subscription
Returns
None
Modify Subscription
REST
PUT o to /wmq/connections/[conn]/subscriptions/[name]
JavaScript
modifySubscription(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the subscription
name – A string representing the name of the subscription
Returns
None
Delete Subscription
REST
DELETE /wmq/connections/[conn]/subscriptions/[name]
JavaScript
deleteSubscription(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the subscription
Returns
None
Topic Operations
Get Topics
REST
GET /wmq/connections/[conn]/topics?type=list
JavaScript
getTopics()
Parameters
conn – An argument specifying the connection name (REST only)
Returns
A JavaScript array containing strings with the name of all topics on the queue manager connection
Get Topics Properties
REST
GET /wmq/connections/[conn]/topics/[?summarize=true&filter=[expr]]
JavaScript
getTopicsAttrs({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the properties for all topics on the queue manager connection
Get Topic Properties
REST
GET /wmq/connections/[conn]/topics/[name]
JavaScript
getTopicAttrs(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the topic
Returns
A JavaScript object containing the properties for the specified topic on the queue manager connection
Get Topics Status
REST
GET /wmq/connections/[conn]/topics?type=status[&summarize=true&filter=[expr]]
JavaScript
getTopicsStatus({
summarize:true,
filter:[expr]
})
Parameters
conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument
Returns
A JavaScript array containing the status for all topics on the queue manager connection
Get Topic Status
REST
GET /wmq/connections/[conn]/topics/[name]?type=status
JavaScript
getTopicStatus(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the topic
Returns
A JavaScript object containing the status for the specified topic on the queue manager connection
Create Topic
REST
POST o to /wmq/connections/[conn]/topics/
JavaScript
createTopic(o)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the topic
Returns
None
Modify Topic
REST
PUT o to /wmq/connections/[conn]/topics/[name]
JavaScript
modifyTopic(o, name)
Parameters
conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the topic
name – A string representing the name of the topic
Returns
None
Delete Topic
REST
DELETE /wmq/connections/[conn]/topics/[name]
JavaScript
deleteTopic(name)
Parameters
conn – An argument specifying the connection name (REST only)
name – A string representing the name of the topic
Returns
None
Messaging Operations
Browse Message
REST
GET /wmq/connections/[conn]/queues/[queue]/messages/[token][?maxdata=[bytes]&msgprop=[mq_gmo]&convert=[true|false]]
JavaScript
browseMessage(queue, token, o)
Parameters
conn – An argument specifying the connection name (REST only)
queue - A string representing the name of the queue
token – A string representing the token of the message
o - A JavaScript object with the following optional keys representing the options for this operation:
maxdata - An integer specifying the (nonnegative) number of message data bytes to return
convert - A Boolean (true or false) specifying whether to enable MQ message data conversion on the queue manager when browsing messages. Default: false.
msgprop - An integer argument specifying the MQ Get Message Options (MQ GMO) to use when browsing the queue
Returns
A JavaScript object containing the properties for the specified message.
Put Message
REST
POST o to /wmq/connections/[conn]/queues/[queue]/messages/[?set_context=[true|false]]
JavaScript
putMessage(queue, msgdata, msgprops)
Parameters
conn – An argument specifying the connection name (REST only)
queue - A string representing the name of the queue
set_context – A Boolean (true or false) specifying whether the message context should be set from the message object passed for this operation (true) or whether to ignore any message context passed with the request and putting the message in the product’s context. Default: false.
o – A JavaScript object with the message properties for the message to be created
msgdata – A string with the message payload data for the message to be created
msgprops - A JavaScript object with the message properties, i.e. excluding the message data, for the message to be created
Returns
None
Modify Message
REST
PUT o to /wmq/connections/[conn]/queues/[queue]/messages/[token][? replace=[true|false]&set_context=[true|false]]
JavaScript
modifyMessage(queue, token, o, opts)
Parameters
conn – An argument specifying the connection name (REST only)
queue - A string representing the name of the queue
token – A string representing the token of the message
set_context – Whether or not the message context should be set from the message object passed for this operation. Defaults to false when omitted.
o – A JavaScript object with the message properties for the message to be created
opts - A JavaScript object with the following options for this operation:
replace – Set to true to replace the existing message matching the given token. Defaults to false when omitted.
setContext – Whether or not the message context should be set from the message object passed for this operation. Defaults to false when omitted.
Returns
None
Delete Messages (by Index)
REST
DELETE /wmq/connections/[conn]/queues/[queue]/msgset/index/[list]
JavaScript
deleteMessagesByIndex (queue, list)
Parameters
conn – An argument specifying the connection name (REST only)
queue - A string representing the name of the queue
list – A comma-separated list of indices addressing the message to be removed where an index of ‘1’ is relating to the first message on the queue. For example, a list of ‘1,3,5’ would delete message 1, message 3 and message 5.
Returns
None
Delete Messages (by Range)
REST
DELETE /wmq/connections/[conn]/queues/[queue]/msgset/range/[range]
JavaScript
deleteMessagesByRange(queue, range)
Parameters
conn – An argument specifying the connection name (REST only)
queue - A string representing the name of the queue
range – A range of messages to be deleted consisting of the lowest index to consider (starting by 1) and the highest index separated by ‘-‘. For example, a range of ‘1-10’ would delete the first ten messages on the queue.
Returns
None
Copy Messages (by Index)
REST
PUT o to /wmq/connections/[conn]/queues/[queue]/msgset/index/[list]
NOTE: Must be preceded by a ‘Browse Queue’ run within the same session.
JavaScript
copyMessagesByIndex (queue, list)
Parameters
conn – An argument specifying the connection name (REST only)
queue - A string representing the name of the queue
list – A comma-separated list of indices addressing the messages to be copied where an index of ‘1’ is relating to the first message on the queue. For example, a list of ‘1,3,5’ would copy messages 1, 3 and 5.
o – A JavaScript object with the following keys representing the options for this operation:
dest_conn – A string representing the name of the destination connection to copy the messages to
dest_q – A string representing the name of the destination queue on the destination connection to copy the messages to
keep_corrid – A Boolean (true or false) indicating whether to preserve the origin’s message correlation in the message copy
keep_ctx – A Boolean (true or false) indicating whether to preserve the origin’s message context in the message copy
keep_msgid – A Boolean (true or false) indicating whether to preserve the origin’s message id in the message copy
remove_dlh – A Boolean (true or false) indicating whether to remove any Dead Letter Header from the origin messages during the operation
remove_xqh – A Boolean (true or false) indicating whether to remove any XMITQ header from the origin messages during the operation
Returns
None
Copy Messages (by Range)
REST
PUT o to /wmq/connections/[conn]/queues/[queue]/msgset/range/[range]
JavaScript
copyMessagesByRange (queue, range, o)
Parameters
conn – An argument specifying the source connection name (REST only)
queue – A string representing the name of the source queue
range – A range of messages to be copied consisting of the lowest index to consider (starting by 1) and the highest index separated by ‘-‘. For example, a range of ‘1-10’ would copy the first ten messages on the queue.
o – A JavaScript object with the following keys representing the options for this operation:
dest_conn – A string representing the name of the destination connection to copy the messages to
dest_q – A string representing the name of the destination queue on the destination connection to copy the messages to
keep_corrid – A Boolean (true or false) indicating whether to preserve the origin’s message correlation in the message copy
keep_ctx – A Boolean (true or false) indicating whether to preserve the origin’s message context in the message copy
keep_msgid – A Boolean (true or false) indicating whether to preserve the origin’s message id in the message copy
remove_dlh – A Boolean (true or false) indicating whether to remove any Dead Letter Header from the origin messages during the operation
remove_xqh – A Boolean (true or false) indicating whether to remove any XMITQ header from the origin messages during the operation
Returns
None
Move Messages (by Index)
REST
POST o to /wmq/connections/[conn]/queues/[queue]/msgset/index/[list]
NOTE: Must be preceded by a ‘Browse Queue’ run within the same session.
JavaScript
moveMessagesByIndex (queue, list, o)
Parameters
conn – An argument specifying the source connection name (REST only)
queue - A string representing the name of the source queue
list – A comma-separated list of indices addressing the message to be moved where an index of ‘1’ is relating to the first message on the queue. For example, a list of ‘1,3,5’ would move messages 1, 3 and 5.
o – A JavaScript object with the following keys representing the options for this operation:
dest_conn – A string representing the name of the destination connection to move the messages to
dest_q – A string representing the name of the destination queue on the destination connection to move the messages to
keep_corrid – A Boolean (true or false) indicating whether to preserve the origin’s message correlation in the moved message
keep_ctx – A Boolean (true or false) indicating whether to preserve the origin’s message context in the moved message
keep_msgid – A Boolean (true or false) indicating whether to preserve the origin’s message id in the moved message
remove_dlh – A Boolean (true or false) indicating whether to remove any Dead Letter Header from the origin messages during the operation
remove_xqh – A Boolean (true or false) indicating whether to remove any XMITQ header from the origin messages during the operation
Returns
None
Move Messages (by Range)
REST
POST o to /wmq/connections/[conn]/queues/[queue]/msgset/range/[range]
JavaScript
moveMessagesByRange (queue, range, o)
Parameters
conn – An argument specifying the source connection name (REST only)
queue - A string representing the name of the source queue
range – A range of messages to be moved consisting of the lowest index to consider (starting by 1) and the highest index separated by ‘-‘. For example, a range of ‘1-10’ would move the first ten messages on the queue.
o – A JavaScript object with the following keys representing the options for this operation:
dest_conn – A string representing the name of the destination connection to move the messages to
dest_q – A string representing the name of the destination queue on the destination connection to move the messages to
keep_corrid – A Boolean (true or false) indicating whether to preserve the origin’s message correlation in the moved message
keep_ctx – A Boolean (true or false) indicating whether to preserve the origin’s message context in the moved message
keep_msgid – A Boolean (true or false) indicating whether to preserve the origin’s message id in the moved message
remove_dlh – A Boolean (true or false) indicating whether to remove any Dead Letter Header from the origin messages during the operation
remove_xqh – A Boolean (true or false) indicating whether to remove any XMITQ header from the origin messages during the operation
Returns
None
Replay Messages (by Index)
REST
POST o to /wmq/connections/[conn]/queues/[queue]/msgset/index/[list]?type=replay
NOTE: Must be preceded by a ‘Browse Queue’ run within the same session.
JavaScript
replayMessagesByIndex (queue, list, o)
Parameters
conn – An argument specifying the source connection name (REST only)
queue - A string representing the name of the source queue
list – A comma-separated list of indices addressing the message to be replayed where an index of ‘1’ is relating to the first message on the queue. For example, a list of ‘1,3,5’ would replay messages 1, 3 and 5.
o – A JavaScript object with the following keys representing the options for this operation:
dest_conn – A string representing the name of the destination connection to replay the messages to
dest_q – A string representing the name of the destination queue on the destination connection to replay the messages to
Returns
None
Replay Messages (by Range)
REST
POST o to /wmq/connections/[conn]/queues/[queue]/msgset/range/[range]?type=replay
JavaScript
replayMessagesByRange (queue, range, o)
Parameters
conn – An argument specifying the source connection name (REST only)
queue - A string representing the name of the source queue
range – A range of messages to be replayed consisting of the lowest index to consider (starting by 1) and the highest index separated by a hyphen ‘-‘. For example, a range of ‘1-10’ would replay the first ten messages on the queue.
o – A JavaScript object with the following keys representing the options for this operation:
dest_conn – A string representing the name of the destination connection to replay the messages to
dest_q – A string representing the name of the destination queue on the destination connection to replay the messages to
Returns
None
Find Messages
REST
GET /wmq/connections/[conn]/queues/[queue]/search?op=start&requestTimeout=[millis]&find_type=[ftype]&search_string=[expr]&prop_option=[DSPMSGPROP|DSPRFH2|DSPRFH2V6]&header_field=[‘All’|name]&convert=[true|false]&dlq=[true|false][[&startTime=[millis]][&endTime=[millis]]]
JavaScript
findMessages(queue, o)
Parameters
conn – An argument specifying the connection name (REST only)
queue - A string representing the name of the queue
o – A JavaScript object with the following keys representing the options for this operation:
requestTimeout – Timeout for the operation in milliseconds
find_type – An Integer number indicating the areas of the message for content matching the search expression. Any (bitwise ‘OR’) combination of one or multiple of the following: 1 to search in the message data, 2 to search in the selected message header(s), 4 to search in the message properties. For example, set to 7 to search in the message data, in the header(s) and also in the message properties.
search_string – A search string which may optionally contain the wildcard character ‘*’
prop_option – a String identifying the MQ Get Message Option (MQ GMO) to apply when searching in MQ message properties.
header_field – The message header(s) to search for the given expression. Either ‘All’ for searching in all headers or a header field name prefixed with the header name followed by a single dot (‘.’). For example MQMD.PutApplName to search for the expression in the Put Application Name field in the MQMD header.
convert – whether the message is to be converted for the operation
dlq – whether the searched queue is a dead letter queue
startTime – the earliest time a message was put to consider for the search (in milliseconds since the epoch). When omitted the search will not set a lower limit for the time interval to search for messages in.
endTime – the latest time a message was put to consider for the search (in milliseconds since the epoch). When omitted the search will not set an upper limit for the time interval to search for messages.
Returns
An array of JavaScript objects representing the MQ messages on the queue matching the given search criteria.
Export Messages (by Range)
REST
GET /wmq/connections/[conn]/queues/[queue]/msgset/range/[range]? dataonly=[true|false]&convert=[true|false]& copydesc=[true|false][&[delimiter=[string]]&[zip=[true|false]]
JavaScript
exportMessagesByRange(queue, range, filepath, o)
Parameters
conn – An argument specifying the connection name (REST only)
queue - A string representing the name of the queue
range – A range of message indices to process in this operation in the format ‘<from>-<to>’ where <from> is the index of the first message and <to> is the index of the last message to consider
filepath – A path to the output file receiving the selected messages. (JavaScript only)
o – A JavaScript object with the following keys representing the options for this operation:
dataonly – A Boolean indicating whether to download only the message payload data (true) or the message including its data and properties into the MVMA format
convert - A Boolean (true or false) specifying whether to enable MQ message data conversion by the queue manager when exporting messages or whether not to convert message data.
copydesc – A Boolean (true or false) specifying whether the MQ message descriptor should be included in the MVMA message formatted file (true) or not (false). Only relevant if ‘false’ is selected for dataonly.
delimiter – A String representing the delimiter to use in the download file to separate message payload data. Only relevant if true was selected for dataonly.
zip – A Boolean (true or false) specifying whether the payload data of multiple message should be downloaded as an archive in the zip format containing a message data file for each message selected for this operation. Only relevant if true was selected for dataonly.
Returns
The requested messages as a download file.
Export Messages (by Index)
REST
GET /wmq/connections/[conn]/queues/[queue]/msgset/index/[list]? dataonly=[true|false]&convert=[true|false]& copydesc=[true|false][&[delimiter=[string]]&[zip=[true|false]]
NOTE: Must be preceded by a ‘Browse Queue’ run within the same session.
JavaScript
exportMessagesByIndex(queue, list, filepath, o)
Parameters
conn – An argument specifying the connection name (REST only)
queue - A string representing the name of the queue
list – A comma-separated list of indices addressing the message to be exported where an index of ‘1’ relates to the first message on the queue. For example, a list of ‘1,3,5’ would export messages 1, 3 and 5.
filepath – A path to the output file receiving the selected messages. (JavaScript only)
o – A JavaScript object with the following keys representing the options for this operation:
dataonly – A Boolean indicating whether to download only the message payload data (true) or the message including its data and properties into the MVMA format
convert - A Boolean (true or false) specifying whether to enable MQ message data conversion by the queue manager when exporting messages or whether not to convert message data.
copydesc – A Boolean (true or false) specifying whether the MQ message descriptor should be included in the MVMA message formatted file (true) or not (false). Only relevant if ‘false’ is selected for dataonly.
delimiter – A String representing the delimiter to use in the download file to separate message payload data. Only relevant if true was selected for dataonly.
zip – A Boolean (true or false) specifying whether the payload data of multiple messages should be downloaded as an archive in the zip format containing a message data file for each message selected for this operation. Only relevant if true was selected for dataonly.
Returns
The requested messages as a download file.
Import Messages
REST
POST o to /wmq/connections/[conn]/queues/[queue]/msgfile?filetype=BMMADMIN_JSON|ONE_MSG| DELIMITED_MSGS[&keep_corrid=[true|false]][&keep_ctx=[true|false]][&keep_msgid=[true|false]][&remove_dlh=[true|false]][&remove_xqh=[true|false]][&set_context=[true|false]][&msg_file_delimiter=[’newline’|[string]]][[&[msg_prop]=[prop_value]]*]
JavaScript
importMessages (queue, filepath, filetype, opts)
Parameters
conn – An argument specifying the connection name (REST only)
queue - A string representing the name of the queue
filepath – The path to the message import file
filetype – Set to BMMADMIN_JSON if the message import file is in the MVMA JSON format, ONE_MSG if the message import file contains the message payload data for a single message or DELIMITED_MSGS if the message import file contains message payload data for multiple message separated by a delimiter (see opts below).
o – A message file either in the MVMA JSON format or a file containing message payload data for either a single message or for multiple messages separated by the selected delimiter.
opts – A JavaScript object with following options for this operation
keep_corrid – A Boolean (true or false) indicating whether to preserve the origin’s message correlation in the message copy. Only valid with the BMMADMIN_JSON filetype.
keep_ctx – A Boolean (true or false) indicating whether to preserve the origin’s message context in the message copy. Only valid with the BMMADMIN_JSON filetype.
keep_msgid – A Boolean (true or false) indicating whether to preserve the origin’s message id in the message copy. Only valid with the BMMADMIN_JSON filetype.
remove_dlh – A Boolean (true or false) indicating whether to remove any Dead Letter Header from the origin messages during the operation. Only valid with the BMMADMIN_JSON filetype.
remove_xqh – A Boolean (true or false) indicating whether to remove any XMITQ header from the origin messages during the operation. Only valid with the BMMADMIN_JSON filetype.
msg_file_delimiter – ‘newline’ to indicate each line in the message import file relates to the payload of one message imported or a string used as a separator between payload data in the message import file. Only valid with filetype DELIMITED_MSGS
set_context – A Boolean (true or false) indicating whether the context for the message(s) imported should be set from the message properties passed or not
[msg_prop] - Any message properties with their values [prop_value] that should be set for import with filetype ONE_MSG or DELIMITED_MSGS. For example ‘Format’ for setting the message format.
[prop_value] – A message property value.
Returns
None
Publish Message
REST
POST o to /wmq/connections/[conn]/topics/[topic]/messages/[?set_context=[true|false]]
JavaScript
publishMessage(topic, msgdata, msgprops)
Parameters
conn – An argument specifying the connection name (REST only)
topic - A string representing the name of the topic
set_context – Whether or not the message context should be set from the message object passed for this operation. Defaults to false.
o – A JavaScript object with the message properties for the message to be created
msgdata – A string with the message payload data for the message to be created
msgprops - A JavaScript object with the message properties for the message to be created
Returns
None
Publish Messages
REST
POST o to /wmq/connections/[conn]/topics/[topic_string]/msgfile?filetype=BMMADMIN_JSON|ONE_MSG| DELIMITED_MSGS[&keep_corrid=[true|false]][&keep_ctx=[true|false]][&keep_msgid=[true|false]][&remove_dlh=[true|false]][&remove_xqh=[true|false]][&set_context=[true|false]][&msg_file_delimiter=[’newline’|[string]]][[&[msg_prop]=[prop_value]]*]
JavaScript
publishMessages (topic_string, filepath, filetype, opts)
Parameters
conn – An argument specifying the connection name (REST only)
topic_string - A string representing the Topic String to publish the messages under
filepath – The path to the message import file
filetype – Set to BMMADMIN_JSON if the message import file is in the MVMA JSON format, ONE_MSG if the message import file contains the message payload data for a single message or DELIMITED_MSGS if the message import file contains message payload data for multiple message separated by a delimiter (see opts below).
o – A message file either in the MVMA JSON format or a file containing message payload data for either a single message or for multiple messages separated by the selected delimiter.
opts – A JavaScript object with following options for this operation
keep_corrid – A Boolean (true or false) indicating whether to preserve the origin’s message correlation in the message copy. Only valid with the BMMADMIN_JSON filetype.
keep_ctx – A Boolean (true or false) indicating whether to preserve the origin’s message context in the message copy. Only valid with the BMMADMIN_JSON filetype.
keep_msgid – A Boolean (true or false) indicating whether to preserve the origin’s message id in the message copy. Only valid with the BMMADMIN_JSON filetype.
remove_dlh – A Boolean (true or false) indicating whether to remove any Dead Letter Header from the origin messages during the operation. Only valid with the BMMADMIN_JSON filetype.
remove_xqh – A Boolean (true or false) indicating whether to remove any XMITQ header from the origin messages during the operation. Only valid with the BMMADMIN_JSON filetype.
msg_file_delimiter – ‘newline’ to indicate each line in the message import file relates to the payload of one message imported or a string used as a separator between payload data in the message import file. Only valid with filetype DELIMITED_MSGS
set_context – A Boolean (true or false) indicating whether the context for the message(s) imported should be set from the message properties passed or not
[msg_prop] - Any message properties with their values [prop_value] that should be set for import with filetype ONE_MSG or DELIMITED_MSGS. For example ‘Format’ for setting the message format.
[prop_value] – A message property value.
Returns
None