Update ediscoveryCaseSettings

Namespace: microsoft.graph.security

Update the properties of an ediscoveryCaseSettings object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	eDiscovery.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

PATCH /security/cases/ediscoveryCases/{ediscoveryCaseId}/settings

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

Property	Type	Description
redundancyDetection	microsoft.graph.security.redundancyDetectionSettings	Redundancy (email threading and near duplicate detection) settings for an eDiscovery case. Optional.
topicModeling	microsoft.graph.security.topicModelingSettings	Topic modeling (Themes) settings for an eDiscovery case. Optional.
ocr	microsoft.graph.security.ocrSettings	The OCR (Optical Character Recognition) settings for the eDiscovery case. Optional.

Response

If successful, this method returns a 204 No Content response code.

Examples

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/{ediscoveryCaseId}/settings
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.security.ediscoveryCaseSettings",
  "redundancyDetection": {
    "@odata.type": "microsoft.graph.security.redundancyDetectionSettings"
  },
  "topicModeling": {
    "@odata.type": "microsoft.graph.security.topicModelingSettings"
  },
  "ocr": {
    "@odata.type": "microsoft.graph.security.ocrSettings"
  }
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models.Security;

var requestBody = new EdiscoveryCaseSettings
{
	OdataType = "#microsoft.graph.security.ediscoveryCaseSettings",
	RedundancyDetection = new RedundancyDetectionSettings
	{
		OdataType = "microsoft.graph.security.redundancyDetectionSettings",
	},
	TopicModeling = new TopicModelingSettings
	{
		OdataType = "microsoft.graph.security.topicModelingSettings",
	},
	Ocr = new OcrSettings
	{
		OdataType = "microsoft.graph.security.ocrSettings",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Cases.EdiscoveryCases["{ediscoveryCase-id}"].Settings.PatchAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc security cases ediscovery-cases settings patch --ediscovery-case-id {ediscoveryCase-id} --body '{\
  "@odata.type": "#microsoft.graph.security.ediscoveryCaseSettings",\
  "redundancyDetection": {\
    "@odata.type": "microsoft.graph.security.redundancyDetectionSettings"\
  },\
  "topicModeling": {\
    "@odata.type": "microsoft.graph.security.topicModelingSettings"\
  },\
  "ocr": {\
    "@odata.type": "microsoft.graph.security.ocrSettings"\
  }\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodelssecurity "github.com/microsoftgraph/msgraph-sdk-go/models/security"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodelssecurity.NewEdiscoveryCaseSettings()
redundancyDetection := graphmodelssecurity.NewRedundancyDetectionSettings()
requestBody.SetRedundancyDetection(redundancyDetection)
topicModeling := graphmodelssecurity.NewTopicModelingSettings()
requestBody.SetTopicModeling(topicModeling)
ocr := graphmodelssecurity.NewOcrSettings()
requestBody.SetOcr(ocr)

settings, err := graphClient.Security().Cases().EdiscoveryCases().ByEdiscoveryCaseId("ediscoveryCase-id").Settings().Patch(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.models.security.EdiscoveryCaseSettings ediscoveryCaseSettings = new com.microsoft.graph.models.security.EdiscoveryCaseSettings();
ediscoveryCaseSettings.setOdataType("#microsoft.graph.security.ediscoveryCaseSettings");
com.microsoft.graph.models.security.RedundancyDetectionSettings redundancyDetection = new com.microsoft.graph.models.security.RedundancyDetectionSettings();
redundancyDetection.setOdataType("microsoft.graph.security.redundancyDetectionSettings");
ediscoveryCaseSettings.setRedundancyDetection(redundancyDetection);
com.microsoft.graph.models.security.TopicModelingSettings topicModeling = new com.microsoft.graph.models.security.TopicModelingSettings();
topicModeling.setOdataType("microsoft.graph.security.topicModelingSettings");
ediscoveryCaseSettings.setTopicModeling(topicModeling);
com.microsoft.graph.models.security.OcrSettings ocr = new com.microsoft.graph.models.security.OcrSettings();
ocr.setOdataType("microsoft.graph.security.ocrSettings");
ediscoveryCaseSettings.setOcr(ocr);
com.microsoft.graph.models.security.EdiscoveryCaseSettings result = graphClient.security().cases().ediscoveryCases().byEdiscoveryCaseId("{ediscoveryCase-id}").settings().patch(ediscoveryCaseSettings);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const ediscoveryCaseSettings = {
  '@odata.type': '#microsoft.graph.security.ediscoveryCaseSettings',
  redundancyDetection: {
    '@odata.type': 'microsoft.graph.security.redundancyDetectionSettings'
  },
  topicModeling: {
    '@odata.type': 'microsoft.graph.security.topicModelingSettings'
  },
  ocr: {
    '@odata.type': 'microsoft.graph.security.ocrSettings'
  }
};

await client.api('/security/cases/ediscoveryCases/{ediscoveryCaseId}/settings')
	.update(ediscoveryCaseSettings);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\EdiscoveryCaseSettings;
use Microsoft\Graph\Generated\Models\RedundancyDetectionSettings;
use Microsoft\Graph\Generated\Models\TopicModelingSettings;
use Microsoft\Graph\Generated\Models\OcrSettings;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new EdiscoveryCaseSettings();
$requestBody->setOdataType('#microsoft.graph.security.ediscoveryCaseSettings');
$redundancyDetection = new RedundancyDetectionSettings();
$redundancyDetection->setOdataType('microsoft.graph.security.redundancyDetectionSettings');
$requestBody->setRedundancyDetection($redundancyDetection);
$topicModeling = new TopicModelingSettings();
$topicModeling->setOdataType('microsoft.graph.security.topicModelingSettings');
$requestBody->setTopicModeling($topicModeling);
$ocr = new OcrSettings();
$ocr->setOdataType('microsoft.graph.security.ocrSettings');
$requestBody->setOcr($ocr);

$result = $graphServiceClient->security()->cases()->ediscoveryCases()->byEdiscoveryCaseId('ediscoveryCase-id')->settings()->patch($requestBody)->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Security

$params = @{
	"@odata.type" = "#microsoft.graph.security.ediscoveryCaseSettings"
	redundancyDetection = @{
		"@odata.type" = "microsoft.graph.security.redundancyDetectionSettings"
	}
	topicModeling = @{
		"@odata.type" = "microsoft.graph.security.topicModelingSettings"
	}
	ocr = @{
		"@odata.type" = "microsoft.graph.security.ocrSettings"
	}
}

Update-MgSecurityCaseEdiscoveryCaseSetting -EdiscoveryCaseId $ediscoveryCaseId -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.ediscovery_case_settings import EdiscoveryCaseSettings
from msgraph.generated.models.redundancy_detection_settings import RedundancyDetectionSettings
from msgraph.generated.models.topic_modeling_settings import TopicModelingSettings
from msgraph.generated.models.ocr_settings import OcrSettings

graph_client = GraphServiceClient(credentials, scopes)

request_body = EdiscoveryCaseSettings(
	odata_type = "#microsoft.graph.security.ediscoveryCaseSettings",
	redundancy_detection = RedundancyDetectionSettings(
		odata_type = "microsoft.graph.security.redundancyDetectionSettings",
	),
	topic_modeling = TopicModelingSettings(
		odata_type = "microsoft.graph.security.topicModelingSettings",
	),
	ocr = OcrSettings(
		odata_type = "microsoft.graph.security.ocrSettings",
	),
)

result = await graph_client.security.cases.ediscovery_cases.by_ediscovery_case_id('ediscoveryCase-id').settings.patch(request_body)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 204 No Content