Loading TOC...

PUT /manage/v2/databases/{id|name}/temporal/collections/properties?collection={name}

Summary

This resource sets the optional properties on the specified temporal collection.

URL Parameters
collection The name of the collection.
format The format of the returned data. Can be either 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.
Content-type The MIME type of the data in the request body, either application/xml or application/json.
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 202 (Accepted), and the response body contains the requested data. If the payload is malformed or the collection 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 temporal-admin role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage-admin

Usage Notes

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, options is expressed in singular form. For example, in JSON, options is instead option and the format is: "option":["opt"].

The valid options are:
updates-admin-override
Specifies that users with the admin role can change or delete temporal documents using non-temporal functions, such as xdmp:document-insert and xdmp:document-delete.
updates-safe
Specifies that no users, including those with the admin role, can change or delete temporal documents in a non-temporal manner. This is the default.
Options are specified using the form:

      {
        "option": ["updates-safe"]
      }
     

Example


curl -X PUT --anyauth -u admin:admin --header "Content-Type:application/json" \
-d '{"option": ["updates-admin-override"]}' \
http://localhost:8002/manage/v2/databases/Documents/temporal/collections/properties?collection=mycollection

==> Sets the "updates-admin-override" option on the collection, "mycollection," 
    in the Documents database.
    

Comments

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