![](/apidoc/images/printerFriendly.png)
MarkLogic 9 Product Documentation
GET /manage/v2/databases/{id|name}/triggersSummary
Return a list of the alert triggers for the specified database. If you specify
a specific alert using the uri
or name
parameter, then the list of
triggers for that alert is returned.
URL Parameters |
uri |
The URI of the alert for which to return the triggers. |
name |
The name of the alert for which to return the
triggers. |
format |
The format of the data in the response body.
Allowed values: html , json or xml (default). Use this
parameter to override the Accept header. |
Request Headers |
Accept |
The desired MIME type of the data in the response
body. If the format parameter is present, it takes precedence over this header.
Supported values: application/xml (default), application/json ,
text/html . |
Response Headers |
Content-type |
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml , application/json , or text/html .
|
Response
Upon success, MarkLogic server returns status code 200 (OK) and the response
body contains the requested data. If the alert does not exist, a status code of 400 (Bad
Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not
have the necessary privileges.
Required Privileges
This operation requires the
manage-user
role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The following properties are returned for a list of triggers.
meta
Properties of the view rather than the resource.
This is a complex structure with the following children:
uri
The path to the view.
current-time
The timestamp for when the view was generated.
elapsed-time
The time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-min
The timestamp for filtering out more recent
requests or transactions.
view-error
An error limiting the data in the view.
This is a complex structure with the following children:
error-type
The kind of error.
error-name
The name of the error.
error-code
The error identifier.
error-message
The error text.
list-items
Items of this resource type.
This is a complex structure with the following children:
list-count
The number of items of this resource type.
list-item
An item of this resource type.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
item-summary
Example
http://localhost:8002/manage/v2/databases/Documents/triggers
==> Retrieve the list of triggers for the Documents database.
Example
http://localhost:8002/manage/v2/databases/myTriggers/triggers?uri=my-alert-config
==> Retrieve the triggers for the alert with the 'my-alert-config' URI
for the myTriggers database.
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.