MarkLogic 10 Product Documentation
POST /manage/v2/amps

Summary

This resource address creates a new amp in the Security database.

URL Parameters
format The format of the posted 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 request body. If the format? parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
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.
Location If the request causes a restart, a Location header is included in the reponse. The header contains a path with which to construct a URL to usable to test when the restart has completed.

Response

Upon success, MarkLogic Server returns status code 201 (Created). If the privilege already exists or if the payload is malformed, 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 one of the following:

Usage Notes

The structure of the data in the request body is as follows. All of the properties are required. If the module is on the filesystem, use the empty string for the modules database.

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


newamp.json

{
  "namespace": "http://example.com/uri",
  "local-name": "local",
  "document-uri": "/module/path/name",
  "modules-database": "",
  "role": [
    "a",
    "b",
    "c"
  ]
}

curl -X POST  --anyauth -u admin:admin -H "Content-Type:application/json" \
-d @newamp.json http://localhost:8002/manage/v2/amps

==>  Creates a new amp, named "local," in the Security database.
Powered by MarkLogic Server | Terms of Use | Privacy Policy