Skip to content

Commit 70091bf

Browse files
Adding links for enums in api parameters and resource topic properties
1 parent fbfde50 commit 70091bf

6 files changed

+9
-9
lines changed

api-reference/beta/api/security-ediscoveryreviewset-addtoreviewset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The following table shows the parameters that can be used with this action.
5151
|additionalDataOptions|[microsoft.graph.security.additionalDataOptions](../resources/security-ediscoveryaddtoreviewsetoperation.md#additionaldataoptions-values)|The options for adding items to reviewSet. The possible values are `allVersions`, `linkedFiles`, `unknownFutureValue`, `advancedIndexing`, `listAttachments`, `htmlTranscripts`, `messageConversationExpansion`, `locationsWithoutHits`, `allItemsInFolder`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/concepts/best-practices-concept#handling-future-members-in-evolvable-enumerations): `advancedIndexing`, `listAttachments`, `htmlTranscripts`, `messageConversationExpansion`, `locationsWithoutHits`, `allItemsInFolder`. Note: `locationsWithoutHits` and `advancedIndexing` are only considered if the `itemsToIncude` parameter is set to `partiallyIndexed`.|
5252
| cloudAttachmentVersion | microsoft.graph.security.cloudAttachmentVersion | Specify how many versions of cloud attachments to collect. The possible values are `latest`, `recent10`, `recent100`, `all`. Default is `latest`.|
5353
| documentVersion | microsoft.graph.security.documentVersion | Specify how many versions of documents to collect. The possible values are `latest`, `recent10`, `recent100`, `all`. Default is `latest`.|
54-
| itemsToInclude | microsoft.graph.security.itemsToInclude | The items to include in the review set. The possible values are `searchHits`, `partiallyIndexed`, `unknownFutureValue`. |
54+
| itemsToInclude | [microsoft.graph.security.itemsToInclude](../resources/security-ediscoveryaddtoreviewsetoperation.md#itemstoinclude-values) | The items to include in the review set. The possible values are `searchHits`, `partiallyIndexed`, `unknownFutureValue`. |
5555

5656
## Response
5757

api-reference/beta/api/security-ediscoveryreviewset-export.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ The following table shows the parameters that can be used with this action.
4848
|Parameter|Type|Description|
4949
|:---|:---|:---|
5050
|description|String| Description of the export. |
51-
|exportOptions|String|Specifies options that control the format of the export. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`, `unknownFutureValue`, `splitSource`, `includeFolderAndPath`, `friendlyName`, `condensePaths`, `optimizedPartitionSize`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/concepts/best-practices-concept#handling-future-members-in-evolvable-enumerations): `splitSource`, `includeFolderAndPath`, `friendlyName`, `condensePaths`, `optimizePartitionSize`. The `fileInfo` member is deprecated and stopped returning data. The summary and load files are always included. Note: If `originalFiles` isn't selected, only the `tags` member is considered. |
52-
|exportStructure|String| Bitwise options that control file structure and packaging of the export. Possible values are: `none`, `directory`, `pst`, `unknownFutureValue`, `msg`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/concepts/best-practices-concept#handling-future-members-in-evolvable-enumerations): `msg`. If `directory` is selected, the format is `msg`, and the export options `splitSource`, `includeFolderAndPath`, and `friendlyName` are disregarded.|
51+
|exportOptions|[microsoft.graph.security.exportOptions](../resources/security-ediscoveryexportoperation.md#exportoptions-values)|Specifies options that control the format of the export. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`, `unknownFutureValue`, `splitSource`, `includeFolderAndPath`, `friendlyName`, `condensePaths`, `optimizedPartitionSize`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/concepts/best-practices-concept#handling-future-members-in-evolvable-enumerations): `splitSource`, `includeFolderAndPath`, `friendlyName`, `condensePaths`, `optimizePartitionSize`. The `fileInfo` member is deprecated and stopped returning data. The summary and load files are always included. Note: If `originalFiles` isn't selected, only the `tags` member is considered. |
52+
|exportStructure|[microsoft.graph.security.exportFileStructure](../resources/security-ediscoveryexportoperation.md#exportfilestructure-values)| Bitwise options that control file structure and packaging of the export. Possible values are: `none`, `directory`, `pst`, `unknownFutureValue`, `msg`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/concepts/best-practices-concept#handling-future-members-in-evolvable-enumerations): `msg`. If `directory` is selected, the format is `msg`, and the export options `splitSource`, `includeFolderAndPath`, and `friendlyName` are disregarded.|
5353
|outputName|String| Name of the export. Required. |
5454
|azureBlobContainer (deprecated)|String| When you export to your own Azure storage account, the value is the container URL. The **azureBlobContainer** property is deprecated and stopped returning data. |
5555
|azureBlobToken (deprecated)|String| When you export to your own Azure storage account, SAS token for the container URL. The **azureBlobToken** property is deprecated and stopped returning data. |

api-reference/beta/api/security-ediscoverysearch-estimatestatistics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySear
4343
## Request body
4444
|Property|Type|Description|
4545
|:---|:---|:---|
46-
| statisticsOptions | microsoft.graph.security.statisticsOptions | Bitwise options that specify the statistics to generate. The possible values are: `includeRefiners`, `includeQueryStats`, `includeUnindexedStats`, `advancedIndexing`, `locationsWithoutHits`, `unknownFutureValue`. Note: `advancedIndexing` and `locationsWithoutHits` is only considered if `includeUnindexedStats` is set.|
46+
| statisticsOptions | [microsoft.graph.security.statisticsOptions](../resources/security-ediscoveryestimateoperation.md#statisticsoptions-values) | Bitwise options that specify the statistics to generate. The possible values are: `includeRefiners`, `includeQueryStats`, `includeUnindexedStats`, `advancedIndexing`, `locationsWithoutHits`, `unknownFutureValue`. Note: `advancedIndexing` and `locationsWithoutHits` is only considered if `includeUnindexedStats` is set.|
4747

4848
## Response
4949

api-reference/beta/resources/security-ediscoveryaddtoreviewsetoperation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ None.
3131
|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3232
|documentVersion|String| How many most recent versions of SharePoint documents to collect.|
3333
|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).|
34-
|itemsToInclude|String| The items to include in the review set. Possible values are: `searchHits`, `partiallyIndexed`, `unknownFutureValue`.|
34+
|itemsToInclude|[microsoft.graph.security.itemsToInclude](#itemstoinclude-values)| The items to include in the review set. Possible values are: `searchHits`, `partiallyIndexed`, `unknownFutureValue`.|
3535
|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3636
|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3737
|status|microsoft.graph.security.caseOperationStatus| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).|

api-reference/beta/resources/security-ediscoveryestimateoperation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ None.
3434
|percentProgress|Int32|The progress of the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3535
|resultInfo|[resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3636
|siteCount|Int32|The number of mailboxes that had search hits.|
37-
|statisticsOptions|String|The options to generate statistics. Possible values are: `includeRefiners`, `includeQueryStats`, `includeUnindexedStats`, `advancedIndexing`, `locationsWithoutHits`, `unknownFutureValue`.|
37+
|statisticsOptions|[microsoft.graph.security.statisticsOptions](#statisticsoptions-values)|The options to generate statistics. Possible values are: `includeRefiners`, `includeQueryStats`, `includeUnindexedStats`, `advancedIndexing`, `locationsWithoutHits`, `unknownFutureValue`.|
3838
|status|microsoft.graph.security.caseOperationStatus| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3939
|unindexedItemCount|Int64|The estimated count of unindexed items for the collection.|
4040
|unindexedItemsSize|Int64|The estimated size of unindexed items for the collection.|

api-reference/beta/resources/security-ediscoveryexportoperation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Inherits from [caseOperation](../resources/security-caseoperation.md).
3232
|createdDateTime|DateTimeOffset| The date and time the export was created. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3333
|description|String| The description provided for the export.|
3434
|exportFileMetadata | [microsoft.graph.security.ediscoveryExportFileMetadata](../resources/security-ediscoveryexportfilemetadata.md)| Contains the properties for an export file metadata, including **downloadUrl**, **fileName**, and **size**. If you export to an Azure storage location, this property returns empty. |
35-
|exportOptions|microsoft.graph.security.exportOptions| The options provided for the export. For more information, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). The `fileInfo` member is deprecated and stopped returning data on April 30, 2023. Going forward, the summary and load files are always included. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `tags`, `unknownFutureValue`, `splitSource`, `includeFolderAndPath`, `friendlyName`, `condensePaths`, `optimizedPartitionSize`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/concepts/best-practices-concept#handling-future-members-in-evolvable-enumerations): `splitSource`, `includeFolderAndPath`, `friendlyName`, `condensePaths`, `optimizedPartitionSize`.|
36-
|exportStructure|microsoft.graph.security.exportFileStructure|The options that specify the structure of the export. For more information, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). Possible values are: `none`, `directory`, `pst`, `unknownFutureValue`, `msg`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/concepts/best-practices-concept#handling-future-members-in-evolvable-enumerations): `msg`.|
35+
|exportOptions|[microsoft.graph.security.exportOptions](#exportoptions-values)| The options provided for the export. For more information, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). The `fileInfo` member is deprecated and stopped returning data on April 30, 2023. Going forward, the summary and load files are always included. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `tags`, `unknownFutureValue`, `splitSource`, `includeFolderAndPath`, `friendlyName`, `condensePaths`, `optimizedPartitionSize`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/concepts/best-practices-concept#handling-future-members-in-evolvable-enumerations): `splitSource`, `includeFolderAndPath`, `friendlyName`, `condensePaths`, `optimizedPartitionSize`.|
36+
|exportStructure|[microsoft.graph.security.exportFileStructure](#exportfilestructure-values)|The options that specify the structure of the export. For more information, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). Possible values are: `none`, `directory`, `pst`, `unknownFutureValue`, `msg`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/concepts/best-practices-concept#handling-future-members-in-evolvable-enumerations): `msg`.|
3737
|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3838
|outputName|String| The name provided for the export.|
3939
|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).|
@@ -52,12 +52,12 @@ Inherits from [caseOperation](../resources/security-caseoperation.md).
5252
|pdfReplacement|Replace original file with PDF version when available.|
5353
|tags|Include tag information in fileInfo.|
5454
|fileInfo (deprecated) |Include metadata of original files in a load file. The `fileInfo` member is deprecated and will stop returning data on April 30, 2023. Going forward, the summary and load files are always included. |
55+
|unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
5556
|splitSource|Organize data from different locations into separate folders or PSTs.|
5657
|includeFolderAndPath|Include folder and path structure of source.|
5758
|friendlyName|Give each item a friendly name.|
5859
|condensePaths|Condense paths to fit within 259 characters.|
5960
|optimizedPartitionSize|Optimize export package partition size.|
60-
|unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
6161

6262
### exportFileStructure values
6363

0 commit comments

Comments
 (0)