SOAP API - registerComponent

The table summarizes the SOAP API - registerComponent.

Request Uses the registerComponentRequest element (from the EventCollectorUpdateService schema).
Parameter notes
  • Only the name and version of the component being registered are mandatory.
  • id and parentId: leave these blank in the request; any values that you do enter are ignored. These parameters will be populated in the response message.
  • implementationType: for example, CUSTOM for custom audit implementations.
Response Returns a registerComponentResponse element (from the EventCollectorUpdateService schema).
Example Request: 
<soapenv:Body>
      <api:registerComponentRequest>
         <base:Component>
            <componentClass>com.example.eccustomaudit</componentClass>
            <componentName>ECCustomAudit/Process Packages/ECCustomAudit.xpdl</componentName>
            <description>Custom Audit Trail</description>
            <implementationType>CUSTOM</implementationType>
            <name>ECCustomAudit</name>
            <revision>1</revision>
            <version>1.0</version>
         </base:Component>
      </api:registerComponentRequest>
</soapenv:Body>
Response: 
<SOAP-ENV:Body>
      <registerComponentResponse xmlns="http://api.ec.n2.tibco.com">
         <Component xmlns="http://base.api.ec.n2.tibco.com">
            <componentClass xmlns="">com.example.eccustomaudit</componentClass>
            <componentName xmlns="">ECCustomAudit</componentName>
            <description xmlns="">Custom audit trail</description>
            <id xmlns="">19</id>
            <implementationType xmlns="">CUSTOM</implementationType>
            <name xmlns="">ECCustomAudit</name>
            <parentId xmlns="">-1</parentId>
            <revision xmlns="">1</revision>
            <version xmlns="">1.0</version>
         </Component>
      </registerComponentResponse>
   </SOAP-ENV:Body>