Skip to main content
Top
Review meshIQ Products (G2.com)

WGS REST API Release Notes

For help learning how to use the Workgroup server REST API, see Performing REST API operations using the Swagger UI.

For detailed information about WGS REST API HTTP error codes, see WGS REST API error codes. 

Manage 11.2 release

  • The issue regarding EMS queues returning some Long attributes as Integers has been resolved. Affected endpoints:
    • GET/POST /ems/queues
    • GET/PATCH /ems/queues/{nodeName}/{managerName}/{queueName}
    • POST /ems/queues/{nodeName}/{managerName}/{queueName}/copy
  • Kafka schema registry type (Basic or Confluent) has been added. Basic is used for the TIBCO Kafka Schema Repository. Affected endpoints:
    • GET /kafka/sch-regs
    • GET/PATCH /kafka/sch-regs/{nodeName}/{clusterName}/{schRegName}
  • Query parameters 'ratesAge' and 'ratesIncrement' are required for RabbitMQ Exchange statistics read. Affected endpoints:
    • GET /rabbitmq/exchanges/{nodeName}/{serverName}/{vhostName}/{exchangeName}/stats
  • REST API operations for Solace Message VPN Client Certificate Rule Matchings have been added, along with related Conditions, Attribute Filers, and Client Username Attributes. Affected endpoints:
    • GET/POST/DELETE /solace/client-usernames/{nodeName}/{brokerName}/{msgVpnName}/{clientUsernameName}/attrs[/*]
    • GET/POST/PATCH/DELETE /solace/msg-vpns/{nodeName}/{brokerName}/{msgVpnName}/client-cert-match-rules[/*]
    • GET/POST/PATCH/DELETE /solace/msg-vpns/{nodeName}/{brokerName}/{msgVpnName}/client-cert-match-rules/{clientCertMatchRuleName}/attr-filters[/*]
    • GET/POST/DELETE /solace/msg-vpns/{nodeName}/{brokerName}/{msgVpnName}/client-cert-match-rules/{clientCertMatchRuleName}/conditions[/*]
  • New state attributes have been added for Solace Message Vpns: 'msgSpoolMsgsCnt', 'msgSpoolUsage', 'msgSpoolUsageMb'.  The enum value for 'serviceMqttAuthReqClntCert' changed from 'Allways' to 'Always'. Affected endpoints:
    • GET/POST /solace/msg-vpns
    • GET/PATCH /solace/msg-vpns/{nodeName}/{brokerName}/{msgVpnName}
  • A new state attribute has been added for both Solace Queue and Topic Endpoints: 'msgSpoolUsageMb'. Affected endpoints:
    • GET/POST /solace/queues
    • GET/PATCH /solace/queues/{nodeName}/{brokerName}/{msgVpnName}/{queueName}
    • GET/POST /solace/topic-endps
    • GET/PATCH /solace/topic-endps/{nodeName}/{brokerName}/{msgVpnName}/{topicEndpName}

 

Manage 11.1.1 release

  • Object search filters and order by have been fully reworked to allow several attributes to be used. Affected endpoints:
    • GET on requests that read multiple records and have the ability filter/order by attributes
  • Solace Bridge Remote Message VPN object operations have been added. Affected endpoints:
    • GET/POST /solace/bridges/{nodeName}/{brokerName}/{msgVpnName}/{bridgeName}/{redundancyRole}/remote-msg-vpns
    • GET/PATCH/DELETE /solace/bridges/{nodeName}/{brokerName}/{msgVpnName}/{bridgeName}/{redundancyRole}/remote-msg-vpns/{remoteMsgVpnName}/{remoteMsgVpnLocation}
  • Solace error messages have been  improved. Also, a Solace error object and its attribute errors will show the “subCode” property if it was returned from a Solace command. Affected endpoints:
    • POST/PATCH/DELETE/GET on all /solace/* endpoints

Navigator v10.5.0.15 hot fix

  • The issue with EMS queues returning some Long attributes as Integers has been resolved. Affected endpoints:
    • GET/POST /ems/queues
    • GET/PATCH /ems/queues/{nodeName}/{managerName}/{queueName}
    • POST /ems/queues/{nodeName}/{managerName}/{queueName}/copy

Navigator v10.5.0.14 hot fix

  • New state attributes have been added for Solace Message Vpns: 'msgSpoolMsgsCnt', 'msgSpoolUsage', 'msgSpoolUsageMb'. Affected endpoints:
    • GET/POST /solace/msg-vpns
    • GET/PATCH /solace/msg-vpns/{nodeName}/{brokerName}/{msgVpnName}
  • New state attributes have been added for Solace Queue and Topic Endpoints: 'msgSpoolUsageMb'. Affected endpoints:
    • GET/POST /solace/queues
    • GET/PATCH /solace/queues/{nodeName}/{brokerName}/{msgVpnName}/{queueName}
    • GET/POST /solace/topic-endps
    • GET/PATCH /solace/topic-endps/{nodeName}/{brokerName}/{msgVpnName}/{topicEndpName}

Navigator v10.5.0.13 hot fix

  • NV-631: The connection string parameters for managers is now published as the CONN_USED metric. This change affects GET on /qmgrs. See CONN_USED metric published for managers for details. NV-631 includes subtasks NV-633 (WGS Fact Publishing), NV-634 (EMS), NV-635 (Solace), NV-636 (Kafka), NV-638 (MQ Java), NV-646 (ACE/IIB).

Navigator v10.5.0.12 hot fix

  • NV-420: Specify Regex for Node and Queue Manager Parameters for Rest API Monitoring Endpoints
    The WGS REST API search statistics endpoints now accept regular expressions on nodeName, qmgrName, and, depending on the endpoint, queueName or channelName:
    • monitoring/mqi/stats
    • monitoring/channel/stats
    • monitoring/queue/stats

For example, the following queue manager name returns statistics on both TEST.QMGR.1 AND TEST.QMGR.2.

TEST.QMGR.(1|2)

The following queue name returns statistics on test queues beginning with the pattern TEST.QUEUE.K. or TEST.QUEUE.I..

TEST.QUEUE.(K.*|I.*)
  • NV-466: Issue with IBM_MQ Subscription creation. When an IBM MQ subscription is created and the Request contains both topicName and topicString, the two values are concatenated to form the topicString in the Response.
    For example, if the topicName and topicString in the Request are:
“TopicName”:  "AA.TOPIC.0",

“TopicString”: "pollUpdates"

The topicString in the response will include both:

“TopicString”: “AA.TOPIC.0/pollUpdates"
  • NV-469: The general selector field is no longer required for creating a new EMS Durable using the REST API.
  • NV-524: Report Solace error code as independent attribute. For Solace Exception errors with PCF code 85001 (EXIA_SOLACE_EXCEPTION), in previous versions, the error code from Solace was added as a string that needed to be parsed. Changes to the result formatting are explained below:
    • The "codeStr" value is "EXIA_SOLACE_EXCEPTION"
    • The "subCode" is the Solace error code for each condition. A description of subCode has been added to WGS REST API error codes. 
    • The "exception" field contains a description of the error, followed by the reason code and message in parentheses.

Examples are provided below:

Create msg-vpns

{
"type": "pcf",
"messageId": "WGS0007",
"message": "Object not created",
"explanation": "Problem on creating object, check PCF code value.",
"action": "Resubmit request with a valid object.",
"code": "85001",
"codeStr": "EXIA_SOLACE_EXCEPTION",
"exception": "ERROR: Message VPN limit reached. (reason: 135-max num exceeded)",
"subCode": "135"
}

Delete msg-vpns

{
"type": "pcf",
"messageId": "WGS0009",
"message": "Object not deleted",
"explanation": "Problem on deleting object, check PCF code value.",
"action": "Resubmit request with a valid object.",
"code": "85001",
"codeStr": "EXIA_SOLACE_EXCEPTION",
"exception": "ERROR: message-spool is shutdown (reason: 341-not active)",
"subCode": "341"
}

Create topic-endps

{
"type": "pcf",
"messageId": "WGS0007",
"message": "Object not created",
"explanation": "Problem on creating object, check PCF code value.",
"action": "Resubmit request with a valid object.",
"code": "85001",
"codeStr": "EXIA_SOLACE_EXCEPTION",
"exception": "ERROR: message-spool is shutdown (reason: 341-not active)",
"subCode": "341"
}

Delete bridges

{
"type": "pcf",
"messageId": "WGS0009",
"message": "Object not deleted",
"explanation": "Problem on deleting object, check PCF code value.",
"action": "Resubmit request with a valid object.",
"code": "85001",
"codeStr": "EXIA_SOLACE_EXCEPTION",
"exception": "ERROR: Could not get bridge 'sdfagdth' under message-vpn 'default' with vrIndex 'auto': not found (reason: 6-not found)",
"subCode": "6"
}

Create bridges

{

"type": "pcf",
"messageId": "WGS0007",
"message": "Object not created",
"explanation": "Problem on creating object, check PCF code value.",
"action": "Resubmit request with a valid object.",
"code": "85001",
"codeStr": "EXIA_SOLACE_EXCEPTION",
"exception": "ERROR: Bridge \"test\" under message-vpn \"default\" already exists. (reason: 10-already exists)",
"subCode": "10"
}

 

Navigator v10.5.0.11 hot fix

  • The IBM MQ channel attributes "securityExitName", "securityExitData", "mrExitName" and "mrExitData" will now have the string data type, not the string array data type.
    Affected endpoints:
    • GET/POST on /ibmmq/channels
    • GET/PATCH on /ibmmq/channels/{nodeName}/{qmgrName}/{type}/{channelName}
  • The EMS topic attribute "isGlobal" is now set on create/update commands.
    Affected endpoints:
    • POST on /ems/topics
    • PATCH on /ems/topics/{nodeName}/{managerName}/{topicName}
  • For Solace create/update object commands, when create or update fails, HTTP response 400 is returned, but if only some attribute updates fail, HTTP response 207 is returned. Attribute fail exceptions need to be analyzed.
    Affected endpoints:
    • POST/PATCH on all /solace/* endpoints

 

Navigator v10.5.0.10 hot fix

  • In previous versions, when a command was performed for an object, an attempt was made to determine whether the object existed in the cache. This would sometimes result in incorrect errors when the cache was not up to date. For example, when the cache did not yet include a newly created object, an HTTP status 404 would be returned. Now all requests go directly to the back end service rather than through the middle tier. HTTP response 400 errors for failures are returned from the back end service only.
    Affected endpoints:
    • POST/PATCH/DELETE on all requests
    • GET on requests which not read from cache
  • When the command PCF response code is 2085, the HTTP status 404 is returned.
    Affected endpoints:
    • POST/PATCH/DELETE on all requests
    • GET on requests which not read from cache
  • Solace error messages now retrieve readable messages rather than just a code.
    Affected endpoints:
    • POST/PATCH/DELETE/GET on all /solace/* endpoints
  • The response for IBM MQ Authority records and mqsc commands has been changed. It will now be HTTP response 207, indicating multiple responses. The error message will need to be parsed to read the real status.
    Affected endpoints:
    • POST on /qmgrs/{nodeName}/{qmgrName}/mqsc
    • POST/DELETE/GET on /qmgrs/{nodeName}/{qmgrName}/auth-recs
    • GET on /ibmmq/queues/{nodeName}/{qmgrName}/{type}/{queueName}/auth-recs
    • GET on /ibmmq/channels/{nodeName}/{qmgrName}/{type}/{channelName}/auth-recs
    • GET on /ibmmq/processes/{nodeName}/{qmgrName}/{processName}/auth-recs
    • GET on /ibmmq/topics/{nodeName}/{qmgrName}/{topicName}/auth-recs
    • GET on /ibmmq/listeners/{nodeName}/{qmgrName}/{listenerName}/auth-recs
    • GET on /ibmmq/namelists/{nodeName}/{qmgrName}/{namelistName}/auth-recs
    • GET on /ibmmq/servicess/{nodeName}/{qmgrName}/{serviceName}/auth-recs
    • GET on /ibmmq/auth-infos/{nodeName}/{qmgrName}/{authInfoName}/auth-recs
    • GET on /ibmmq/comm-infos/{nodeName}/{qmgrName}/{commInfoName}/auth-recs
  • When reading IBM MQ Authority records, now an array is always returned. An empty array signifies that there are no records.
    Affected endpoints:
    • GET on /qmgrs/{nodeName}/{qmgrName}/auth-recs
    • GET on /ibmmq/queues/{nodeName}/{qmgrName}/{type}/{queueName}/auth-recs
    • GET on /ibmmq/channels/{nodeName}/{qmgrName}/{type}/{channelName}/auth-recs
    • GET on /ibmmq/processes/{nodeName}/{qmgrName}/{processName}/auth-recs
    • GET on /ibmmq/topics/{nodeName}/{qmgrName}/{topicName}/auth-recs
    • GET on /ibmmq/listeners/{nodeName}/{qmgrName}/{listenerName}/auth-recs
    • GET on /ibmmq/namelists/{nodeName}/{qmgrName}/{namelistName}/auth-recs
    • GET on /ibmmq/servicess/{nodeName}/{qmgrName}/{serviceName}/auth-recs
    • GET on /ibmmq/auth-infos/{nodeName}/{qmgrName}/{authInfoName}/auth-recs
    • GET on /ibmmq/comm-infos/{nodeName}/{qmgrName}/{commInfoName}/auth-recs