Viewing a destination mapping rule by using REST Administration APIs

System administrators can view a destination mapping rule by using REST Administration APIs.

You can use the REST API GET method to view configuration information about destination mapping rules in configuration domain. You can also use the REST API GET method to view monitoring statistics about destination mapping rules in a monitoring domain.

The information that is returned in a configuration domain is not the same as the information that is returned when in a monitoring domain. The configuration domain returns the configuration information for the rule. The monitoring domain returns statistical information, including the status of one or more destination mapping rules.

For more information about the monitoring URI command, see Viewing the status of destination mapping rules by using REST Administration APIs.

You can view a destination mapping rule by using REST Administration APIs, or by using the Amlen WebUI. For more information about using the Amlen WebUI to view destination mapping rules, see Configuring destination mapping rules by using the Amlen WebUI.
  • To view configuration information about all destination mapping rules, use the Eclipse Amlen REST API GET method with the following Eclipse Amlen configuration URI:

    http://<admin-endpoint-IP:Port>/ima/v1/configuration/DestinationMappingRule

  • To view configuration information about a specific destination mapping rule, use the Eclipse Amlen REST API GET method with the following Eclipse Amlen configuration URI:

    http://<admin-endpoint-IP:Port>/ima/v1/configuration/DestinationMappingRule/<NameOfDestinationMappingRule>

    Where:
    • NameOfDestinationMappingRule
      Specifies the name of the destination mapping rule you want to view.

The following example shows a GET method to display configuration details of a destination mapping rule called "MyDestinationMappingRule" by using cURL:

 curl -X GET http://127.0.0.1:9089/ima/v1/configuration/DestinationMappingRule/MyDestinationMappingRule           
         
    

The following example shows a successful example response to the GET method that was used to display configuration details of a destination mapping rule called "MyDestinationMappingRule" :


{    
  "DestinationMappingRule": {
    "MyDestinationMappingRule": {
      "QueueManagerConnection": "exampleQMC",
      "RuleType": 1,
      "Source": "/ISMRoot/Level1",
      "Destination": "Queue1",
      "MaxMessages": 6000,
      "Enabled": True,
      "RetainedMessages": True           
     }
   }
}