MarkLogic 9 Product Documentation
GET /manage/v2?view=querySummary
This resource address returns the summary of all of the resources in the local
cluster, or resources in the local cluster that match a query.
| URL Parameters |
| format |
The format of the returned data. Can be either
html, json, or xml (default). This value overrides
the Accept header if both are present. |
| name-match |
Return only those resources that contain the
specified string. |
| page-start |
Return the resource results after the specified
number of cluster resources. |
| page-length |
Return the specified number of cluster
resources in a result window. |
| Request Headers |
| Accept |
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header. |
| 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). The response body
contains the requested data.
Required Privileges
This operation requires the
manage-user role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
Use
page-start and
page-length to fetch resource information
incrementally. These parameters refer to the index and quantity of resources returned. For
example, if there are 20 resources and you want to fetch data on the 6th through 10th ones,
set
page-start=6&page-length=5.
The structure of the output returned from
this REST API is as follows:
metaProperties of the view rather than the resource.
This is a complex structure with the following children:
uriThe path to the view.
current-timeThe timestamp for when the view was generated.
elapsed-timeThe 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-minThe timestamp for filtering out more recent
requests or transactions.
view-errorAn error limiting the data in the view.
This is a complex structure with the following children:
error-typeThe kind of error.
error-nameThe name of the error.
error-codeThe error identifier.
error-messageThe error text.
query-propertiesThe properties of the query and its results.
This is a complex structure with the following children:
query-criteriaThe criteria that matches the resources.
This is a complex structure with the following children:
name-matchA case-independent substring of the name
of the resources.
page-startThe offset to the first resource in the result page.
page-lengthThe number of resources in the result page.
result-countThe total number of results.
relationsRelationships to resources.
This is a complex structure with the following children:
relation-groupRelated resources with the same type.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
relation-countThe number of related resources.
relationA specific related resource.
This is a complex structure with the following children:
qualifiersA list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifierAnother resource that qualifies the resource.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
related-viewsA list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-viewA broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-typeThe kind of view.
view-nameThe name of the view.
view-uriThe path for the view.
Example
http://localhost:8002/manage/v2/query?name-match=myData&page-length=5
==> Returns information about the first 5 resources with a name
that include "myData".
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.