Loading TOC...

GET /manage/v2/packages/{pkgname}

Summary

This resource address returns the named package (pkgname).

URL Parameters
view The view of the package. The view can be either package, differences, errors, or valid. A view of differences returns a description of how the package content differs from the current configuration. A view of errors returns a list of errors in the package. A view of valid returns the validity of the package, which can be either true (valid) or false (not valid). By default, the view is package, which means to return the package. If the view is something other than package, it is an error to specify format=zip and a filename.
filename The name of the returned package. By default the returned package is the same as pkgname.
format The format of the output. This can be either xml, or json. By default, the format is xml.
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, either application/zip, application/xml or application/json.

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

Example

 
     http://localhost:8002/manage/v2/packages/test-package

     ==> Returns the package, named "test-package," as a zip file. 

    

Comments

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