REST API and PCF equivalents for channels

For most REST API optional query parameters and attributes for channels, an equivalent PCF parameter or attribute exists. Use the tables that are provided to understand these equivalents.


Optional query parameter equivalents

Table 1. Channel optional query parameters for the REST API and equivalent PCF parameters.
REST API optional query parameter PCF parameter Related values (REST API) Related values (PCF)
filter=filterValue
MQCFT_INTEGER_FILTER
MQCFT_STRING_FILTER
lessThan
greaterThan
lessThanOrEqualTo
greaterThanOrEqualTo
equalTo
notEqualTo
MQCFOP_LESS
MQCFOP_GREATER
MQCFOP_NOT_GREATER
MQCFOP_NOT_LESS
MQCFOP_EQUAL
MQCFOP_LIKE
MQCFOP_NOT_EQUAL
MQCFOP_NOT_LIKE
type=type MQIACH_CHANNEL_TYPE
all
sender
receiver
server
requester
clusterSender
clusterReceiver
None.
MQCHT_SENDER
MQCHT_RECEIVER
MQCHT_SERVER
MQCHT_REQUESTER
MQCHT_CLUSSDR
MQCHT_CLUSRCVR
queueSharingGroupDisposition=disposition MQIA_QSG_DISP
live
all
copy
group
private
qmgr
MQQSGD_LIVE
MQQSGD_ALL
MQQSGD_COPY
MQQSGD_GROUP
MQQSGD_PRIVATE
MQQSGD_Q_MGR


Channel attribute equivalents

Table 2. Channel attributes for the REST API and equivalent PCF attributes.
REST API attribute PCF attribute Related values (REST API) Related values (PCF)
name MQIACH_CHANNEL_NAME    
type MQIACH_CHANNEL_TYPE    
clusterRouting.workloadPriority MQIACH_CLWL_CHANNEL_PRIORITY    
clusterRouting.workloadRank MQIACH_CLWL_CHANNEL_RANK    
clusterRouting.workloadWeight MQIACH_CLWL_CHANNEL_WEIGHT    
clusterRouting.networkPriority MQIACH_NETWORK_PRIORITY    

[type].connection.host
[type].connection.port
sender.connection.host
sender.connection.port
server.connection.host
server.connection.port
requester.connection.host
requester.connection.port
clusterSender.connection.host
clusterSender.connection.port
clusterReceiver.connection.host
clusterReceiver.connection.port
 MQCACH_CONNECTION_NAME    

[type].transmissionQueueName
sender.transmissionQueueName
server.transmissionQueueName
 MQCACH_XMIT_Q_NAME    

clusterSender.clusterName
clusterReceiver.clusterName
 MQCA_CLUSTER_NAME    

clusterSender.clusterNamelist
clusterReceiver.clusterNamelist
 MQCA_CLUSTER_NAMELIST    
connectionManagement.heartbeatInterval MQIACH_HB_INTERVAL    
connectionManagement.disconnectInterval MQIACH_DISC_INTERVAL    
connectionManagement.keepAliveInterval MQIACH_KEEP_ALIVE_INTERVAL    

connectionManagement.localAddress.host
connectionManagement.localAddress.port
connectionManagement.localAddress.portRange
 MQCACH_LOCAL_ADDRESS    
connectionManagement.longRetry.count MQIACH_LONG_RETRY    
connectionManagement.longRetry.interval MQIACH_LONG_TIMER    
connectionManagement.shortRetry.count MQIACH_SHORT_RETRY    
connectionManagement.shortRetry.interval MQIACH_SHORT_TIMER    
compression.header MQIACH_HDR_COMPRESSION
none
system
MQCOMPRESS_NONE
MQCOMPRESS_SYSTEM
compression.message MQIACH_MSG_COMPRESSION
none
runLengthEncoding
zlibFast
zlibHigh
any
MQCOMPRESS_NONE
MQCOMPRESS_RLE
MQCOMPRESS_ZLIBFAST
MQCOMPRESS_ZLIBHIGH
MQCOMPRESS_ANY
dataCollection.monitoring MQIA_MONITORING_CHANNEL
off
asQmgr
low
medium
high
MQMON_OFF
MQMON_Q_MGR
MQMON_LOW
MQMON_MEDIUM
MQMON_HIGH
dataCollection.statistics MQIA_STATISTICS_CHANNEL
off
asQmgr
low
medium
high
MQMON_OFF
MQMON_Q_MGR
MQMON_LOW
MQMON_MEDIUM
MQMON_HIGH
exits.message.name MQCACH_MSG_EXIT_NAME    
exits.message.userData MQCACH_MSG_EXIT_USER_DATA    
exits.messageRetry.name MQCACH_MR_EXIT_NAME    
exits.messageRetry.userData MQCACH_MR_EXIT_USER_DATA    
exits.receive.name MQCACH_RCV_EXIT_NAME    
exits.receive.userData MQCACH_RCV_EXIT_USER_DATA    
exits.security.name MQCACH_SEC_EXIT_NAME    
exits.security.userData MQCACH_SEC_EXIT_USER_DATA    
exits.send.name MQCACH_SEND_EXIT_NAME    
exits.send.userData MQCACH_SEND_EXIT_USER_DATA    
extended.channelAgentType MQIACH_MCA_TYPE
process
thread
MQMCAT_PROCESS
MQMCAT_THREAD
extended.senderDataConversion MQIACH_DATA_CONVERSION
false
true
MQCDC_NO_SENDER_CONVERSION
MQCDC_SENDER_CONVERSION
extended.messagePropertyControl MQIA_PROPERTY_CONTROL
compatible
none
all
MQPROP_COMPATIBILITY
MQPROP_NONE
MQPROP_ALL
extended.sequenceNumberWrap MQIACH_SEQUENCE_NUMBER_WRAP    
failedDelivery.retry.count MQIACH_MR_COUNT    
failedDelivery.retry.interval MQIACH_MR_INTERVAL    
failedDelivery.useDeadLetterQueue MQIA_USE_DEAD_LETTER_Q
true
false
MQUSEDLQ_YES
MQUSEDLQ_NO
general.description MQCACH_DESC    
general.maximumMessageLength MQIACH_MAX_MSG_LENGTH    
batch.preCommitHeartbeat MQIACH_BATCH_HB    
batch.timeExtend MQIACH_BATCH_INTERVAL    
batch.dataLimit MQIACH_BATCH_DATA_LIMIT    
batch.messageLimit MQIACH_BATCH_SIZE    

batch.nonPersistentMessageSpeedFast
currentStatus.batch.nonPersistentMessageSpeedFast
 MQIACH_NPM_SPEED
true
false
MQNPMS_FAST
MQNPMS_NORMAL
queueSharingGroup.disposition MQIA_QSG_DISP
copy
group
qmgr
MQQSDG_COPY
MQQSDG_GROUP
MQQSDG_QMGR
queueSharingGroup.defaultChannelDisposition MQIACH_DEF_CHANNEL_DISP
private
fixShared
shared
MQCHLD_PRIVATE
MQCHLD_FIXSHARED
MQCHLD_SHARED
receiverSecurity.channelAgentUserId MQCACH_MCA_USER_ID    
receiverSecurity.putAuthority MQCACH_MCA_USER_ID
default
context
alternateOrChannelAgent
onlyChannelAgent
MQPA_DEFAULT
MQPA_CONTEXT
MQPA_ALTERNATE_OR_MCA
MQPA_ONLY_MCA
transmissionSecurity.certificateLabel MQCA_CERT_LABEL    
transmissionSecurity.cipherSpecification MQCACH_SSL_CIPHER_SPEC    
transmissionSecurity.requirePartnerCertificate MQIACH_SSL_CLIENT_AUTH
true
false
MQSCA_REQUIRED
MQSCA_OPTIONAL
transmissionSecurity.certificatePeerName MQCACH_SSL_PEER_NAME    
timestamps.altered
MQCA_ALTERATION_DATE
MQCA_ALTERATION_TIME
    

currentStatus.inDoubt
savedStatus.inDoubt
 MQIACH_INDOUBT_STATUS
true
false
MQCHIDS_INDOUBT
MQCHIDS_NOT_INDOUBT
currentStatus.state MQIACH_CHANNEL_STATUS
binding
starting
running
paused
stopping
retrying
stopped
requesting
switching
initializing
MQCHS_BINDING
MQCHS_STARTING
MQCHS_RUNNING
MQCHS_PAUSED
MQCHS_STOPPING
MQCHS_RETRYING
MQCHS_STOPPED
MQCHS_REQUESTING
MQCHS_SWITCHING
MQCHS_INITIALIZING
currentStatus.agent.jobName MQCACH_MCA_JOB_NAME    
currentStatus.agent.running MQIACH_MCA_STATUS
true
false
MQMCAS_RUNNING
MQMCAS_STOPPED
currentStatus.agent.state MQIACH_CHANNEL_SUBSTATE
runningChannelAutoDefinitionExit
compressingData
processingEndOfBatch
performingSecurityHandshake
heartbeating
executingMQGET
executingMQI
executingMQPUT
runningRetryExit
runningMessageExit
communicatingWithNameServer
connectingToNetwork
undefined
runningReceiveExit
receivingFromNetwork
resynchingWithPartner
runningSecurityExit
runningSendExit
sendingToNetwork
serializingAccessToQmgr
MQCHSSTATE_CHADEXIT
MQCHSSTATE_COMPRESSING
MQCHSSTATE_END_OF_BATCH
MQCHSSTATE_HANDSHAKING
MQCHSSTATE_HEARTBEATING
MQCHSSTATE_IN_MQGET
MQCHSSTATE_IN_MQI_CALL
MQCHSSTATE_IN_MQPUT
MQCHSSTATE_MREXIT
MQCHSSTATE_MSGEXIT
MQCHSSTATE_NAME_SERVER
MQCHSSTATE_NET_CONNECTING
MQCHSSTATE_OTHER
MQCHSSTATE_RCVEXIT
MQCHSSTATE_RECEIVING
MQCHSSTATE_RESYNCHING
MQCHSSTATE_SCYEXIT
MQCHSSTATE_SENDEXIT
MQCHSSTATE_SENDING
MQCHSSTATE_SERIALIZING
currentStatus.agent.userId MQCACH_MCA_USER_ID    
currentStatus.batch.count MQIACH_BATCHES    

currentStatus.batch.currentMessages
savedStatus.batch.currentMessages
 MQIACH_CURRENT_MSGS    

currentStatus.batch.luwid.current
savedStatus.batch.luwid.current
 MQCACH_CURRENT_LUWID    

currentStatus.batch.luwid.last
savedStatus.batch.luwid.last
 MQCACH_LAST_LUWID    

currentStatus.batch.sequenceNumber.current
savedStatus.batch.sequenceNumber.current
 MQIACH_CURRENT_SEQ_NUMBER    

currentStatus.batch.sequenceNumber.last
savedStatus.batch.sequenceNumber.last
 MQIACH_LAST_SEQ_NUMBER    
currentStatus.batch.size MQIACH_BATCH_SIZE    

currentStatus.compression.header.default
currentStatus.compression.header.lastMessage
 MQIACH_HDR_COMPRESSION
none
system
unavailable (applies to lastMessage only)
MQCOMPRESS_NONE
MQCOMPRESS_SYSTEM
MQCOMPRESS_NOT_AVAILABLE

currentStatus.compression.message.default
currentStatus.compression.message.lastMessage
 MQIACH_MSG_COMPRESSION
none
runLengthEncoding
zlibFast
zlibHigh
unavailable (applies to lastMessage only)
MQCOMPRESS_NONE
MQCOMPRESS_RLE
MQCOMPRESS_ZLIBFAST
MQCOMPRESS_ZLIBHIGH
MQCOMPRESS_NOT_AVAILABLE
currentStatus.connectionManagement.heartbeatInterval MQIACH_HB_INTERVAL    
currentStatus.connectionManagement.keepAliveInterval MQIACH_KEEP_ALIVE_INTERVAL    

currentStatus.connectionManagement.localAddress.host
currentStatus.connectionManagement.localAddress.port
 MQCACH_LOCAL_ADDRESS    
currentStatus.connectionManagement.remainingRetries.long MQIACH_LONG_RETRIES_LEFT    
currentStatus.connectionManagement.remainingRetries.short MQIACH_SHORT_RETRIES_LEFT    
currentStatus.extended.buffers.received MQIACH_BUFFERS_RCVD    
currentStatus.extended.buffers.sent MQIACH_BUFFERS_SENT    
currentStatus.extended.bytes.received MQIACH_BYTES_RCVD    
currentStatus.extended.bytes.sent MQIACH_BYTES_SENT    
currentStatus.extended.messageCount MQIACH_MSGS    

currentStatus.general.connection.host
currentStatus.general.connection.port
savedStatus.general.connection.host
 MQCACH_CONNECTION_NAME    

currentStatus.general.transmissionQueueName
savedStatus.general.transmissionQueueName
 MQCACH_XMIT_Q_NAME    
currentStatus.general.maximumMessageLength MQIACH_MAX_MSG_LENGTH    
currentStatus.general.stopRequested MQIACH_STOP_REQUESTED
true
false
MQCHSR_STOP_REQUESTED
MQCHSR_STOP_NOT_REQUESTED
currentStatus.general.statistics MQIA_STATISTICS_CHANNEL
disabledByQmgr
off
low
medium
high
MQMON_NONE
MQMON_OFF
MQMON_Q_MGR
MQMON_LOW
MQMON_MEDIUM
MQMON_HIGH

currentStatus.monitoring.messagesInBatch.shortSamplePeriod
currentStatus.monitoring.messagesInBatch.longSamplePeriod
 MQIACH_BATCH_SIZE_INDICATOR -1 MQMON_NOT_AVAILABLE
currentStatus.monitoring.rate MQIA_MONITORING_CHANNEL
off
low
medium
high
MQMON_OFF
MQMON_LOW
MQMON_MEDIUM
MQMON_HIGH

currentStatus.monitoring.messagesInBatch.shortSamplePeriod
currentStatus.monitoring.messagesInBatch.longSamplePeriod
 MQIACH_COMPRESSION_RATE -1 MQMON_NOT_AVAILABLE

currentStatus.monitoring.compressionTime.shortSamplePeriod
currentStatus.monitoring.compressionTime.longSamplePeriod
 MQIACH_COMPRESSION_TIME -1 MQMON_NOT_AVAILABLE

currentStatus.monitoring.exitTime.shortSamplePeriod
currentStatus.monitoring.exitTime.longSamplePeriod
 MQIACH_EXIT_TIME_INDICATOR -1 MQMON_NOT_AVAILABLE
currentStatus.monitoring.messagesAvailable MQIACH_XMITQ_MSGS_AVAILABLE -1 MQMON_NOT_AVAILABLE

currentStatus.monitoring.networkTime.shortSamplePeriod
currentStatus.monitoring.networkTime.longSamplePeriod
 MQIACH_NETWORK_TIME_INDICATOR -1 MQMON_NOT_AVAILABLE

currentStatus.monitoring.transmissionQueueTime.shortSamplePeriod
currentStatus.monitoring.transmissionQueueTime.longSamplePeriod
 MQIACH_XMITQ_TIME_INDICATOR -1 MQMON_NOT_AVAILABLE
currentStatus.partner.productIdentifier MQCACH_REMOTE_PRODUCT
MQMM
MQMV
MQCC
MQNM
MQJB
MQJM
MQJN
MQJU
MQXC
MQXD
MQXN
MQXM
MQXU
MQNU
MQMM
MQMV
MQCC
MQNM
MQJB
MQJM
MQJN
MQJU
MQXC
MQXD
MQXN
MQXM
MQXU
MQNU
currentStatus.partner.qmgrName MQCA_REMOTE_Q_MGR_NAME    
currentStatus.partner.version MQCACH_REMOTE_VERSION    

currentStatus.queueSharingGroup.channelDisposition
savedStatus.queueSharingGroup.channelDisposition
 MQIACH_CHANNEL_DISP
private
shared
fixShared
MQCHLD_PRIVATE
MQCHLD_SHARED
MQCHLD_FIXSHARED
currentStatus.timestamps.started
MQCACH_CHANNEL_START_DATE
MQCACH_CHANNEL_START_TIME
    
currentStatus.timestamps.lastMessage
MQCACH_LAST_MSG_DATE
MQCACH_LAST_MSG_TIME
    
currentStatus.transmissionSecurity.certificateIssuerName MQCACH_SSL_CERT_ISSUER_NAME    
currentStatus.transmissionSecurity.certificateUserId MQCACH_SSL_CERT_USER_ID    
currentStatus.transmissionSecurity.keyLastReset
MQCACH_SSL_KEY_RESET_DATE
MQCACH_SSL_KEY_RESET_TIME
    
currentStatus.transmissionSecurity.keyResetCount MQIACH_SSL_KEY_RESETS    
currentStatus.transmissionSecurity.protocol MQCACH_SSL_CERT_USER_ID
none
sslV30
tlsV10
tlsV12
MQSECPROT_NONE
MQSECPROT_SSLV30
MQSECPROT_TLSV10
MQSECPROT_TLSV12
currentStatus.transmissionSecurity.shortPeerName MQCACH_SSL_SHORT_PEER_NAME    


Unsupported PCF parameters

The following parameters are not supported by the administrative REST API:

  • MQIACH_CLIENT_CHANNEL_WEIGHT
  • MQIACH_CONNECTION_AFFINITY
  • MQIACH_DEF_RECONNECT
  • MQIACH_IN_DOUBT_IN
  • MQIACH_IN_DOUBT_OUT
  • MQCACH_LAST_MSG_TIME
  • MQIACH_MAX_INSTANCES
  • MQIACH_MAX_INSTS_PER_CLIENT
  • MQCACH_MODE_NAME
  • MQIACH_MSGS_RECEIVED/MQIACH_MSGS_RCVD
  • MQIACH_MSGS_SENT
  • MQCACH_PASSWORD
  • MQIACH_SHARING_CONVERSATIONS
  • MQCACH_TP_NAME
  • MQIACH_XMIT_PROTOCOL_TYPE
  • MQCACH_USER_ID