complianceSearchActions

Content Search Actions. Export, purge, or preview actions run against a content search. The complianceSearchActions entity set lives under /exchange/v1.0/complianceSearchActions in the eDiscovery & audit category.

Fact	Value
Path	`/exchange/v1.0/complianceSearchActions`
Category	eDiscovery & audit
Tier	Tier 5, Compliance
Read role	`Compliance.IPPS.Read.All` (Community)
Write role	none (read-only)
Backing cmdlets	Get-ComplianceSearchAction, New-ComplianceSearchAction, Remove-ComplianceSearchAction

Routes

Method	Path	Synopsis	Role	Plan
GET	`/exchange/v1.0/complianceSearchActions`	List complianceSearchActions entries.	`Compliance.IPPS.Read`	Community
GET	`/exchange/v1.0/complianceSearchActions/{key}`	Get a single complianceSearchActions entry by Identity (GUID).	`Compliance.IPPS.Read`	Community

GET /exchange/v1.0/complianceSearchActions

List complianceSearchActions entries.

Backing cmdlet: Get-ComplianceSearchAction. Role: Compliance.IPPS.Read (Community).

Parameter	In	Type	Description
`case`	query	string	Scope to a specific compliance case (Name or GUID). Optional.
`details`	query	bool (switch)	Include enriched per-location detail breakdown. Slower; opt in only when needed.
`preview`	query	bool (switch)	Show only Preview-type actions (mutex with normal listing).
`purge`	query	bool (switch)	Show only Purge-type actions.
`resultSize`	query	int	Limit on rows returned. Honors EXO -ResultSize.

List compliance search actions

Lists post-search actions (Export, Purge, Preview, Retention, etc.) bound to compliance searches via Get-ComplianceSearchAction on the IPPS pool. Each action has a back-pointer SearchName field that names its parent ComplianceSearch - use that to correlate actions with their searches. Optional ?case=, ?details, ?preview, ?resultSize narrow the result.

GET /exchange/v1.0/complianceSearchActions HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "@odata.context": "https://api.contoso.com/exchange/v1.0/$metadata#complianceSearchActions(Id,Identity,Name,Action,Status,SearchName)",
  "value": [
    {
      "Id": "action-purge-inc12345",
      "Name": "INC12345_Purge",
      "Identity": "action-purge-inc12345",
      "SearchName": "INC12345",
      "Action": "Purge",
      "Status": "Completed"
    },
    {
      "Id": "action-purge-incxxx",
      "Name": "INCXXX Purge_Purge",
      "Identity": "action-purge-incxxx",
      "SearchName": "INCXXX Purge",
      "Action": "Purge",
      "Status": "Completed"
    }
  ]
}

GET /exchange/v1.0/complianceSearchActions/{key}

Get a single complianceSearchActions entry by Identity (GUID).

Backing cmdlet: Get-ComplianceSearchAction. Role: Compliance.IPPS.Read (Community).

Parameter	In	Type	Required	Description
`details`	query	bool (switch)		Include enriched per-location detail breakdown for this single action.

Get a compliance search action by id

Returns a single post-search action (Export, Purge, Preview, or Retention) by its Identity GUID, including run status, progress, and per-location results.

GET /exchange/v1.0/complianceSearchActions/{key} HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#complianceSearchActions/$entity",
  "Id": "4b11e0bd-c931-4ecb-3c0a-08dd4a98dae3",
  "Name": "INC12345_Purge",
  "Identity": "4b11e0bd-c931-4ecb-3c0a-08dd4a98dae3",
  "SearchName": "INC12345",
  "Action": "Purge",
  "Status": "Completed",
  "Description": "",
  "Results": "Purge Type: HardDelete; Item count: 6; Total size 880394; Details: {Location: john.woods@contoso.com; Item count: 2; Total size: 319520; Failed count: 0; ,\r\nLocation: secops@contoso.com; Item count: 2; Total size: 289410; Failed count: 0; ,\r\nLocation: sam.carter@contoso.com; Item count: 2; Total size: 271464; Failed count: 0; }",
  "CaseId": null,
  "CaseName": "",
  "CreatedBy": "Woods, John",
  "RunBy": "Woods, John",
  "EstimateSearchJobId": "c61d5230-b918-4a96-0130-08dd4a984bab",
  "EstimateSearchRunId": "0c34959c-55d8-4560-ac56-08dd4a98ad21",
  "ResultInEOP": false,
  "JobProgress": 100,
  "ObjectState": "New",
  "CreatedTime": "2025-02-11T12:37:32.397Z",
  "LastModifiedTime": "2025-02-11T12:38:01Z",
  "JobStartTime": "2025-02-11T12:37:32.43Z",
  "JobEndTime": "2025-02-11T12:38:01Z"
}