
MarkLogic 10 Product Documentation
admin:appserver-recurring-request-blackoutadmin:appserver-recurring-request-blackout(
   $users as xs:unsignedLong*,
   $roles as xs:unsignedLong*,
   $days as xs:string*,
   $start-time as xs:time?,
   $end-time as xs:time?,
   $duration as xs:duration?
) as element(gr:request-blackout)
Summary
      This function constructs a request-blackout specification.
    
	  
	  
	
	  
	    | Parameters | 
	  
	
	  
	    | users | 
	    
        A sequence of user ID(s) that the request blackout applies too.
       | 
	  
	  
	    | roles | 
	    
        A sequence of role ID(s) that the request blackout applies too.
       | 
	  
	  
	    | days | 
	    
        The day(s) of the week.  Must be a sequence of zero
        or more of monday, tuesday,
        wednesday, thursday,
        friday, saturday,
        sunday.
       | 
	  
	  
	    | start-time | 
	    
        A time for the request blackout to start.
       | 
	  
	  
	    | end-time | 
	    
        A time for the request blackout to end.
       | 
	  
	  
	    | duration | 
	    
        The amount of time for the blackout to last.
       | 
	  
	
Example
  xquery version "1.0-ml";
  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";
  admin:appserver-recurring-request-blackout((),(), "monday",
        xs:time("09:45:00"), xs:time("11:45:00"), () )
  (: returns the request-blackout specification :)
  
    Copyright © 2025 MarkLogic Corporation. MARKLOGIC is a
    registered trademark of MarkLogic Corporation.