Loading TOC...

GET /manage/v2/databases/{id|name}/alert/configs

Summary

Return a list of the alert configurations for the specified database. If you specify a specific alert using the uri or name parameter, then the configuration for that alert is returned.

URL Parameters
uri The URI of the alert for which to return the configuration.
name The name of the alert for which to return the configuration.
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. 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 alerts.

The following properties are returned for a specific alert configuration.

name

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.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of 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.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example


http://localhost:8002/manage/v2/databases/Documents/alert/configs

==>  Retrieve the list of alerts for the Documents database. 
    

Example


http://localhost:8002/manage/v2/databases/Documents/alert/configs?uri=my-alert-config

==>  Retrieve the alert configuration for the alert with the 
     'my-alert-config' URI for the Documents database. 
    

Comments

    Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy