| OLD | NEW |
|---|
| (Empty) | |
| 1 { |
| 2 "basePath": "", |
| 3 "baseUrl": "https://vault.googleapis.com/", |
| 4 "batchPath": "batch", |
| 5 "canonicalName": "Vault", |
| 6 "description": "", |
| 7 "discoveryVersion": "v1", |
| 8 "documentationLink": "https://apps.google.com/products/vault/", |
| 9 "icons": { |
| 10 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 11 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 12 }, |
| 13 "id": "vault:v1", |
| 14 "kind": "discovery#restDescription", |
| 15 "name": "vault", |
| 16 "ownerDomain": "google.com", |
| 17 "ownerName": "Google", |
| 18 "parameters": { |
| 19 "quotaUser": { |
| 20 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 21 "location": "query", |
| 22 "type": "string" |
| 23 }, |
| 24 "pp": { |
| 25 "default": "true", |
| 26 "description": "Pretty-print response.", |
| 27 "location": "query", |
| 28 "type": "boolean" |
| 29 }, |
| 30 "bearer_token": { |
| 31 "description": "OAuth bearer token.", |
| 32 "location": "query", |
| 33 "type": "string" |
| 34 }, |
| 35 "oauth_token": { |
| 36 "description": "OAuth 2.0 token for the current user.", |
| 37 "location": "query", |
| 38 "type": "string" |
| 39 }, |
| 40 "upload_protocol": { |
| 41 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 42 "location": "query", |
| 43 "type": "string" |
| 44 }, |
| 45 "prettyPrint": { |
| 46 "default": "true", |
| 47 "description": "Returns response with indentations and line breaks."
, |
| 48 "location": "query", |
| 49 "type": "boolean" |
| 50 }, |
| 51 "fields": { |
| 52 "description": "Selector specifying which fields to include in a par
tial response.", |
| 53 "location": "query", |
| 54 "type": "string" |
| 55 }, |
| 56 "uploadType": { |
| 57 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 58 "location": "query", |
| 59 "type": "string" |
| 60 }, |
| 61 "$.xgafv": { |
| 62 "description": "V1 error format.", |
| 63 "enum": [ |
| 64 "1", |
| 65 "2" |
| 66 ], |
| 67 "enumDescriptions": [ |
| 68 "v1 error format", |
| 69 "v2 error format" |
| 70 ], |
| 71 "location": "query", |
| 72 "type": "string" |
| 73 }, |
| 74 "callback": { |
| 75 "description": "JSONP", |
| 76 "location": "query", |
| 77 "type": "string" |
| 78 }, |
| 79 "alt": { |
| 80 "default": "json", |
| 81 "description": "Data format for response.", |
| 82 "enum": [ |
| 83 "json", |
| 84 "media", |
| 85 "proto" |
| 86 ], |
| 87 "enumDescriptions": [ |
| 88 "Responses with Content-Type of application/json", |
| 89 "Media download with context-dependent Content-Type", |
| 90 "Responses with Content-Type of application/x-protobuf" |
| 91 ], |
| 92 "location": "query", |
| 93 "type": "string" |
| 94 }, |
| 95 "access_token": { |
| 96 "description": "OAuth access token.", |
| 97 "location": "query", |
| 98 "type": "string" |
| 99 }, |
| 100 "key": { |
| 101 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 102 "location": "query", |
| 103 "type": "string" |
| 104 } |
| 105 }, |
| 106 "protocol": "rest", |
| 107 "resources": { |
| 108 "matters": { |
| 109 "methods": { |
| 110 "undelete": { |
| 111 "description": "Undeletes the specified matter. Returns matt
er with updated state.", |
| 112 "httpMethod": "POST", |
| 113 "id": "vault.matters.undelete", |
| 114 "parameterOrder": [ |
| 115 "matterId" |
| 116 ], |
| 117 "parameters": { |
| 118 "matterId": { |
| 119 "description": "The matter ID.", |
| 120 "location": "path", |
| 121 "required": true, |
| 122 "type": "string" |
| 123 } |
| 124 }, |
| 125 "path": "v1/matters/{matterId}:undelete", |
| 126 "request": { |
| 127 "$ref": "UndeleteMatterRequest" |
| 128 }, |
| 129 "response": { |
| 130 "$ref": "Matter" |
| 131 } |
| 132 }, |
| 133 "get": { |
| 134 "description": "Gets the specified matter.", |
| 135 "httpMethod": "GET", |
| 136 "id": "vault.matters.get", |
| 137 "parameterOrder": [ |
| 138 "matterId" |
| 139 ], |
| 140 "parameters": { |
| 141 "matterId": { |
| 142 "description": "The matter ID.", |
| 143 "location": "path", |
| 144 "required": true, |
| 145 "type": "string" |
| 146 }, |
| 147 "view": { |
| 148 "description": "Specifies which parts of the Matter
to return in the response.", |
| 149 "enum": [ |
| 150 "VIEW_UNSPECIFIED", |
| 151 "BASIC", |
| 152 "FULL" |
| 153 ], |
| 154 "location": "query", |
| 155 "type": "string" |
| 156 } |
| 157 }, |
| 158 "path": "v1/matters/{matterId}", |
| 159 "response": { |
| 160 "$ref": "Matter" |
| 161 } |
| 162 }, |
| 163 "close": { |
| 164 "description": "Closes the specified matter. Returns matter
with updated state.", |
| 165 "httpMethod": "POST", |
| 166 "id": "vault.matters.close", |
| 167 "parameterOrder": [ |
| 168 "matterId" |
| 169 ], |
| 170 "parameters": { |
| 171 "matterId": { |
| 172 "description": "The matter ID.", |
| 173 "location": "path", |
| 174 "required": true, |
| 175 "type": "string" |
| 176 } |
| 177 }, |
| 178 "path": "v1/matters/{matterId}:close", |
| 179 "request": { |
| 180 "$ref": "CloseMatterRequest" |
| 181 }, |
| 182 "response": { |
| 183 "$ref": "CloseMatterResponse" |
| 184 } |
| 185 }, |
| 186 "update": { |
| 187 "description": "Updates the specified matter.\nThis updates
only the name and description of the matter, identified by\nmatter id. Changes t
o any other fields are ignored.\nReturns the default view of the matter.", |
| 188 "httpMethod": "PUT", |
| 189 "id": "vault.matters.update", |
| 190 "parameterOrder": [ |
| 191 "matterId" |
| 192 ], |
| 193 "parameters": { |
| 194 "matterId": { |
| 195 "description": "The matter ID.", |
| 196 "location": "path", |
| 197 "required": true, |
| 198 "type": "string" |
| 199 } |
| 200 }, |
| 201 "path": "v1/matters/{matterId}", |
| 202 "request": { |
| 203 "$ref": "Matter" |
| 204 }, |
| 205 "response": { |
| 206 "$ref": "Matter" |
| 207 } |
| 208 }, |
| 209 "delete": { |
| 210 "description": "Deletes the specified matter. Returns matter
with updated state.", |
| 211 "httpMethod": "DELETE", |
| 212 "id": "vault.matters.delete", |
| 213 "parameterOrder": [ |
| 214 "matterId" |
| 215 ], |
| 216 "parameters": { |
| 217 "matterId": { |
| 218 "description": "The matter ID", |
| 219 "location": "path", |
| 220 "required": true, |
| 221 "type": "string" |
| 222 } |
| 223 }, |
| 224 "path": "v1/matters/{matterId}", |
| 225 "response": { |
| 226 "$ref": "Matter" |
| 227 } |
| 228 }, |
| 229 "list": { |
| 230 "description": "Lists matters the user has access to.", |
| 231 "httpMethod": "GET", |
| 232 "id": "vault.matters.list", |
| 233 "parameterOrder": [], |
| 234 "parameters": { |
| 235 "pageToken": { |
| 236 "description": "The pagination token as returned in
the response.", |
| 237 "location": "query", |
| 238 "type": "string" |
| 239 }, |
| 240 "pageSize": { |
| 241 "description": "The number of matters to return in t
he response.\nDefault and maximum are 100.", |
| 242 "format": "int32", |
| 243 "location": "query", |
| 244 "type": "integer" |
| 245 }, |
| 246 "view": { |
| 247 "description": "Specifies which parts of the matter
to return in response.", |
| 248 "enum": [ |
| 249 "VIEW_UNSPECIFIED", |
| 250 "BASIC", |
| 251 "FULL" |
| 252 ], |
| 253 "location": "query", |
| 254 "type": "string" |
| 255 } |
| 256 }, |
| 257 "path": "v1/matters", |
| 258 "response": { |
| 259 "$ref": "ListMattersResponse" |
| 260 } |
| 261 }, |
| 262 "addPermissions": { |
| 263 "description": "Adds an account as a matter collaborator.", |
| 264 "httpMethod": "POST", |
| 265 "id": "vault.matters.addPermissions", |
| 266 "parameterOrder": [ |
| 267 "matterId" |
| 268 ], |
| 269 "parameters": { |
| 270 "matterId": { |
| 271 "description": "The matter ID.", |
| 272 "location": "path", |
| 273 "required": true, |
| 274 "type": "string" |
| 275 } |
| 276 }, |
| 277 "path": "v1/matters/{matterId}:addPermissions", |
| 278 "request": { |
| 279 "$ref": "AddMatterPermissionsRequest" |
| 280 }, |
| 281 "response": { |
| 282 "$ref": "MatterPermission" |
| 283 } |
| 284 }, |
| 285 "create": { |
| 286 "description": "Creates a new matter. Returns created matter
with default view.", |
| 287 "httpMethod": "POST", |
| 288 "id": "vault.matters.create", |
| 289 "parameterOrder": [], |
| 290 "parameters": {}, |
| 291 "path": "v1/matters", |
| 292 "request": { |
| 293 "$ref": "Matter" |
| 294 }, |
| 295 "response": { |
| 296 "$ref": "Matter" |
| 297 } |
| 298 }, |
| 299 "reopen": { |
| 300 "description": "Reopens the specified matter. Returns matter
with updated state.", |
| 301 "httpMethod": "POST", |
| 302 "id": "vault.matters.reopen", |
| 303 "parameterOrder": [ |
| 304 "matterId" |
| 305 ], |
| 306 "parameters": { |
| 307 "matterId": { |
| 308 "description": "The matter ID.", |
| 309 "location": "path", |
| 310 "required": true, |
| 311 "type": "string" |
| 312 } |
| 313 }, |
| 314 "path": "v1/matters/{matterId}:reopen", |
| 315 "request": { |
| 316 "$ref": "ReopenMatterRequest" |
| 317 }, |
| 318 "response": { |
| 319 "$ref": "ReopenMatterResponse" |
| 320 } |
| 321 }, |
| 322 "removePermissions": { |
| 323 "description": "Removes an account as a matter collaborator.
", |
| 324 "httpMethod": "POST", |
| 325 "id": "vault.matters.removePermissions", |
| 326 "parameterOrder": [ |
| 327 "matterId" |
| 328 ], |
| 329 "parameters": { |
| 330 "matterId": { |
| 331 "description": "The matter ID.", |
| 332 "location": "path", |
| 333 "required": true, |
| 334 "type": "string" |
| 335 } |
| 336 }, |
| 337 "path": "v1/matters/{matterId}:removePermissions", |
| 338 "request": { |
| 339 "$ref": "RemoveMatterPermissionsRequest" |
| 340 }, |
| 341 "response": { |
| 342 "$ref": "Empty" |
| 343 } |
| 344 } |
| 345 }, |
| 346 "resources": { |
| 347 "holds": { |
| 348 "methods": { |
| 349 "delete": { |
| 350 "description": "Removes a hold by ID. This will rele
ase any HeldAccounts on this Hold.", |
| 351 "httpMethod": "DELETE", |
| 352 "id": "vault.matters.holds.delete", |
| 353 "parameterOrder": [ |
| 354 "matterId", |
| 355 "holdId" |
| 356 ], |
| 357 "parameters": { |
| 358 "matterId": { |
| 359 "description": "The matter ID.", |
| 360 "location": "path", |
| 361 "required": true, |
| 362 "type": "string" |
| 363 }, |
| 364 "holdId": { |
| 365 "description": "The hold ID.", |
| 366 "location": "path", |
| 367 "required": true, |
| 368 "type": "string" |
| 369 } |
| 370 }, |
| 371 "path": "v1/matters/{matterId}/holds/{holdId}", |
| 372 "response": { |
| 373 "$ref": "Empty" |
| 374 } |
| 375 }, |
| 376 "list": { |
| 377 "description": "Lists holds within a matter. An empt
y page token in ListHoldsResponse\ndenotes no more holds to list.", |
| 378 "httpMethod": "GET", |
| 379 "id": "vault.matters.holds.list", |
| 380 "parameterOrder": [ |
| 381 "matterId" |
| 382 ], |
| 383 "parameters": { |
| 384 "pageToken": { |
| 385 "description": "The pagination token as retu
rned in the response.\nAn empty token means start from the beginning.", |
| 386 "location": "query", |
| 387 "type": "string" |
| 388 }, |
| 389 "pageSize": { |
| 390 "description": "The number of holds to retur
n in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is
the same as page_size = 100.", |
| 391 "format": "int32", |
| 392 "location": "query", |
| 393 "type": "integer" |
| 394 }, |
| 395 "matterId": { |
| 396 "description": "The matter ID.", |
| 397 "location": "path", |
| 398 "required": true, |
| 399 "type": "string" |
| 400 } |
| 401 }, |
| 402 "path": "v1/matters/{matterId}/holds", |
| 403 "response": { |
| 404 "$ref": "ListHoldsResponse" |
| 405 } |
| 406 }, |
| 407 "get": { |
| 408 "description": "Gets a hold by ID.", |
| 409 "httpMethod": "GET", |
| 410 "id": "vault.matters.holds.get", |
| 411 "parameterOrder": [ |
| 412 "matterId", |
| 413 "holdId" |
| 414 ], |
| 415 "parameters": { |
| 416 "matterId": { |
| 417 "description": "The matter ID.", |
| 418 "location": "path", |
| 419 "required": true, |
| 420 "type": "string" |
| 421 }, |
| 422 "holdId": { |
| 423 "description": "The hold ID.", |
| 424 "location": "path", |
| 425 "required": true, |
| 426 "type": "string" |
| 427 } |
| 428 }, |
| 429 "path": "v1/matters/{matterId}/holds/{holdId}", |
| 430 "response": { |
| 431 "$ref": "Hold" |
| 432 } |
| 433 }, |
| 434 "update": { |
| 435 "description": "Updates the OU and/or query paramete
rs of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you
add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold
will be ignored.", |
| 436 "httpMethod": "PUT", |
| 437 "id": "vault.matters.holds.update", |
| 438 "parameterOrder": [ |
| 439 "matterId", |
| 440 "holdId" |
| 441 ], |
| 442 "parameters": { |
| 443 "matterId": { |
| 444 "description": "The matter ID.", |
| 445 "location": "path", |
| 446 "required": true, |
| 447 "type": "string" |
| 448 }, |
| 449 "holdId": { |
| 450 "description": "The ID of the hold.", |
| 451 "location": "path", |
| 452 "required": true, |
| 453 "type": "string" |
| 454 } |
| 455 }, |
| 456 "path": "v1/matters/{matterId}/holds/{holdId}", |
| 457 "request": { |
| 458 "$ref": "Hold" |
| 459 }, |
| 460 "response": { |
| 461 "$ref": "Hold" |
| 462 } |
| 463 }, |
| 464 "create": { |
| 465 "description": "Creates a hold in the given matter."
, |
| 466 "httpMethod": "POST", |
| 467 "id": "vault.matters.holds.create", |
| 468 "parameterOrder": [ |
| 469 "matterId" |
| 470 ], |
| 471 "parameters": { |
| 472 "matterId": { |
| 473 "description": "The matter ID.", |
| 474 "location": "path", |
| 475 "required": true, |
| 476 "type": "string" |
| 477 } |
| 478 }, |
| 479 "path": "v1/matters/{matterId}/holds", |
| 480 "request": { |
| 481 "$ref": "Hold" |
| 482 }, |
| 483 "response": { |
| 484 "$ref": "Hold" |
| 485 } |
| 486 } |
| 487 }, |
| 488 "resources": { |
| 489 "accounts": { |
| 490 "methods": { |
| 491 "create": { |
| 492 "description": "Adds a HeldAccount to a hold
. Accounts can only be added to a hold that\nhas no held_org_unit set. Attemptin
g to add an account to an OU-based\nhold will result in an error.", |
| 493 "httpMethod": "POST", |
| 494 "id": "vault.matters.holds.accounts.create", |
| 495 "parameterOrder": [ |
| 496 "matterId", |
| 497 "holdId" |
| 498 ], |
| 499 "parameters": { |
| 500 "holdId": { |
| 501 "description": "The hold ID.", |
| 502 "location": "path", |
| 503 "required": true, |
| 504 "type": "string" |
| 505 }, |
| 506 "matterId": { |
| 507 "description": "The matter ID.", |
| 508 "location": "path", |
| 509 "required": true, |
| 510 "type": "string" |
| 511 } |
| 512 }, |
| 513 "path": "v1/matters/{matterId}/holds/{holdId
}/accounts", |
| 514 "request": { |
| 515 "$ref": "HeldAccount" |
| 516 }, |
| 517 "response": { |
| 518 "$ref": "HeldAccount" |
| 519 } |
| 520 }, |
| 521 "delete": { |
| 522 "description": "Removes a HeldAccount from a
hold. If this request leaves the hold with\nno held accounts, the hold will not
apply to any accounts.", |
| 523 "httpMethod": "DELETE", |
| 524 "id": "vault.matters.holds.accounts.delete", |
| 525 "parameterOrder": [ |
| 526 "matterId", |
| 527 "holdId", |
| 528 "accountId" |
| 529 ], |
| 530 "parameters": { |
| 531 "holdId": { |
| 532 "description": "The hold ID.", |
| 533 "location": "path", |
| 534 "required": true, |
| 535 "type": "string" |
| 536 }, |
| 537 "accountId": { |
| 538 "description": "The ID of the accoun
t to remove from the hold.", |
| 539 "location": "path", |
| 540 "required": true, |
| 541 "type": "string" |
| 542 }, |
| 543 "matterId": { |
| 544 "description": "The matter ID.", |
| 545 "location": "path", |
| 546 "required": true, |
| 547 "type": "string" |
| 548 } |
| 549 }, |
| 550 "path": "v1/matters/{matterId}/holds/{holdId
}/accounts/{accountId}", |
| 551 "response": { |
| 552 "$ref": "Empty" |
| 553 } |
| 554 }, |
| 555 "list": { |
| 556 "description": "Lists HeldAccounts for a hol
d. This will only list individually specified\nheld accounts. If the hold is on
an OU, then use the <ahref=\"https://developers.google.com/admin-sdk/\">Admin SD
K</a>\nto enumerate its members.", |
| 557 "httpMethod": "GET", |
| 558 "id": "vault.matters.holds.accounts.list", |
| 559 "parameterOrder": [ |
| 560 "matterId", |
| 561 "holdId" |
| 562 ], |
| 563 "parameters": { |
| 564 "matterId": { |
| 565 "description": "The matter ID.", |
| 566 "location": "path", |
| 567 "required": true, |
| 568 "type": "string" |
| 569 }, |
| 570 "holdId": { |
| 571 "description": "The hold ID.", |
| 572 "location": "path", |
| 573 "required": true, |
| 574 "type": "string" |
| 575 } |
| 576 }, |
| 577 "path": "v1/matters/{matterId}/holds/{holdId
}/accounts", |
| 578 "response": { |
| 579 "$ref": "ListHeldAccountsResponse" |
| 580 } |
| 581 } |
| 582 } |
| 583 } |
| 584 } |
| 585 } |
| 586 } |
| 587 } |
| 588 }, |
| 589 "revision": "20170720", |
| 590 "rootUrl": "https://vault.googleapis.com/", |
| 591 "schemas": { |
| 592 "CloseMatterResponse": { |
| 593 "description": "Response to a CloseMatterRequest.", |
| 594 "id": "CloseMatterResponse", |
| 595 "properties": { |
| 596 "matter": { |
| 597 "$ref": "Matter", |
| 598 "description": "The updated matter, with state CLOSED." |
| 599 } |
| 600 }, |
| 601 "type": "object" |
| 602 }, |
| 603 "HeldGroupsQuery": { |
| 604 "description": "Query options for group holds.", |
| 605 "id": "HeldGroupsQuery", |
| 606 "properties": { |
| 607 "startTime": { |
| 608 "description": "The start date range for the search query. T
hese timestamps are in GMT and\nrounded down to the start of the given date.", |
| 609 "format": "google-datetime", |
| 610 "type": "string" |
| 611 }, |
| 612 "terms": { |
| 613 "description": "The search terms for the hold.", |
| 614 "type": "string" |
| 615 }, |
| 616 "endTime": { |
| 617 "description": "The end date range for the search query. The
se timestamps are in GMT and\nrounded down to the start of the given date.", |
| 618 "format": "google-datetime", |
| 619 "type": "string" |
| 620 } |
| 621 }, |
| 622 "type": "object" |
| 623 }, |
| 624 "HeldDriveQuery": { |
| 625 "description": "Query options for drive holds.", |
| 626 "id": "HeldDriveQuery", |
| 627 "properties": { |
| 628 "includeTeamDriveFiles": { |
| 629 "description": "If true, include files in Team Drives in the
hold.", |
| 630 "type": "boolean" |
| 631 } |
| 632 }, |
| 633 "type": "object" |
| 634 }, |
| 635 "HeldOrgUnit": { |
| 636 "description": "A organizational unit being held in a particular hol
d.\nThis structure is immutable.", |
| 637 "id": "HeldOrgUnit", |
| 638 "properties": { |
| 639 "orgUnitId": { |
| 640 "description": "The org unit's immutable ID as provided by t
he admin SDK.", |
| 641 "type": "string" |
| 642 }, |
| 643 "holdTime": { |
| 644 "description": "When the org unit was put on hold. This prop
erty is immutable.", |
| 645 "format": "google-datetime", |
| 646 "type": "string" |
| 647 } |
| 648 }, |
| 649 "type": "object" |
| 650 }, |
| 651 "AddMatterPermissionsRequest": { |
| 652 "description": "Add an account with the permission specified. The ro
le cannot be owner.\nIf an account already has a role in the matter, it will be\
noverwritten.", |
| 653 "id": "AddMatterPermissionsRequest", |
| 654 "properties": { |
| 655 "sendEmails": { |
| 656 "description": "True to send notification email to the added
account.\nFalse to not send notification email.", |
| 657 "type": "boolean" |
| 658 }, |
| 659 "matterPermission": { |
| 660 "$ref": "MatterPermission", |
| 661 "description": "The MatterPermission to add." |
| 662 }, |
| 663 "ccMe": { |
| 664 "description": "Only relevant if send_emails is true.\nTrue
to CC requestor in the email message.\nFalse to not CC requestor.", |
| 665 "type": "boolean" |
| 666 } |
| 667 }, |
| 668 "type": "object" |
| 669 }, |
| 670 "Matter": { |
| 671 "description": "Represents a matter.", |
| 672 "id": "Matter", |
| 673 "properties": { |
| 674 "matterId": { |
| 675 "description": "The matter ID which is generated by the serv
er.\nShould be blank when creating a new matter.", |
| 676 "type": "string" |
| 677 }, |
| 678 "state": { |
| 679 "description": "The state of the matter.", |
| 680 "enum": [ |
| 681 "STATE_UNSPECIFIED", |
| 682 "OPEN", |
| 683 "CLOSED", |
| 684 "DELETED" |
| 685 ], |
| 686 "enumDescriptions": [ |
| 687 "The matter has no specified state.", |
| 688 "This matter is open.", |
| 689 "This matter is closed.", |
| 690 "This matter is deleted." |
| 691 ], |
| 692 "type": "string" |
| 693 }, |
| 694 "matterPermissions": { |
| 695 "description": "List of users and access to the matter. Curr
ently there is no programmer\ndefined limit on the number of permissions a matte
r can have.", |
| 696 "items": { |
| 697 "$ref": "MatterPermission" |
| 698 }, |
| 699 "type": "array" |
| 700 }, |
| 701 "name": { |
| 702 "description": "The name of the matter.", |
| 703 "type": "string" |
| 704 }, |
| 705 "description": { |
| 706 "description": "The description of the matter.", |
| 707 "type": "string" |
| 708 } |
| 709 }, |
| 710 "type": "object" |
| 711 }, |
| 712 "HeldAccount": { |
| 713 "description": "An account being held in a particular hold. This str
ucture is immutable.\nThis can be either a single user or a google group, depend
ing on the corpus.", |
| 714 "id": "HeldAccount", |
| 715 "properties": { |
| 716 "holdTime": { |
| 717 "description": "When the account was put on hold.", |
| 718 "format": "google-datetime", |
| 719 "type": "string" |
| 720 }, |
| 721 "accountId": { |
| 722 "description": "The account's ID as provided by the <a\nhref
=\"https://developers.google.com/admin-sdk/\">Admin SDK</a>.", |
| 723 "type": "string" |
| 724 } |
| 725 }, |
| 726 "type": "object" |
| 727 }, |
| 728 "ReopenMatterResponse": { |
| 729 "description": "Response to a ReopenMatterRequest.", |
| 730 "id": "ReopenMatterResponse", |
| 731 "properties": { |
| 732 "matter": { |
| 733 "$ref": "Matter", |
| 734 "description": "The updated matter, with state OPEN." |
| 735 } |
| 736 }, |
| 737 "type": "object" |
| 738 }, |
| 739 "CorpusQuery": { |
| 740 "description": "Corpus specific queries.", |
| 741 "id": "CorpusQuery", |
| 742 "properties": { |
| 743 "groupsQuery": { |
| 744 "$ref": "HeldGroupsQuery", |
| 745 "description": "Details pertaining to Groups holds. If set,
corpus must be Groups." |
| 746 }, |
| 747 "mailQuery": { |
| 748 "$ref": "HeldMailQuery", |
| 749 "description": "Details pertaining to mail holds. If set, co
rpus must be mail." |
| 750 }, |
| 751 "driveQuery": { |
| 752 "$ref": "HeldDriveQuery", |
| 753 "description": "Details pertaining to Drive holds. If set, c
orpus must be Drive." |
| 754 } |
| 755 }, |
| 756 "type": "object" |
| 757 }, |
| 758 "Hold": { |
| 759 "description": "Represents a hold within Vault. A hold restricts pur
ging of\nartifacts based on the combination of the query and accounts restrictio
ns.\nA hold can be configured to either apply to an explicitly configured set\no
f accounts, or can be applied to all members of an organizational unit.", |
| 760 "id": "Hold", |
| 761 "properties": { |
| 762 "accounts": { |
| 763 "description": "If set, the hold applies to the enumerated a
ccounts and org_unit must be\nempty.", |
| 764 "items": { |
| 765 "$ref": "HeldAccount" |
| 766 }, |
| 767 "type": "array" |
| 768 }, |
| 769 "orgUnit": { |
| 770 "$ref": "HeldOrgUnit", |
| 771 "description": "If set, the hold applies to all members of t
he organizational unit and\naccounts must be empty. This property is mutable. Fo
r groups holds,\nset the accounts field." |
| 772 }, |
| 773 "query": { |
| 774 "$ref": "CorpusQuery", |
| 775 "description": "The corpus-specific query. If set, the corpu
sQuery must match corpus\ntype." |
| 776 }, |
| 777 "corpus": { |
| 778 "description": "The corpus to be searched.", |
| 779 "enum": [ |
| 780 "CORPUS_TYPE_UNSPECIFIED", |
| 781 "DRIVE", |
| 782 "MAIL", |
| 783 "GROUPS" |
| 784 ], |
| 785 "enumDescriptions": [ |
| 786 "No corpus specified.", |
| 787 "Drive.", |
| 788 "Mail.", |
| 789 "Groups." |
| 790 ], |
| 791 "type": "string" |
| 792 }, |
| 793 "updateTime": { |
| 794 "description": "The last time this hold was modified.", |
| 795 "format": "google-datetime", |
| 796 "type": "string" |
| 797 }, |
| 798 "name": { |
| 799 "description": "The name of the hold.", |
| 800 "type": "string" |
| 801 }, |
| 802 "holdId": { |
| 803 "description": "The unique immutable ID of the hold. Assigne
d during creation.", |
| 804 "type": "string" |
| 805 } |
| 806 }, |
| 807 "type": "object" |
| 808 }, |
| 809 "ListHoldsResponse": { |
| 810 "description": "The holds for a matter.", |
| 811 "id": "ListHoldsResponse", |
| 812 "properties": { |
| 813 "nextPageToken": { |
| 814 "description": "Page token to retrieve the next page of resu
lts in the list.\nIf this is empty, then there are no more holds to list.", |
| 815 "type": "string" |
| 816 }, |
| 817 "holds": { |
| 818 "description": "The list of holds.", |
| 819 "items": { |
| 820 "$ref": "Hold" |
| 821 }, |
| 822 "type": "array" |
| 823 } |
| 824 }, |
| 825 "type": "object" |
| 826 }, |
| 827 "ListHeldAccountsResponse": { |
| 828 "description": "Returns a list of held accounts for a hold.", |
| 829 "id": "ListHeldAccountsResponse", |
| 830 "properties": { |
| 831 "accounts": { |
| 832 "description": "The held accounts on a hold.", |
| 833 "items": { |
| 834 "$ref": "HeldAccount" |
| 835 }, |
| 836 "type": "array" |
| 837 } |
| 838 }, |
| 839 "type": "object" |
| 840 }, |
| 841 "UndeleteMatterRequest": { |
| 842 "description": "Undelete a matter by ID.", |
| 843 "id": "UndeleteMatterRequest", |
| 844 "properties": {}, |
| 845 "type": "object" |
| 846 }, |
| 847 "Empty": { |
| 848 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 849 "id": "Empty", |
| 850 "properties": {}, |
| 851 "type": "object" |
| 852 }, |
| 853 "ReopenMatterRequest": { |
| 854 "description": "Reopen a matter by ID.", |
| 855 "id": "ReopenMatterRequest", |
| 856 "properties": {}, |
| 857 "type": "object" |
| 858 }, |
| 859 "CloseMatterRequest": { |
| 860 "description": "Close a matter by ID.", |
| 861 "id": "CloseMatterRequest", |
| 862 "properties": {}, |
| 863 "type": "object" |
| 864 }, |
| 865 "RemoveMatterPermissionsRequest": { |
| 866 "description": "Remove an account as a matter collaborator.", |
| 867 "id": "RemoveMatterPermissionsRequest", |
| 868 "properties": { |
| 869 "accountId": { |
| 870 "description": "The account ID.", |
| 871 "type": "string" |
| 872 } |
| 873 }, |
| 874 "type": "object" |
| 875 }, |
| 876 "MatterPermission": { |
| 877 "description": "Currently each matter only has one owner, and all ot
hers are collaborators.\nWhen an account is purged, its corresponding MatterPerm
ission resources\ncease to exist.", |
| 878 "id": "MatterPermission", |
| 879 "properties": { |
| 880 "accountId": { |
| 881 "description": "The account id, as provided by <a href=\"htt
ps://developers.google.com/admin-sdk/\">Admin SDK</a>.", |
| 882 "type": "string" |
| 883 }, |
| 884 "role": { |
| 885 "description": "The user's role in this matter.", |
| 886 "enum": [ |
| 887 "ROLE_UNSPECIFIED", |
| 888 "COLLABORATOR", |
| 889 "OWNER" |
| 890 ], |
| 891 "enumDescriptions": [ |
| 892 "No role assigned.", |
| 893 "A collaborator to the matter.", |
| 894 "The owner of the matter." |
| 895 ], |
| 896 "type": "string" |
| 897 } |
| 898 }, |
| 899 "type": "object" |
| 900 }, |
| 901 "ListMattersResponse": { |
| 902 "description": "Provides the list of matters.", |
| 903 "id": "ListMattersResponse", |
| 904 "properties": { |
| 905 "nextPageToken": { |
| 906 "description": "Page token to retrieve the next page of resu
lts in the list.", |
| 907 "type": "string" |
| 908 }, |
| 909 "matters": { |
| 910 "description": "List of matters.", |
| 911 "items": { |
| 912 "$ref": "Matter" |
| 913 }, |
| 914 "type": "array" |
| 915 } |
| 916 }, |
| 917 "type": "object" |
| 918 }, |
| 919 "HeldMailQuery": { |
| 920 "description": "Query options for mail holds.", |
| 921 "id": "HeldMailQuery", |
| 922 "properties": { |
| 923 "endTime": { |
| 924 "description": "The end date range for the search query. The
se timestamps are in GMT and\nrounded down to the start of the given date.", |
| 925 "format": "google-datetime", |
| 926 "type": "string" |
| 927 }, |
| 928 "startTime": { |
| 929 "description": "The start date range for the search query. T
hese timestamps are in GMT and\nrounded down to the start of the given date.", |
| 930 "format": "google-datetime", |
| 931 "type": "string" |
| 932 }, |
| 933 "terms": { |
| 934 "description": "The search terms for the hold.", |
| 935 "type": "string" |
| 936 } |
| 937 }, |
| 938 "type": "object" |
| 939 } |
| 940 }, |
| 941 "servicePath": "", |
| 942 "title": "Google Vault API", |
| 943 "version": "v1" |
| 944 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2987103002:
Api-Roll 52: 2017-07-31 (Closed)
