Loading TOC...

POST /v1/temporal/collections/{name}

Summary

Manage the state of a temporal collection.

URL Parameters
result? Required. Specify the desired result of the operation. Allowed values: advance-lsqt.
lag? Optional. Specify the lag to be behind system start time, in seconds. The value must be convertible to xs:long.
database? Optional. Perform this operation on the named content database instead of the default content database associated with the REST API instance. Using an alternative database requires the "eval-in" privilege; for details, see Security Requirements in the REST Application Developer's Guide.
Response Headers
ML-LSQT MarkLogic returns the current LSQT in this header.

Response

When you use result=advance-lsqt, upon success, MarkLogic Server returns status 204 (Advanced LSQT), and the response headers include a ML-LSQT header containing the current LSQT.

Required Privileges

This operation requires the rest-admin role, or the following privileges:

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

http://marklogic.com/xdmp/privileges/rest-writer

http://marklogic.com/xdmp/privileges/rest-reader

Usage Notes

The named temporal collection must exist. When you use result=advance-lsqt, this request is similar to calling the XQuery function temporal:advance-lsqt or the Server-Side JavaScript function temporal.advanceLsqt. You must have LSQT enabled on the collection in order to use advance-lsqt.

See Also

Example

curl --anyauth --user user:password -X POST -i \
  -d "" -H "Content-type: text/plain" \
  'http://localhost:8000/v1/temporal/collections/kool?result=advance-lsqt'

==> LSQT is advanced on the temporal collection named "kool"

HTTP/1.1 204 Advanced LSQT
ML-LSQT: 1601-01-01T00:00:00Z
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
  

Comments

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