REST API - registerComponent

The table summarizes the SOAP API - registerComponent.

Request

Format 
POST <baseurl>/audit/components/register/<name>/<version>
Path parameters
  • name: Name of the component being registered.
  • version: Version of the component being registered.
Query parameters
  • componentclass=string (mandatory): the class name of the component.
  • componentname=string (mandatory): the name of the component.
  • description=string (optional): a description of the component.
  • implementationtype=string (mandatory): the implementation type of the component, for example, CUSTOM for custom audit implementations.
  • parentid=long (optional, default=-1): the ID of the parent object.
  • revision = string (optional, default=-1): the revision number of the object.

Response

JSON Returns a JSON representation of the content of a component element.
XML Returns the content of a component element (from the EventCollectorUpdateService schema).

Example

Request 
POST <baseurl>/audit/components/register/ECCustomAudit/1.0?componentclass=com.example.eccustomaudit&componentname=ECCustomAudit/Process Packages/ECCustomAudit.xpdl&implementationtype=CUSTOM&revision=1
Response 
 {
       "xml-fragment":
       {
           "componentClass": "com.example.eccustomaudit",
           "componentName": "ECCustomAudit/Process Packages/ECCustomAudit.xpdl",
           "description":
           {
               "@nil": "true"
           },
           "id": 19,
           "implementationType": "CUSTOM",
           "name": "ECCustomAudit",
           "parentId": -1,
           "revision": 1,
           "version": 1
       }
    }