SOAP API - registerAttributes

The table summarizes the SOAP API - registerAttributes.

Request Uses the registerAttributesRequestelement (from the EventCollectorUpdateService schema).
Parameter notes
  • componentId: the ID of the component that the attributes are being registered against. This is the id returned from a call to registerComponent or getComponents .
  • AttributeDefinition: each entry is the definition of one attribute being registered. TIBCO recommends that you specify at least the following parameters for each attribute:
    • name: unique name of the attribute.
    • type: one of DATE, INT, STRING, BOOLEAN, LONG, or DOUBLE.

      Do not enter a value for:

    • id: this will be specified in the response.
Response Returns a registerAttributesResponseelement (from the EventCollectorUpdateService schema).
Example Request:
<soapenv:Body>
      <api:registerAttributesRequest>
         <componentId>20</componentId>
         <base:AttributeDefinition>
            <category>CUSTOM</category>
            <name>customAttr1</name>
            <type>STRING</type>
         </base:AttributeDefinition>
         <base:AttributeDefinition>
            <category>CUSTOM</category>
            <name>customAttr2</name>
            <type>LONG</type>
         </base:AttributeDefinition>
      </api:registerAttributesRequest>
</soapenv:Body>
Response:
<SOAP-ENV:Body>
      <registerAttributesResponse xmlns="http://api.ec.n2.tibco.com">
         <AttributeDefinition xmlns="http://base.api.ec.n2.tibco.com">
            <category xmlns="">CUSTOM</category>
            <componentId xmlns="">20</componentId>
            <id xmlns="">275</id>
            <isPrimary xmlns="">false</isPrimary>
            <length xmlns="">-1</length>
            <name xmlns="">customAttr1</name>
            <type xmlns="">STRING</type>
         </AttributeDefinition>
         <AttributeDefinition xmlns="http://base.api.ec.n2.tibco.com">
            <category xmlns="">CUSTOM</category>
            <componentId xmlns="">20</componentId>
            <id xmlns="">274</id>
            <isPrimary xmlns="">false</isPrimary>
            <length xmlns="">-1</length>
            <name xmlns="">customAttr2</name>
            <type xmlns="">LONG</type>
         </AttributeDefinition>
      </registerAttributesResponse>
</soapenv:Body>