MarkLogic 9 Product Documentation
GET /manage/v2/amps/{id|name}/properties

Summary

This resource address returns the properties of the specified amp.

URL Parameters
format	The format of the returned data. Can be either `json` or `xml` (default). This value overrides the Accept header if both are present.
namespace	The namespace in which the amped function is defined. This is a required parameter.
document-uri	The URI of the document in which the amped function is defined. This is a required parameter.
modules-database	The name of the modules database, or omit to specify the filesystem.

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. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges. A status code of 404 (no such user) is returned if the user does not exist.

Required Privileges

This operation requires the security and manage-admin roles.

Usage Notes

The structure of the output returned from this REST API is as follows:

local-name

A function local-name.

namespace

A namespace.

document-uri

A document's URI.

modules-database

A database the module is found in.

roles

The roles assigned. The roles assigned to the user.

This is a complex structure with the following children:

role: A role identifier (unique key).

Example