1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="vault_v1.html">Google Vault API</a> . <a href="vault_v1.matters.html">matters</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="vault_v1.matters.exports.html">exports()</a></code> 79</p> 80<p class="firstline">Returns the exports Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="vault_v1.matters.holds.html">holds()</a></code> 84</p> 85<p class="firstline">Returns the holds Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="vault_v1.matters.savedQueries.html">savedQueries()</a></code> 89</p> 90<p class="firstline">Returns the savedQueries Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="#addPermissions">addPermissions(matterId, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Adds an account as a matter collaborator.</p> 95<p class="toc_element"> 96 <code><a href="#close">close(matterId, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Closes the specified matter. Returns the matter with updated state.</p> 98<p class="toc_element"> 99 <code><a href="#count">count(matterId, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Counts the accounts processed by the specified query.</p> 101<p class="toc_element"> 102 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.</p> 104<p class="toc_element"> 105 <code><a href="#delete">delete(matterId, x__xgafv=None)</a></code></p> 106<p class="firstline">Deletes the specified matter. Returns the matter with updated state.</p> 107<p class="toc_element"> 108 <code><a href="#get">get(matterId, view=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Gets the specified matter.</p> 110<p class="toc_element"> 111 <code><a href="#list">list(pageSize=None, pageToken=None, state=None, view=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Lists matters the requestor has access to.</p> 113<p class="toc_element"> 114 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 115<p class="firstline">Retrieves the next page of results.</p> 116<p class="toc_element"> 117 <code><a href="#removePermissions">removePermissions(matterId, body=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Removes an account as a matter collaborator.</p> 119<p class="toc_element"> 120 <code><a href="#reopen">reopen(matterId, body=None, x__xgafv=None)</a></code></p> 121<p class="firstline">Reopens the specified matter. Returns the matter with updated state.</p> 122<p class="toc_element"> 123 <code><a href="#undelete">undelete(matterId, body=None, x__xgafv=None)</a></code></p> 124<p class="firstline">Undeletes the specified matter. Returns the matter with updated state.</p> 125<p class="toc_element"> 126 <code><a href="#update">update(matterId, body=None, x__xgafv=None)</a></code></p> 127<p class="firstline">Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.</p> 128<h3>Method Details</h3> 129<div class="method"> 130 <code class="details" id="addPermissions">addPermissions(matterId, body=None, x__xgafv=None)</code> 131 <pre>Adds an account as a matter collaborator. 132 133Args: 134 matterId: string, The matter ID. (required) 135 body: object, The request body. 136 The object takes the form of: 137 138{ # Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, the existing role is overwritten. 139 "ccMe": True or False, # Only relevant if **sendEmails** is **true**. To CC the requestor in the email message, set to **true**. To not CC requestor, set to **false**. 140 "matterPermission": { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. # The account and its role to add. 141 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 142 "role": "A String", # The user's role for the matter. 143 }, 144 "sendEmails": True or False, # To send a notification email to the added account, set to **true**. To not send a notification email, set to **false**. 145} 146 147 x__xgafv: string, V1 error format. 148 Allowed values 149 1 - v1 error format 150 2 - v2 error format 151 152Returns: 153 An object of the form: 154 155 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 156 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 157 "role": "A String", # The user's role for the matter. 158}</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="close">close(matterId, body=None, x__xgafv=None)</code> 163 <pre>Closes the specified matter. Returns the matter with updated state. 164 165Args: 166 matterId: string, The matter ID. (required) 167 body: object, The request body. 168 The object takes the form of: 169 170{ # Close a matter by ID. 171} 172 173 x__xgafv: string, V1 error format. 174 Allowed values 175 1 - v1 error format 176 2 - v2 error format 177 178Returns: 179 An object of the form: 180 181 { # Response to a CloseMatterRequest. 182 "matter": { # Represents a matter. To 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. # The updated matter, with state **CLOSED**. 183 "description": "A String", # An optional description for the matter. 184 "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter. 185 "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. 186 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 187 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 188 "role": "A String", # The user's role for the matter. 189 }, 190 ], 191 "name": "A String", # The name of the matter. 192 "state": "A String", # The state of the matter. 193 }, 194}</pre> 195</div> 196 197<div class="method"> 198 <code class="details" id="count">count(matterId, body=None, x__xgafv=None)</code> 199 <pre>Counts the accounts processed by the specified query. 200 201Args: 202 matterId: string, The matter ID. (required) 203 body: object, The request body. 204 The object takes the form of: 205 206{ # Count artifacts request. 207 "query": { # The query definition used for search and export. # The search query. 208 "accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**. 209 "emails": [ # A set of accounts to search. 210 "A String", 211 ], 212 }, 213 "corpus": "A String", # The Google Workspace service to search. 214 "dataScope": "A String", # The data source to search. 215 "driveOptions": { # Additional options for Drive search # Set Drive search-specific options. 216 "includeSharedDrives": True or False, # Set to **true** to include shared drives. 217 "includeTeamDrives": True or False, # Set to true to include Team Drive. 218 "versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. 219 }, 220 "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. 221 "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) 222 "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat). 223 "A String", 224 ], 225 }, 226 "hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only) 227 "includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms. 228 }, 229 "mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options. 230 "excludeDrafts": True or False, # Set to **true** to exclude drafts. 231 }, 232 "method": "A String", # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**. 233 "orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**. 234 "orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/). 235 }, 236 "searchMethod": "A String", # The search method to use. 237 "sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**. 238 "sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive). 239 "A String", 240 ], 241 }, 242 "startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. 243 "teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**. 244 "teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive). 245 "A String", 246 ], 247 }, 248 "terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results. 249 "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time). 250 "voiceOptions": { # Additional options for Voice search # Set Voice search-specific options. 251 "coveredData": [ # Datatypes to search 252 "A String", 253 ], 254 }, 255 }, 256 "view": "A String", # Sets the granularity of the count results. 257} 258 259 x__xgafv: string, V1 error format. 260 Allowed values 261 1 - v1 error format 262 2 - v2 error format 263 264Returns: 265 An object of the form: 266 267 { # This resource represents a long-running operation that is the result of a network API call. 268 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 269 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 270 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 271 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 272 { 273 "a_key": "", # Properties of the object. Contains field @type with type URL. 274 }, 275 ], 276 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 277 }, 278 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 279 "a_key": "", # Properties of the object. Contains field @type with type URL. 280 }, 281 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 282 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 283 "a_key": "", # Properties of the object. Contains field @type with type URL. 284 }, 285}</pre> 286</div> 287 288<div class="method"> 289 <code class="details" id="create">create(body=None, x__xgafv=None)</code> 290 <pre>Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view. 291 292Args: 293 body: object, The request body. 294 The object takes the form of: 295 296{ # Represents a matter. To 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. 297 "description": "A String", # An optional description for the matter. 298 "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter. 299 "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. 300 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 301 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 302 "role": "A String", # The user's role for the matter. 303 }, 304 ], 305 "name": "A String", # The name of the matter. 306 "state": "A String", # The state of the matter. 307} 308 309 x__xgafv: string, V1 error format. 310 Allowed values 311 1 - v1 error format 312 2 - v2 error format 313 314Returns: 315 An object of the form: 316 317 { # Represents a matter. To 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. 318 "description": "A String", # An optional description for the matter. 319 "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter. 320 "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. 321 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 322 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 323 "role": "A String", # The user's role for the matter. 324 }, 325 ], 326 "name": "A String", # The name of the matter. 327 "state": "A String", # The state of the matter. 328}</pre> 329</div> 330 331<div class="method"> 332 <code class="details" id="delete">delete(matterId, x__xgafv=None)</code> 333 <pre>Deletes the specified matter. Returns the matter with updated state. 334 335Args: 336 matterId: string, The matter ID (required) 337 x__xgafv: string, V1 error format. 338 Allowed values 339 1 - v1 error format 340 2 - v2 error format 341 342Returns: 343 An object of the form: 344 345 { # Represents a matter. To 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. 346 "description": "A String", # An optional description for the matter. 347 "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter. 348 "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. 349 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 350 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 351 "role": "A String", # The user's role for the matter. 352 }, 353 ], 354 "name": "A String", # The name of the matter. 355 "state": "A String", # The state of the matter. 356}</pre> 357</div> 358 359<div class="method"> 360 <code class="details" id="get">get(matterId, view=None, x__xgafv=None)</code> 361 <pre>Gets the specified matter. 362 363Args: 364 matterId: string, The matter ID. (required) 365 view: string, Specifies how much information about the matter to return in the response. 366 Allowed values 367 VIEW_UNSPECIFIED - The amount of detail is unspecified. Same as **BASIC**. 368 BASIC - Returns the matter ID, name, description, and state. Default choice. 369 FULL - Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission)). 370 x__xgafv: string, V1 error format. 371 Allowed values 372 1 - v1 error format 373 2 - v2 error format 374 375Returns: 376 An object of the form: 377 378 { # Represents a matter. To 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. 379 "description": "A String", # An optional description for the matter. 380 "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter. 381 "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. 382 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 383 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 384 "role": "A String", # The user's role for the matter. 385 }, 386 ], 387 "name": "A String", # The name of the matter. 388 "state": "A String", # The state of the matter. 389}</pre> 390</div> 391 392<div class="method"> 393 <code class="details" id="list">list(pageSize=None, pageToken=None, state=None, view=None, x__xgafv=None)</code> 394 <pre>Lists matters the requestor has access to. 395 396Args: 397 pageSize: integer, The number of matters to return in the response. Default and maximum are 100. 398 pageToken: string, The pagination token as returned in the response. 399 state: string, If set, lists only matters with the specified state. The default lists matters of all states. 400 Allowed values 401 STATE_UNSPECIFIED - The matter has no specified state. 402 OPEN - The matter is open. 403 CLOSED - The matter is closed. 404 DELETED - The matter is deleted. 405 view: string, Specifies how much information about the matter to return in response. 406 Allowed values 407 VIEW_UNSPECIFIED - The amount of detail is unspecified. Same as **BASIC**. 408 BASIC - Returns the matter ID, name, description, and state. Default choice. 409 FULL - Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission)). 410 x__xgafv: string, V1 error format. 411 Allowed values 412 1 - v1 error format 413 2 - v2 error format 414 415Returns: 416 An object of the form: 417 418 { # Provides the list of matters. 419 "matters": [ # List of matters. 420 { # Represents a matter. To 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. 421 "description": "A String", # An optional description for the matter. 422 "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter. 423 "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. 424 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 425 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 426 "role": "A String", # The user's role for the matter. 427 }, 428 ], 429 "name": "A String", # The name of the matter. 430 "state": "A String", # The state of the matter. 431 }, 432 ], 433 "nextPageToken": "A String", # Page token to retrieve the next page of results in the list. 434}</pre> 435</div> 436 437<div class="method"> 438 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 439 <pre>Retrieves the next page of results. 440 441Args: 442 previous_request: The request for the previous page. (required) 443 previous_response: The response from the request for the previous page. (required) 444 445Returns: 446 A request object that you can call 'execute()' on to request the next 447 page. Returns None if there are no more items in the collection. 448 </pre> 449</div> 450 451<div class="method"> 452 <code class="details" id="removePermissions">removePermissions(matterId, body=None, x__xgafv=None)</code> 453 <pre>Removes an account as a matter collaborator. 454 455Args: 456 matterId: string, The matter ID. (required) 457 body: object, The request body. 458 The object takes the form of: 459 460{ # Remove an account as a matter collaborator. 461 "accountId": "A String", # The account ID. 462} 463 464 x__xgafv: string, V1 error format. 465 Allowed values 466 1 - v1 error format 467 2 - v2 error format 468 469Returns: 470 An object of the form: 471 472 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 473}</pre> 474</div> 475 476<div class="method"> 477 <code class="details" id="reopen">reopen(matterId, body=None, x__xgafv=None)</code> 478 <pre>Reopens the specified matter. Returns the matter with updated state. 479 480Args: 481 matterId: string, The matter ID. (required) 482 body: object, The request body. 483 The object takes the form of: 484 485{ # Reopen a matter by ID. 486} 487 488 x__xgafv: string, V1 error format. 489 Allowed values 490 1 - v1 error format 491 2 - v2 error format 492 493Returns: 494 An object of the form: 495 496 { # Response to a ReopenMatterRequest. 497 "matter": { # Represents a matter. To 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. # The updated matter, with state **OPEN**. 498 "description": "A String", # An optional description for the matter. 499 "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter. 500 "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. 501 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 502 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 503 "role": "A String", # The user's role for the matter. 504 }, 505 ], 506 "name": "A String", # The name of the matter. 507 "state": "A String", # The state of the matter. 508 }, 509}</pre> 510</div> 511 512<div class="method"> 513 <code class="details" id="undelete">undelete(matterId, body=None, x__xgafv=None)</code> 514 <pre>Undeletes the specified matter. Returns the matter with updated state. 515 516Args: 517 matterId: string, The matter ID. (required) 518 body: object, The request body. 519 The object takes the form of: 520 521{ # Undelete a matter by ID. 522} 523 524 x__xgafv: string, V1 error format. 525 Allowed values 526 1 - v1 error format 527 2 - v2 error format 528 529Returns: 530 An object of the form: 531 532 { # Represents a matter. To 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. 533 "description": "A String", # An optional description for the matter. 534 "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter. 535 "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. 536 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 537 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 538 "role": "A String", # The user's role for the matter. 539 }, 540 ], 541 "name": "A String", # The name of the matter. 542 "state": "A String", # The state of the matter. 543}</pre> 544</div> 545 546<div class="method"> 547 <code class="details" id="update">update(matterId, body=None, x__xgafv=None)</code> 548 <pre>Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter. 549 550Args: 551 matterId: string, The matter ID. (required) 552 body: object, The request body. 553 The object takes the form of: 554 555{ # Represents a matter. To 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. 556 "description": "A String", # An optional description for the matter. 557 "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter. 558 "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. 559 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 560 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 561 "role": "A String", # The user's role for the matter. 562 }, 563 ], 564 "name": "A String", # The name of the matter. 565 "state": "A String", # The state of the matter. 566} 567 568 x__xgafv: string, V1 error format. 569 Allowed values 570 1 - v1 error format 571 2 - v2 error format 572 573Returns: 574 An object of the form: 575 576 { # Represents a matter. To 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. 577 "description": "A String", # An optional description for the matter. 578 "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter. 579 "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. 580 { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. 581 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 582 "role": "A String", # The user's role for the matter. 583 }, 584 ], 585 "name": "A String", # The name of the matter. 586 "state": "A String", # The state of the matter. 587}</pre> 588</div> 589 590</body></html>