REST API - executeRegisteredGenericQuery

The table summarizes the REST API - executeRegisteredGenericQuery.

Request

Format 
POST <baseurl>/audit/query/execute/registered/<identifiertype>/<queryid>
Path parameters
  • identifiertype: One of guid or tag: specifies whether the GUID or the tag is used to identify the query, which was previously registered with the registerQuery operation—both are returned by registerQuery . Note, however, passing the GUID makes a more efficient query. You can also determine the GUID using the lookupQueryByTag operation.
  • queryid: The ID of the registered query, of whichever type is required by the previous parameter.
Body queryOptions element (optional): Options for the query

Response

JSON Returns a JSON representation of the content of a GenericResult element.
XML Returns the content of a GenericResult element (from the EventCollectorQueryService schema).

Example

Request 
POST <baseurl>/audit/query/execute/registered/tag/EventTag123
Response 
 <?xml version="1.0" encoding="UTF-8"?>
    <xml-fragment>
    <endPosition>3</endPosition>
    <startPosition>0</startPosition>
    <totalItems>3</totalItems>
    <resultEntry>
    <id>-1</id>
    <ref>DE_MODEL_ORGMODEL_IMPL_TYPE_DEPLOYED_SUCCESS</ref>
    <attribute xsi:type="base:DateEntryAttribute" xmlns:base="http://base.api.ec.n2.tibco.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <attributeId>17</attributeId>
    <attributeName>creationTime</attributeName>
    <type>DATE</type>
    <value>2013-01-24T15:33:43.330Z</value>
    </attribute>
    <attribute xsi:type="base:StringEntryAttribute" xmlns:base="http://base.api.ec.n2.tibco.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <attributeId>1</attributeId>
    <attributeName>messageId</attributeName>
    <type>STRING</type>
    <value>DE_MODEL_ORGMODEL_IMPL_TYPE_DEPLOYED_SUCCESS</value>
    </attribute>
    </resultEntry>
    <resultEntry>
    <id>-1</id>
    <ref>DE_ENTITY_AUDIT_CREATE_RESOURCE</ref>
    <attribute xsi:type="base:DateEntryAttribute" xmlns:base="http://base.api.ec.n2.tibco.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <attributeId>17</attributeId>
    <attributeName>creationTime</attributeName>
    <type>DATE</type>
    <value>2013-01-24T15:33:42.993Z</value>
    </attribute>
    <attribute xsi:type="base:StringEntryAttribute" xmlns:base="http://base.api.ec.n2.tibco.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <attributeId>1</attributeId>
    <attributeName>messageId</attributeName>
    <type>STRING</type>
    <value>DE_ENTITY_AUDIT_CREATE_RESOURCE</value>
    </attribute>
    </resultEntry>
    <resultEntry>
    <id>-1</id>
    <ref>DE_MODEL_ORGMODEL_IMPL_TYPE_DEPLOYED_SUCCESS</ref>
    <attribute xsi:type="base:DateEntryAttribute" xmlns:base="http://base.api.ec.n2.tibco.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <attributeId>17</attributeId>
    <attributeName>creationTime</attributeName>
    <type>DATE</type>
    <value>2013-01-24T15:33:43.567Z</value>
    </attribute>