REST Resource: matters.savedQueries
Stay organized with collections
Save and categorize content based on your preferences.
Resource: SavedQuery
The definition of a saved query.
To work with Vault resources, the account must have the required Vault privileges and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the View All Matters privilege.
JSON representation |
{
"savedQueryId": string,
"displayName": string,
"query": {
object (Query )
},
"matterId": string,
"createTime": string
} |
Fields |
savedQueryId |
string
A unique identifier for the saved query.
|
displayName |
string
The name of the saved query.
|
query |
object (Query )
The search parameters of the saved query.
|
matterId |
string
Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL.
|
createTime |
string (Timestamp format)
Output only. The server-generated timestamp when the saved query was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
|
Methods |
|
Creates a saved query. |
|
Deletes the specified saved query. |
|
Retrieves the specified saved query. |
|
Lists the saved queries in a matter. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-17 UTC.
[null,null,["Last updated 2025-03-17 UTC."],[],[],null,["# REST Resource: matters.savedQueries\n\n- [Resource: SavedQuery](#SavedQuery)\n - [JSON representation](#SavedQuery.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: SavedQuery\n--------------------\n\nThe definition of a saved query.\n\nTo work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"savedQueryId\": string, \"displayName\": string, \"query\": { object (/workspace/vault/reference/rest/v1/Query) }, \"matterId\": string, \"createTime\": string } ``` |\n\n| Fields ||\n|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `savedQueryId` | `string` A unique identifier for the saved query. |\n| `displayName` | `string` The name of the saved query. |\n| `query` | `object (`[Query](/workspace/vault/reference/rest/v1/Query)`)` The search parameters of the saved query. |\n| `matterId` | `string` Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL. |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The server-generated timestamp when the saved query was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------|--------------------------------------|\n| ### [create](/workspace/vault/reference/rest/v1/matters.savedQueries/create) | Creates a saved query. |\n| ### [delete](/workspace/vault/reference/rest/v1/matters.savedQueries/delete) | Deletes the specified saved query. |\n| ### [get](/workspace/vault/reference/rest/v1/matters.savedQueries/get) | Retrieves the specified saved query. |\n| ### [list](/workspace/vault/reference/rest/v1/matters.savedQueries/list) | Lists the saved queries in a matter. |"]]