case resource type

Namespace: microsoft.graph.ediscovery

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

In the context of eDiscovery, contains custodians, holds, collections, review sets, and exports. For details, see Advanced eDiscovery.

Note

Starting in September 2021, POST operations will create large cases. To learn more about large cases, see Use large cases in Advanced eDiscovery. For details, see the Changes to the Microsoft 365 advanced eDiscovery create case API blog post.

Methods

Method Return Type Description
List cases microsoft.graph.ediscovery.case collection Retrieve a list of case objects.
Create case microsoft.graph.ediscovery.case Create a new case object.
Get case microsoft.graph.ediscovery.case Retrieve the properties and relationships of a case object.
Update case microsoft.graph.ediscovery.case Update the properties of a case object.
Delete case None Delete a case object.
Close case None Close an eDiscovery case. For details, see Close a case.
Reopen case None Reopen an eDiscovery case that was closed. For details, see Reopen a closed case.
Custodians
List custodians microsoft.graph.ediscovery.custodian collection Get a list of the custodian objects and their properties.
Create custodian microsoft.graph.ediscovery.custodian Create a new custodian object. After the custodian object is created, you will need to create the custodian's userSource to reference their mailbox and OneDrive for Business site.
Legal holds
List legalHolds microsoft.graph.ediscovery.legalHold collection Get the legalHolds that are applied to a case.
Create legalHold microsoft.graph.ediscovery.legalHold Create a new legalHold object.
Review sets
List reviewSets microsoft.graph.ediscovery.reviewSet collection Get the list of reviewSets from a case object.
Create reviewSet microsoft.graph.ediscovery.reviewSet Create a new reviewSet object. The request body contains the display name of the review set, which is the only writable property.
Case settings
Get caseSettings microsoft.graph.ediscovery.caseSettings Read the properties and relationships of a microsoft.graph.ediscovery.caseSettings object.
Update caseSettings microsoft.graph.ediscovery.caseSsettings Update the properties of a microsoft.graph.ediscovery.caseSettings object.
resetToDefault None Reset all settings to the default values.
Source collections
List sourceCollections microsoft.graph.ediscovery.sourceCollection collection Get the sourceCollection from a case object.
Create sourceCollection microsoft.graph.ediscovery.sourceCollection Create a new sourceCollection object.
Tags
List tags microsoft.graph.ediscovery.tag collection Retrieve a list of tag objects from an eDiscovery case.
Create tag microsoft.graph.ediscovery.tag Create a new tag for the specified case. The tags are used in review sets while reviewing content.

Properties

Property Type Description
closedBy identitySet The user who closed the case.
closedDateTime DateTimeOffset The date and time when the case was closed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
createdBy identitySet The user who created the case.
createdDateTime DateTimeOffset The date and time when the entity was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
description String The case description.
displayName String The case name.
externalId String The external case number for customer reference.
id String The ID for the eDiscovery case. Read-only.
lastModifiedBy identitySet The last user who modified the entity.
lastModifiedDateTime DateTimeOffset The latest date and time when the case was modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
status microsoft.graph.ediscovery.caseStatus The case status. Possible values are unknown, active, pendingDelete, closing, closed, and closedWithError. For details, see the following table.

caseStatus values

Member Description
unknown Case status is unknown.
active Case is active.
pendingDelete Case was deleted, but the delete has not been fully transacted.
closing Case was closed, but the operation has not been fully transacted.
closed The case is closed.
closedWithError The case is closed, but there were errors releasing holds in the case.

Relationships

Relationship Type Description
custodians microsoft.graph.ediscovery.custodian collection Returns a list of case custodian objects for this case. Nullable.
legalHolds microsoft.graph.ediscovery.legalHold collection Returns a list of case legalHold objects for this case. Nullable.
noncustodialDataSources microsoft.graph.ediscovery.noncustodialDataSource collection Returns a list of case noncustodialDataSource objects for this case. Nullable.
operations microsoft.graph.ediscovery.caseOperation collection Returns a list of case operation objects for this case. Nullable.
reviewSets microsoft.graph.ediscovery.reviewSet collection Returns a list of reviewSet objects in the case. Read-only. Nullable.
caseSettings microsoft.graph.ediscovery.caseSettings collection Returns a list of settings objects in the case. Read-only. Nullable.
sourceCollections microsoft.graph.ediscovery.sourceCollection collection Returns a list of sourceCollection objects associated with this case.
tags microsoft.graph.ediscovery.tag collection Returns a list of tag objects associated to this case.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.ediscovery.case",
  "description": "String",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "status": "String",
  "closedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "closedDateTime": "String (timestamp)",
  "externalId": "String",
  "id": "String (identifier)",
  "displayName": "String",
  "createdDateTime": "String (timestamp)"
}