executeGenericQuery Execute the specified query against the Event Collector database tables. (If a query needs to be executed multiple times, using the executeRegisteredQuery operation will show improved performance.)
input | impl:executeGenericQueryRequest Request message (uses base:executeGenericQueryRequest element): Specifies the details of the query that is to be executed, along with any options for the query.
| output | impl:executeGenericQueryResponse Response message (uses base:executeGenericQueryResponse element): Lists details of the events that match the specified query, along with summary information about the executed query.
| fault | impl:internalServiceFault Error message (uses ex:InternalServiceFault element): An internal service fault has occurred.
| fault | impl:invalidQueryFault Error message (uses ex:InvalidQueryFault element): The specified query was invalid.
| fault | impl:queryExecutionFault Error message (uses ex:QueryExecutionFault element): The specified query could not be executed.
| fault | impl:invalidRequestFault Error message (uses ex:InvalidRequestFault element): The request was invalid and so could not be executed.
| fault | impl:securityFault Error message (uses ex:SecurityFault): The request failed due to authentication or authorisation failure.
|
|
executeRegisteredGenericQuery Execute a query that has been previously registered using the registerQuery operation.
input | impl:executeRegisteredGenericQueryRequest Request message (uses base:executeRegisteredGenericQueryRequest element): Identifies the previously registered query that is to be executed, along with any options to be used on this particular execution of the query.
| output | impl:executeRegisteredGenericQueryResponse Response message (uses base:executeRegisteredGenericQueryResponse element): Lists details of the events that match the specified query, along with summary information about the executed query.
| fault | impl:internalServiceFault Error message (uses ex:InternalServiceFault element): An internal service fault has occurred.
| fault | impl:invalidQueryIdentifierFault Error message (uses ex:InvalidQueryIdentifierFault element): The query identifier used (guid or tag) is invalid.
| fault | impl:queryExecutionFault Error message (uses ex:QueryExecutionFault element): The specified query could not be executed.
| fault | impl:queryNotFoundFault Error message (uses ex:QueryNotFoundFault element): No registered query was found matching the specified tag or guid.
| fault | impl:invalidRequestFault Error message (uses ex:InvalidRequestFault element): The request was invalid and so could not be executed.
| fault | impl:securityFault Error message (uses ex:SecurityFault): The request failed due to authentication or authorisation failure.
|
|
getAllAttributes List all attributes registered in the Event Collector database tables.
input | impl:getAllAttributesRequest Request message (uses base:getAllAttributesRequest element): This message has no parameters.
| output | impl:getAllAttributesResponse Response message (uses base:getAllAttributesResponse element): Lists the details of all attributes registered in the Event Collector database.
| fault | impl:internalServiceFault Error message (uses ex:InternalServiceFault element): An internal service fault has occurred.
| fault | impl:securityFault Error message (uses ex:SecurityFault): The request failed due to authentication or authorisation failure.
|
|
getAttributes List all attributes in the Event Collector database tables that are registered for a specific component.
input | impl:getAttributesRequest Request message (uses base:getAttributesRequest element): Specifies the identifier of the component for which attributes should be listed.
| output | impl:getAttributesResponse Response message (uses base:getAttributesResponse element): Lists the details of all attributes registered in the Event Collector database for the specified component.
| fault | impl:internalServiceFault Error message (uses ex:InternalServiceFault element): An internal service fault has occurred.
| fault | impl:noSuchComponentFault Error message (uses ex:NoSuchComponentFault element): The identifier used to specify the component is invalid.
| fault | impl:invalidRequestFault Error message (uses ex:InvalidRequestFault element): The request was invalid and so could not be executed.
| fault | impl:securityFault Error message (uses ex:SecurityFault): The request failed due to authentication or authorisation failure.
|
|
isQueryRegistered Test whether a query is registered with Event Collector. (This can be useful for determining whether a frequently used query tag is already present on the system.)
input | impl:isQueryRegisteredRequest Request message (uses base:isQueryRegisteredRequest element): Identifies the query that is to be tested.
| output | impl:isQueryRegisteredResponse Response message (uses base:isQueryRegisteredResponse element): Returns whether the query is registered with Event Collector.
| fault | impl:internalServiceFault Error message (uses ex:InternalServiceFault element): An internal service fault has occurred.
| fault | impl:invalidQueryIdentifierFault Error message (uses ex:invalidQueryidentifierFault element): The specified query identifier is invalid.
| fault | impl:invalidRequestFault Error message (uses ex:invalidRequestFault element): The request was invalid and so could not be executed.
| fault | impl:securityFault Error message (uses ex:SecurityFault): The request failed due to authentication or authorisation failure.
|
|
registerQuery Register a query with Event Collector, so that it can be subsequently executed using the executeRegisteredGenericQuery operation.
input | impl:registerQueryRequest Request message (uses base:registerQueryRequest element): Specifies the query to be registered and a tag with which to identify it.
| output | impl:registerQueryResponse Response message (uses base:registerQueryResponse element): Lists the guid and tag for the newly registered query.
| fault | impl:internalServiceFault Error message (uses ex:InternalServiceFault element): An internal service fault has occurred.
| fault | impl:invalidQueryFault Error message (uses ex:invalidQueryFault element): The query could not be registered because the query specification is invalid.
| fault | impl:invalidRequestFault Error message (uses ex:InvalidRequestFault element): The request was invalid and so could not be executed.
| fault | impl:duplicateRegistrationFault Error message (uses ex:DuplicateRegistrationFault element): The tag specified for the query is already used by another registered query.
| fault | impl:securityFault Error message (uses ex:SecurityFault): The request failed due to authentication or authorisation failure.
|
|
unRegisterQuery Unregister a previously registered query.
input | impl:unRegisterQueryRequest Request message (uses base:unRegisteryQueryRequest element): Identifies the query that is to be unregistered (using either a guid or tag).
| output | impl:unRegisterQueryResponse Response message (uses base:unRegisteryQueryResponse element): This message has no parameters.
| fault | impl:internalServiceFault Error message (uses ex:InternalServiceFault element): An internal service fault has occurred.
| fault | impl:invalidQueryIdentifierFault Error message (uses ex:InvalidQueryIdentifier element): The tag or guid used to identify the query is invalid.
| fault | impl:queryNotFoundFault Error message (uses ex:QueryNotFoundFault element): No registered query was found matching the specified tag or guid.
| fault | impl:invalidRequestFault Error message (uses ex:invalidRequestFault element): The request was invalid and so could not be executed.
| fault | impl:securityFault Error message (uses ex:SecurityFault): The request failed due to authentication or authorisation failure.
|
|
getComponents List the components that are registered on the system.
input | impl:getComponentsRequest Request message (uses base:getComponentsRequest element): This message has no parameters.
| output | impl:getComponentsResponse Response message (uses base:getComponentsResponse element): Lists the details of each component that is registered on the system.
| fault | impl:internalServiceFault Error message (uses ex:InternalServiceFault element): An internal service fault has occurred.
| fault | impl:securityFault Error message (uses ex:SecurityFault): The request failed due to authentication or authorisation failure.
|
|
lookupQueryByTag List the details for a particular query (identified by its tag). This operation can be used to obtain the guid for a registered query. The executeRegisteredGenericQuery operation executes faster if the query is identified using its guid rather than its tag.
input | impl:lookupQueryByTagRequest Request message (uses base:lookupQueryByTagRequest element): Specifies the tag to be used to look up the query.
| output | impl:lookupQueryByTagResponse Response message (uses base:lookupQueryByTagResponse element): Lists the details of the specified query, including its identifier.
| fault | impl:internalServiceFault Error message (uses ex:InternalServiceFault element): An internal service fault has occurred.
| fault | impl:queryNotFoundFault Error message (uses ex:QueryNotFoundFault element): No registered query was found matching the specified tag.
| fault | impl:invalidRequestFault Error message (uses ex:invalidRequestFault element): The request was invalid and so could not be executed.
| fault | impl:securityFault Error message (uses ex:SecurityFault): The request failed due to authentication or authorisation failure.
|
|