QUERY HOLD (Query a retention hold)

Use this command to display information about a retention hold, such as the description, contact information, or the date and time when the hold was created. You can also list all retention sets that are affected by the hold.

Privilege class

Any administrator can issue this command.

Syntax

Read syntax diagramSkip visual syntax diagram Query HOLD hold_name Format=StandardFormat=StandardDetailed ACTive=YesACTive=NoYesBoth

Parameters

hold_name
Specifies the name of the hold to query. This parameter is optional. If you specify a hold, only that hold is considered during query processing. If you do not specify a hold, all holds are displayed.
Format
Specifies how the information is displayed. This parameter is optional. The default value is STANDARD. You can specify one of the following values:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed. For example, you can see a list of retention sets that are associated with a retention hold.
ACTive
Specifies the list of retention holds displayed is filtered by the ACTIVE parameter. This parameter is optional. The default value is YES. Possible values are:
Yes
Specifies that only active retention holds are displayed.
No
Specifies that only inactive holds are displayed. A hold is inactive after the last retention set in the hold is released.
Both
Specifies that both active and inactive holds are displayed.

Example: Display detailed information about a retention hold

Display detailed information about a retention hold that is named COURT_DOCKET_987204. See Field descriptions for field descriptions.
query hold court_docket_987204 format=detailed
             
               Hold Name: court_docket_987204
                       Active : Yes
 Number of Retention Sets Held: 1
                   Description: Hold on data required to address criminal court docket 987204
                       Contact: John Q., johnqlawyer@testing.com), 522-555-4321
        Held Retention Set IDs: 56, 83, 97
Last Update by (administrator): SERVER_CONSOLE
         Last Update Date/Time: 03/01/2019 11:47:45 AM

Field descriptions

Hold Name
The name of the hold.
Active
Indication of whether the hold is active or inactive.
Number of Retention Sets Held
The number of retention sets that are associated with the hold.
Description
A description of the hold.
Contact
The contact information for the person, for example, the lawyer or law firm that requested the hold.
Held Retention Set IDs
The retention set IDs of the retention sets that are associated with the hold.
Last Update by (administrator)
The administrator ID that defined or most recently updated the hold.
Last Update Date/Time
The date and time that an administrator defined or most recently updated the hold.

Related commands

Table 1. Commands related to QUERY HOLD
Command Description
DEFINE HOLD Define a retention set hold.
HOLD RETSET Places a retention set in a retention hold.
QUERY HOLDLOG Displays information about the hold log.
RELEASE RETSET Releases a retention set from a retention hold.
RENAME HOLD Changes the name of a hold on a retention set.
UPDATE HOLD Changes the attributes of a hold.