RESTful API Reference › RESTful Web Services and CA Process Automation › Catalyst REST › Module Configuration REST Examples › QueryModuleConfigs

QueryModuleConfigs

To query for module names, use the QueryModuleConfigs function.

For example, send an HTTP POST request to:

http://<hostname>:7000/node/rest/CA:00074_CA:00074:01/_ops/QueryModuleConfigs

Include a request header:

Content-Type=application/xml

The following example returns all the modules:

<QueryModuleConfigsRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                     xsi:type="p1:QueryModuleConfigsRequest"
                     xmlns:p1="http://ns.ca.com/2011/09/pam-ops" >
  <ModuleName xsi:nil="true"/>
  (Optional) <ModuleType>ALL</ModuleType>         
</QueryModuleConfigsRequest>

The following example returns the custom modules:

<QueryModuleConfigsRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                     xsi:type="p1:QueryModuleConfigsRequest"
                     xmlns:p1="http://ns.ca.com/2011/09/pam-ops" >
  <ModuleName xsi:nil="true"/>
  (Optional) <ModuleType>CUSTOM</ModuleType>         
</QueryModuleConfigsRequest>

The response contains the module names:

<?xml version="1.0" encoding="utf-8"?>
<pam-ops:QueryModuleConfigsResponse 
               xmlns:pam-ops="http://ns.ca.com/2011/09/pam-ops" 
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xsi:type="pam-ops:QueryModuleConfigsResponse">
  <Module>
    <ModuleName>FTPServices</ModuleName>
    <Name>File Transfer</Name>
    <DisplayName>File Transfer</DisplayName>
    <Description>Provides file transfer operations (FTP/SFTP).</Description>
  </Module>
  <Module>
    <ModuleName>WorkflowServices</ModuleName>
    <Name>Process Control</Name>
    <DisplayName>Process Control</DisplayName>
    <Description>Runs, monitors and controls CA Process Automation Processes.</Description>
  </Module>
  <Module>
    <ModuleName>UtilitiesGroup</ModuleName>
    <Name>Utilities</Name>
    <DisplayName>Utilities</DisplayName>
    <Description>This module consists of utility operators which are used in PAM processes</Description>
  </Module>
  <Module>
    <ModuleName>SOAP Services</ModuleName>
    <Name>Web Services</Name>
    <DisplayName>Web Services</DisplayName>
    <Description>Provides an interface to external services exposed through SOAP.</Description>
  </Module>
  <Module>
    <ModuleName>JMX.Group.Name</ModuleName>
    <Name>Java Management</Name>
    <DisplayName>Java Management</DisplayName>
    <Description>Provides a management interface to external system that support JMX.</Description>
  </Module>
  <Module>
    <ModuleName>Process Services</ModuleName>
    <Name>Command Execution</Name>
    <DisplayName>Command Execution</DisplayName>
    <Description>Runs programs and scripts on host operating environments.</Description>
  </Module>
  <Module>
    <ModuleName>Date Time Services</ModuleName>
    <Name>Date-Time</Name>
    <DisplayName>Date-Time</DisplayName>
    <Description>Executes time and calendar constraints in CA Process Automation processes.</Description>
  </Module>
  <Module>
    <ModuleName>FileService</ModuleName>
    <Name>File Management</Name>
    <DisplayName>File Management</DisplayName>
    <Description>This module monitors directory, files, and their contents</Description>
  </Module>