Loading TOC...

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

Summary

This resource sets the LSQT 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

The structure of the data in the request body is as follows:

lsqt-enabled

Enable lsqt behaviour on temporal collection in context database

automation

Enable automation and set automation period & lag.

Example


curl -X PUT --anyauth -u admin:admin --header "Content-Type:application/json" \
-d '{
  "lsqt-enabled": true,
  "automation": {
    "enabled": true,
    "period": 5000
  }
}' \
http://localhost:8002/manage/v2/databases/Documents/temporal/collections/lsqt/properties?collection=mycollection

==> Enaables LSQT automation (with a period of 5000 milliseconds) on the collection, 
    "mycollection," in the Documents database.
    

Comments

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