REST API and PCF equivalents for subscriptions
For most REST API optional query parameters and attributes for subscriptions, an equivalent PCF parameter or attribute exists. Use the tables that are provided to understand these equivalents.
Optional query parameter equivalents
| 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 |
Subscription attribute equivalents
| REST API attribute | PCF attribute | Related values (REST API) | Related values (PCF) |
|---|---|---|---|
| name | MQCACF_SUB_NAME | ||
| id | MQBACF_SUB_ID | ||
| resolvedTopicString | MQCA_TOPIC_STRING | ||
| topic.name | MQCA_TOPIC_NAME | ||
| topic.definedString | MQCA_TOPIC_STRING | ||
| selector.value | MQCACF_SUB_SELECTOR | ||
| selector.type | MQIACF_SELECTOR_TYPE |
none standard extended |
MQSELTYPE_NONE MQSELTYPE_STANDARD MQSELTYPE_EXTENDED |
| destination.isManaged | MQIACF_DESTINATION_CLASS |
true false |
MQDC_MANAGED MQDC_PROVIDED |
| destination.qmgrName | MQCACF_DESTINATION_Q_MGR | ||
| destination.name | MQCACF_DESTINATION | ||
| destination.correlationId | MQBACF_DESTINATION_CORREL_ID | ||
| user.accountingToken | MQBACF_ACCOUNTING_TOKEN | ||
| user.applicationIdentityData | MQCACF_APPL_IDENTITY_DATA | ||
| user.data | MQCACF_SUB_USER_DATA | ||
| user.name | MQCACF_SUB_USER_ID | ||
| user.isVariable | MQIACF_VARIABLE_USER_ID |
true false |
MQVU_ANY_USER MQVU_FIXED_USER |
| general.isDurable | MQIACF_DURABLE_SUBSCRIPTION |
true false |
MQSUB_DURABLE_YES MQSUB_DURABLE_NO |
| general.type | MQIACF_SUB_TYPE |
administrative api proxy |
MQSUBTYPE_ADMIN MQSUBTYPE_API MQSUBTYPE_PROXY |
| general.usesCharacterWildcard | MQIACF_WILDCARD_SCHEMA |
true false |
MQWS_CHAR MQWS_TOPIC |
| extended.expiry | MQIACF_EXPIRY | ||
| extended.level | MQIACF_SUB_LEVEL | ||
| extended.messagePriority | MQIACF_PUB_PRIORITY |
asPublished asQueue |
MQPRI_PRIORITY_AS_PUBLISHED MQPR_PRIORITY_AS_QDEF |
| extended.messagePropertyControl | MQIACF_PUBSUB_PROPERTIES |
none compatible pcf rfh2 |
MQPSPROP_NONE MQPSPROP_COMPAT MQPSPROP_MSGPROP MQPSPROP_RFH2 |
| extended.deliverOnRequest | MQIACF_REQUEST_ONLY |
true false |
MQRU_PUBLISH_ON_REQUEST MQRU_PUBLISH_ALL |
| extended.networkScope | MQIACF_SUBSCRIPTION_SCOPE |
all qmgr |
MQTSCOPE_ALL MQTSCOPE_QMGR |
| timestamps.altered |
MQCA_ALTERATION_DATE MQCA_ALTERATION_TIME |
||
| timestamps.created |
MQCA_CREATION_DATE MQCA_CREATION_TIME |
Unsupported PCF parameters
The following subscription PCF inquire parameters are not supported by the administrative REST API:- MQIA_DISPLAY_TYPE
- MQIACF_SUB_TYPE
- MQIACF_SUB_ATTRS
Parent topic: REST API and PCF equivalents