Loading TOC...

dls:document-checkout-status

dls:document-checkout-status(
   uri as xs:string
) as element(dls:checkout)?

Summary

This function returns a checkout element containing the checkout status of the specified document.

Parameters
uri The URI of the document.

Required Privileges

The dls-user role is required to run this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user

Example

  xquery version "1.0-ml";

  import module namespace dls = "http://marklogic.com/xdmp/dls" 
      at "/MarkLogic/dls.xqy";

  dls:document-checkout-status("/foo/bar/baz.xml")

  =>

  <dls:checkout xmlns:dls="http://marklogic.com/xdmp/dls">
    <dls:document-uri>/foo/bar/baz.xml</dls:document-uri>
    <dls:annotation>updating doc</dls:annotation>
    <dls:timeout>3600</dls:timeout>
    <dls:timestamp>1239057381</dls:timestamp>  
    <sec:user-id xmlns:sec="http://marklogic.com/xdmp/security">10677693687367813363</sec:user-id>
  </dls:checkout>
   

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.