Edit

Share via

caseOperation resource type

Namespace: microsoft.graph.security

An abstract entity that represents a long-running eDiscovery process. It contains a common set of properties that are shared among inheriting entities. Entities that derive from caseOperation include:

Inherits from entity.

Methods

Method Return type Description
List microsoft.graph.security.caseOperation collection Get a list of the caseOperation objects and their properties.
Get microsoft.graph.security.caseOperation Read the properties and relationships of a caseOperation object.

Properties

Property Type Description
action microsoft.graph.security.caseAction The type of action the operation represents. Possible values are: contentExport, applyTags, convertToPdf, index, estimateStatistics, addToReviewSet, holdUpdate, unknownFutureValue, purgeData, exportReport, exportResult, holdPolicySync. Use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: purgeData, exportReport, exportResult, holdPolicySync.
completedDateTime DateTimeOffset The date and time the operation was completed.
createdBy identitySet The user that created the operation.
createdDateTime DateTimeOffset The date and time the operation was created.
id String The ID for the operation. Read-only.
percentProgress Int32 The progress of the operation.
resultInfo resultInfo Contains success and failure-specific result information.
status microsoft.graph.security.caseOperationStatus The status of the case operation. Possible values are: notStarted, submissionFailed, running, succeeded, partiallySucceeded, failed, unknownFutureValue.

caseAction values

Member Description
contentExport The operation represents a content export from a review set.
applyTags The operation represents bulk tagging documents in a review set for the specified review set query.
convertToPdf The operation represents converting documents to PDFs with redactions.
index The operation represents indexing data sources of custodians and noncustodial data sources to make them searchable.
estimateStatistics The operation represents searching against Microsoft 365 services such as Exchange, SharePoint, and OneDrive for Business.
addToReviewSet The operation represents adding data to a review set from an eDiscovery collection.
holdUpdate The operation represents updating legal hold (apply/remove) for custodians and noncustodial data sources.
unknownFutureValue Evolvable enumeration sentinel value. Don't use.
purgeData The operation represents purging content from the source workloads.
exportReport The operation exports an item report from an estimated search.
exportResult The operation exports item results from an estimated search.
holdPolicySync The operation represents the addition or update of a legal hold policy.

caseOperationStatus values

Member Description
notStarted The operation hasn't yet started.
submissionFailed Submission of the operation failed.
running The operation is currently running.
succeeded The operation was successfully completed without any errors.
partiallySucceeded The operation completed, but there were errors. For error details, see resultInfo.
failed The operation failed. For error details, see resultInfo.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.security.caseOperation",
  "action": "String",  
  "completedDateTime": "String (timestamp)",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "percentProgress": "Int32",
  "resultInfo": {
    "@odata.type": "microsoft.graph.resultInfo"
  },
  "status": "String"
}