MarkLogic Server
XQUERY/XSLT API DOCUMENTATION
5.0
All XQuery & XSLT Functions
MarkLogic Built-In Functions
XQuery Library Modules
CPF Functions
W3C-Standard Functions
  W3C XQuery/XSLT Reference
W3C XQuery Functions
W3C XQuery Language
W3C XSLT Language
This page was generated
March  13,  2012
4:49  AM
XQuery & XSLT Built-In & Modules Function Reference

REST Resources API

The following table lists the APIs that correspond to the REST Resources API. Click on a function name to go directly to the detailed function description, or use the tree on the left to navigate to the functions by group.
REST Resource Summary
manage:/manage/v1/ This resource address returns summary information for the local cluster.
manage:/manage/v1/clusters This resource address returns a list of all of the clusters coupled to the local cluster.
manage:/manage/v1/clusters/{id|name} This resource address returns summary information for the specified foreign cluster.
manage:/manage/v1/clusters/{id|name}/config This resource address returns configuration information for the specified foreign cluster.
manage:/manage/v1/clusters/{id|name}/status This resource address returns status information for the specified foreign cluster.
manage:/manage/v1/databases This resource address returns a summary of the databases in the cluster.
manage:/manage/v1/databases/{id|name} This resource address returns information on the specified database.
manage:/manage/v1/databases/{id|name}/{custom} This resource address returns some custom information for the specified database, as implemented by a specific plugin.
manage:/manage/v1/databases/{id|name}/config This resource address returns the configuration information for the specified database.
manage:/manage/v1/databases/{id|name}/counts This resource address returns the count information for the forests attached to the specified database.
manage:/manage/v1/databases/{id|name}/edit This resource address returns the database configuration page in the Admin interface.
manage:/manage/v1/databases/{id|name}/status This resource address returns status information for the specified database.
manage:/manage/v1/forests This resource address returns a summary of the forests in the cluster.
manage:/manage/v1/forests?view=schema This resource address returns a schema view of the forests in the cluster.
manage:/manage/v1/forests?view=status This resource address returns a status view of the forests in the cluster.
manage:/manage/v1/forests?view=storage This resource address returns a storage view of the forests in the cluster.
manage:/manage/v1/forests/{id|name} This resource address returns information on a specific forest.
manage:/manage/v1/forests/{id|name}/{custom} This resource address returns some custom information for the specified forest, as implemented by a specific plugin.
manage:/manage/v1/forests/{id|name}/config This resource address returns the configuration information for the specified forest.
manage:/manage/v1/forests/{id|name}/counts This resource address returns the count information for the specified forest.
manage:/manage/v1/forests/{id|name}/edit This resource address returns the forest configuration page in the Admin Interface.
manage:/manage/v1/forests/{id|name}/status This resource address returns the status of the specified forest.
manage:/manage/v1/groups This resource address returns a summary of the groups in the cluster.
manage:/manage/v1/groups/{id|name} This resource address returns information on the specified group.
manage:/manage/v1/groups/{id|name}/{custom} This resource address returns some custom information for the specified group, as implemented by a specific plugin.
manage:/manage/v1/groups/{id|name}/config This resource address returns the configuration information for the specified group.
manage:/manage/v1/groups/{id|name}/counts This resource address returns the count information for the specified group.
manage:/manage/v1/groups/{id|name}/edit This resource address returns the group configuration page in the Admin Interface.
manage:/manage/v1/groups/{id|name}/status This resource address returns status information for the specified group.
manage:/manage/v1/hosts This resource address returns a summary of the hosts in the cluster.
manage:/manage/v1/hosts?view=status This resource address returns a status summary of the hosts in the cluster.
manage:/manage/v1/hosts/{id|name} This resource address returns information on a specific host.
manage:/manage/v1/hosts/{id|name}/{custom} This resource address returns some custom information for the specified host, as implemented by a specific plugin.
manage:/manage/v1/hosts/{id|name}/config This resource address returns the configuration information for the specified host.
manage:/manage/v1/hosts/{id|name}/counts This resource address returns the count information for the specified host.
manage:/manage/v1/hosts/{id|name}/edit This resource address returns the host configuration page in the Admin Interface.
manage:/manage/v1/hosts/{id|name}/status This resource address returns status information for the specified host.
manage:/manage/v1/list/package This resource address returns configuration information for the specified App Servers and/or databases.
manage:/manage/v1/package/compare This resource address is used in a POST request to import a packaged configuaration for resources to a host and compare it against the configurations of the host's local resources.
manage:/manage/v1/package/install This resource address is used in a POST request to install a packaged configuration on the local host.
manage:/manage/v1/query This resource address returns the summary of all of the resources in the local cluster.
manage:/manage/v1/requests This resource address returns a summary of the requests in the cluster.
manage:/manage/v1/requests/{id|uri} This resource address returns information on the specified request.
manage:/manage/v1/servers This resource address returns a summary of the servers in the cluster.
manage:/manage/v1/servers?view=status This resource address returns a status summary of the servers in the cluster.
manage:/manage/v1/servers/{id|name}?group-id={id|name} This resource address returns information on the specified server.
manage:/manage/v1/servers/{id|name}/{custom}?group-id={id|name} This resource address returns some custom information for the specified server, as implemented by a specific plugin.
manage:/manage/v1/servers/{id|name}/config?group-id={id|name} This resource address returns configuration information for the specified server.
manage:/manage/v1/servers/{id|name}/edit?group-id={id|name} This resource address returns the server configuration page in the Admin Interface.
manage:/manage/v1/servers/{id|name}/status?group-id={id|name} This resource address returns status information for the specified server.
manage:/manage/v1/status This resource address returns the aggregate status of the local cluster.
manage:/manage/v1/tickets/ticket/{ticket-number}/revert Each /manage/v1/package/install resource address returns ticket number.
manage:/manage/v1/transactions This resource address returns a summary of the transactions in the cluster.
manage:/manage/v1/transactions/{id|uri}?host-id={id|name} This resource address returns information on the specified transaction.
Copyright  © 2012 MarkLogic Corporation.    All rights reserved.