Skip to content

security-caseoperation-get.md

Latest commit

 

History

History
136 lines (107 loc) · 5.7 KB

security-caseoperation-get.md

File metadata and controls

136 lines (107 loc) · 5.7 KB
title Get caseOperation
description Read the properties and relationships of a caseOperation object.
author SeunginLyu
ms.localizationpriority medium
ms.subservice ediscovery
doc_type apiPageType
ms.date 06/10/2024

Get caseOperation

Namespace: microsoft.graph.security

Read the properties and relationships of a caseOperation object.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/operations/{caseOperationId}

Optional query parameters

This method supports some of the OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a microsoft.graph.security.caseOperation object in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/operations/850c2f64b1ee44a4a69729327aac2b04

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/operations/$entity",
    "@odata.type": "#microsoft.graph.security.ediscoveryAddToReviewSetOperation",
    "createdDateTime": "2022-05-23T16:51:34.8281972Z",
    "completedDateTime": "0001-01-01T00:00:00Z",
    "percentProgress": 50,
    "status": "running",
    "action": "addToReviewSet",
    "id": "850c2f64b1ee44a4a69729327aac2b04",
    "createdBy": {
        "application": null,
        "user": {
            "id": "c25c3914-f9f7-43ee-9cba-a25377e0cec6",
            "displayName": "MOD Administrator",
            "userPrincipalName": "admin@contoso.com"
        }
    }
}

Note: If you need to perform an export operation, the response will include the download URL, file name, and size in the **exportfileMetadata property. You will be responsible for managing the actual download process. You can choose to download the file to your local computer or export it to your storage account. To automate the process and avoid the interactive sign-in page:

  1. Provision the Microsoft Purview eDiscovery application by using Create ServicePrincpal for the application ID b26e684c-5068-4120-a679-64a5d2c909d9.
  2. When the application is provisioned, request user-delegated permissions for discovery.Download.Read from the tenant admin. This request should be made from your third-party application interacting with Microsoft Graph.
  3. Make sure the tenant admin approves the request.
  4. Add the scope for the application to your existing script and make sure the headers include ("X-AllowWithAADToken", "true");. By following these steps, the user authorization process will be automated, and you won't encounter a manual interactive sign-in page.