REST API and PCF equivalents for queues

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

Optional query parameter equivalents
Queue attribute equivalents
Unsupported PCF attributes

Optional query parameter equivalents

Table 1. Queue 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)
`commandScope=scope`	MQCACF_COMMAND_SCOPE	None.	None.
`filter=filterValue`	MQCFT_INTEGER_FILTER MQCFT_STRING_FILTER	`lessThan` `greaterThan` `lessThanOrEqualTo` `greaterThanOrEqualTo` `equalTo` `notEqualTo`	`MQCFOP_LESS` `MQCFOP_GREATERMQCFOP_NOT_GREATER` `MQCFOP_NOT_LESS` `MQCFOP_EQUAL` `MQCFOP_LIKE` `MQCFOP_NOT_EQUAL` `MQCFOP_NOT_LIKE`
`force`	MQIACF_FORCE
`keepAuthorityRecords`	MQIACF_REMOVE_AUTHREC
`like=queueName`	MQCACF_FROM_Q_NAME
`noReplace`	MQIACF_REPLACE
`purge`	MQIACF_PURGE
`queueSharingGroupDisposition=disposition`	MQIA_QSG_DISP	`live` `all` `copy` `group` `private` `qmgr` `shared`	`MQQSGD_LIVE` `MQQSGD_ALL` `MQQSGD_COPY` `MQQSGD_GROUP` `MQQSGD_PRIVATE` `MQQSGD_Q_MGR` `MQQSGD_SHARED`
`type=type`	MQIA_Q_TYPE	`all` `local` `alias` `remote` `cluster` `model`	None. `MQQT_LOCAL` `MQQT_ALIAS` `MQQT_REMOTE` `MQQT_CLUSTER` `MQQT_MODEL`

Queue attribute equivalents

Table 2. Queue attributes for the REST API and equivalent PCF attributes.
REST API attribute	PCF attribute	Related values (REST API)	Related values (PCF)
`name`	MQCA_Q_NAME
`type`	MQIA_Q_TYPE	`local` `alias` `remote` `cluster` `model`	`MQQT_LOCAL` `MQQT_ALIAS` `MQQT_REMOTE` `MQQT_CLUSTER` `MQQT_MODEL`
`remote.qmgrName`	MQCA_REMOTE_Q_MGR_NAME
`remote.queueName`	MQCA_REMOTE_Q_NAME
`remote.transmissionQueueName`	MQCA_XMIT_Q_NAME
`alias.targetName`	MQCA_BASE_OBJECT_NAME
`alias.targetType`	MQIA_BASE_TYPE	`queue` `topic`	`MQOT_Q` `MQOT_TOPIC`
`dynamic.type`	MQIA_DEFINITION_TYPE	`permanentDynamic` `sharedDynamic` `temporaryDynamic`	`MQQDT_PERMANENT_DYNAMIC` `MQQDT_SHARED_DYNAMIC` `MQQDT_TEMPORARY_DYNAMIC`
`model.type`	MQIA_DEFINITION_TYPE	`permanentDynamic` `sharedDynamic` `temporaryDynamic`	`MQQDT_PERMANENT_DYNAMIC` `MQQDT_SHARED_DYNAMIC` `MQQDT_TEMPORARY_DYNAMIC`
`cluster.name`	MQCA_CLUSTER_NAME
`cluster.namelist`	MQCA_CLUSTER_NAMELIST
`cluster.qmgrId`	QMgrIdentifier
`cluster.qmgrName`	QMgrName
`cluster.queueType`	ClusterQType	`local` `alias` `remote` `qmgrAlias`	`MQCQT_LOCAL_Q` `MQCQT_ALIAS_Q` `MQCQT_REMOTE_Q` `MQCQT_Q_MGR_ALIAS`
`cluster.transmissionQueueForChannelName`	ClusterChannelName
`cluster.workloadPriority`	MQIA_CLWL_Q_PRIORITY
`cluster.workloadQueueUse`	MQIA_CLWL_USEQ	`true` `false`	`MQTC_ON` `MQTC_OFF`
`cluster.workloadRank`	MQIA_CLWL_Q_RANK
`trigger.enabled`	MQIA_TRIGGER_CONTROL	`true` `false`	`MQTC_ON` `MQTC_OFF`
`trigger.data`	MQCA_TRIGGER_DATA
`trigger.depth`	MQIA_TRIGGER_DEPTH
`trigger.initiationQueueName`	MQCA_INITIATION_Q_NAME
`trigger.messagePriority`	MQIA_TRIGGER_MSG_PRIORITY
`trigger.processName`	MQCA_PROCESS_NAME
`trigger.type`	MQIA_TRIGGER_TYPE	`none` `every` `first` `depth`	`MQTT_NONE` `MQTT_EVERY` `MQTT_FIRST` `MQTT_DEPTH`
`events.depth.highEnabled`	MQIA_Q_DEPTH_HIGH_EVENT	`true` `false`	`MQEVR_ENABLED` `MQEVR_DISABLED`
`events.depth.highPercentage`	MQIA_Q_DEPTH_HIGH_LIMIT
`events.depth.lowEnabled`	MQIA_Q_DEPTH_LOW_EVENT	`true` `false`	`MQEVR_ENABLED` `MQEVR_DISABLED`
`events.depth.lowPercentage`	MQIA_Q_DEPTH_LOW_LIMIT
`events.depth.fullEnabled`	MQIA_Q_DEPTH_MAX_EVENT	`true` `false`	`MQEVR_ENABLED` `MQEVR_DISABLED`
`events.serviceInterval.highEnabled`	MQIA_Q_SERVICE_INTERVAL_EVENT	`true` `false`	`MQSIE_HIGH` `MQSIE_NONE` (Equivalent only when okEnabled is also false)
`events.serviceInterval.okEnabled`	MQIA_Q_SERVICE_INTERVAL_EVENT	`true` `false`	`MQSIE_OK` `MQSIE_NONE` (Equivalent only when highEnabled is also false)
`events.serviceInterval.duration`	MQIA_Q_SERVICE_INTERVAL
`applicationDefaults.clusterBind`	MQIA_DEF_BIND	`onOpen` `notFixed` `onGroup`	`MQBND_BIND_ON_OPEN` `MQBND_BIND_NOT_FIXED` `MQBND_BIND_ON_GROUP`
`applicationDefaults.messagePropertyControl`	MQIA_PROPERTY_CONTROL	`all` `compatible` `force` `none` `version6Compatible`	`MQPROP_ALL` `MQPROP_COMPATIBILITY` `MQPROP_FORCE_MQRFH2` `MQPROP_NONE` `MQPROP_V6COMPAT`
`applicationDefaults.messagePersistence`	MQIA_DEF_PERSISTENCE	`persistent` `nonPersistent`	`MQPER_PERSISTENT` `MQPER_NOT_PERSISTENT`
`applicationDefaults.messagePriority`	MQIA_DEF_PRIORITY
`applicationDefaults.putResponse`	MQIA_DEF_PUT_RESPONSE_TYPE	`synchronous` `asynchronous`	`MQPRT_SYNC_RESPONSE` `MQPRT_ASYNC_RESPONSE`
`applicationDefaults.readAhead`	MQIA_DEF_READ_AHEAD	`no` `yes` `disabled`	`MQREADA_NO` `MQREADA_YES` `MQREADA_DISABLED`
`applicationDefaults.sharedInput`	MQIA_DEF_INPUT_OPEN_OPTION	`true` `false`	`MQOO_INPUT_SHARED` `MQOO_INPUT_EXCLUSIVE`
`queueSharingGroup.disposition`	MQIA_QSG_DISP	`copy` `group` `qmgr` `shared`	`MQQSGD_COPY` `MQQSGD_GROUP` `MQQSGD_Q_MGR` `MQQSGD_SHARED`
`queueSharingGroup.qmgrName`	No equivalent.
`queueSharingGroup.structureName`	MQCA_CF_STRUC_NAME
`dataCollection.accounting`	MQIA_ACCOUNTING_Q	`asQmgr` `off` `on`	`MQMON_Q_MGR` `MQMON_OFF` `MQMON_ON`
`dataCollection.monitoring`	MQIA_MONITORING_Q	`off` `asQmgr` `low` `medium` `high`	`MQMON_OFF` `MQMON_Q_MGR` `MQMON_LOW` `MQMON_MEDIUM` `MQMON_HIGH`
`dataCollection.statistics`	MQIA_STATISTICS_Q	`asQmgr` `off` `on`	`MQMON_Q_MGR` `MQMON_OFF` `MQMON_ON`
`storage.indexType`	MQIA_INDEX_TYPE	`none` `correlationId` `groupId` `messageId` `messageToken`	`MQIT_NONE` `MQIT_CORREL_ID` `MQIT_GROUP_ID` `MQIT_MSG_ID` `MQIT_MSG_TOKEN`
`storage.maximumMessageLength`	MQIA_MAX_MSG_LENGTH
`storage.maximumDepth`	MQIA_MAX_Q_DEPTH
`storage.messageDeliverySequence`	MQIA_MSG_DELIVERY_SEQUENCE	`priority` `fifo`	`MQMDS_PRIORITY` `MQMDS_FIFO`
`storage.nonPersistentMessageClass`	MQIA_NPM_CLASS	`normal` `high`	`MQNPM_CLASS_NORMAL` `MQNPM_CLASS_HIGH`
`storage.pageSet`	PageSetID
`storage.storageClass`	MQCA_STORAGE_CLASS
`general.description`	MQCA_Q_DESC
`general.inhibitGet`	MQIA_INHIBIT_GET	`true` `false`	`MQQA_GET_INHIBITED` `MQQA_GET_ALLOWED`
`general.inhibitPut`	MQIA_INHIBIT_PUT	`true` `false`	`MQQA_PUT_INHIBITED` `MQQA_PUT_ALLOWED`
`general.isTransmissionQueue`	MQIA_USAGE	`true` `false`	`MQUS_TRANSMISSION` `MQUS_NORMAL`
`extended.allowSharedInput`	MQIA_SHAREABILITY	`true` `false`	`MQQA_SHAREABLE` `MQQA_NOT_SHAREABLE`
`extended.backoutRequeueQueueName`	MQCA_BACKOUT_REQ_Q_NAME
`extended.backoutThreshold`	MQIA_BACKOUT_THRESHOLD
`extended.custom`	MQCA_CUSTOM
`extended.supportDistributionLists`	MQIA_DIST_LISTS	`true` `false`	`MQDL_SUPPORTED` `MQDL_NOT_SUPPORTED`
`extended.hardenGetBackout`	MQIA_HARDEN_GET_BACKOUT	`true` `false`	`MQQA_BACKOUT_HARDENED` `MQQA_BACKOUT_NOT_HARDENED`
`extended.enableMediaImageOperations`	ImageRecoverQueue	`yes` `no` `asQmgr`	`MQIMGRCOV_YES` `MQIMGRCOV_NO` `MQIMGRCOV_AS_QMGR`
`timestamps.altered`	MQCA_ALTERATION_DATE MQCA_ALTERATION_TIME
`timestamps.clustered`	MQCA_CLUSTER_DATE MQCA_CLUSTER_TIME
`timestamps.created`	MQCA_CREATION_DATE MQCA_CREATION_TIME
`status.currentDepth`	MQIA_CURRENT_Q_DEPTH
`status.lastGet`	MQCACF_LAST_GET_DATE MQCACF_LAST_GET_TIME
`status.lastPut`	MQCACF_LAST_PUT_DATE MQCACF_LAST_PUT_TIME
`status.mediaRecoveryLogExtent`	MQCACF_MEDIA_LOG_EXTENT_NAME
`status.oldestMessageAge`	MQIACF_OLDEST_MSG_AGE
`status.onQueueTime.longSamplePeriod`	MQIACF_Q_TIME_INDICATOR
`status.onQueueTime.shortSamplePeriod`	MQIACF_Q_TIME_INDICATOR
`status.openInputCount`	MQIA_OPEN_INPUT_COUNT
`status.openOutputCount`	MQIA_OPEN_OUTPUT_COUNT
`status.monitoringRate`	MQIA_MONITORING_Q	`off` `low` `medium` `high`	`MQMON_OFF` `MQMON_LOW` `MQMON_MEDIUM` `MQMON_HIGH`
`status.tPipeName`	MQCA_TPIPE_NAME
`status.uncommittedMessages`	MQIACF_UNCOMMITTED_MSGS
`applicationHandle.description`	MQCACF_APPL_DESC
`applicationHandle.tag`	MQCACF_APPL_TAG
`applicationHandle.type`	MQIA_APPL_TYPE	`queueManagerProcess` `channelInitiator` `userApplication` `batchConnection` `rrsBatchConnection` `cicsTransaction` `imsTransaction` `SystemExtension`	`MQAT_QMGR` `MQAT_CHANNEL_INITIATOR` `MQAT_USER` `MQAT_BATCH` `MQAT_RRS_BATCH` `MQAT_CICS` `MQAT_IMS` `MQAT_SYSTEM_EXTENSION`
`applicationHandle.asynchronousConsumerState`	MQIACF_ASYNC_STATE	`active` `inactive` `suspended` `suspendedTemporarily` `none`	`MQAS_ACTIVE` `MQAS_INACTIVE` `MQAS_SUSPENDED` `MQAS_SUSPENDED_TEMPORARY` `MQAS_NONE`
`applicationHandle.addressSpaceId`	MQCACF_ASID
`applicationHandle.channelName`	MQCACH_CHANNEL_NAME
`applicationHandle.connectionName`	MQCACH_CONNECTION_NAME
`applicationHandle.state`	MQIACF_HANDLE_STATE	`active` `inactive`	`MQHSTATE_ACTIVE` `MQHSTATE_INACTIVE`
`applicationHandle.openOptions`	MQIACF_OPEN_OPTIONS
`applicationHandle.processId`	MQIACF_PROCESS_ID
`applicationHandle.processSpecificationBlockName`	MQCACF_PSB_NAME
`applicationHandle.processSpecificationTableId`	MQCACF_PST_ID
`applicationHandle.qmgrTransactionId`	MQBACF_Q_MGR_UOW_ID
`applicationHandle.cicsTaskNumber`	MQCACF_TASK_NUMBER
`applicationHandle.threadId`	MQIACF_THREAD_ID
`applicationHandle.cicsTransactionId`	MQCACF_TRANSACTION_ID
`applicationHandle.unitOfWorkId`	MQBACF_EXTERNAL_UOW_ID
`applicationHandle.unitOfWorkType`	MQIACF_UOW_TYPE	`qmgr` `cics` `ims` `rrs` `xa`	`MQUOWT_Q_MGR` `MQUOWT_CICS` `MQUOWT_IMS` `MQUOWT_RRS` `MQUOWT_XA`
`applicationHandle.UserId`	MQCACF_USER_IDENTIFIER

Unsupported PCF attributes

The following queue PCF attributes are not supported by the administrative REST API:

MQIA_SCOPE
MQIA_RETENTION_INTERVAL