Loading TOC...

GET /manage/v2/databases/{id|name}?view=package

Summary

This resource address returns configuration details about the named database in a format suitable for use with the /manage/v2/packages interfaces. The database can be identifed either by id or name.

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.
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), and the response body contains the requested data. If the URI is malformed or the database doesn't 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

You can request a package view as HTML, XML, or JSON, but only the XML and JSON formats can be used as input to the /manage/v2/packages interfaces, such as POST /manage/v2/packages/{pkgname}.

Example


http://localhost:8002/manage/v2/databases/Documents?view=package

==> Returns the package representation of the Documents database
    

Comments

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