Package com.iland.core.web.rest.api

Interface O365SearchBackupsResource

@Path("/o365-search-backups")
@Consumes("application/json")
@Produces("application/vnd.ilandcloud.api.v1.0+json")
public interface O365SearchBackupsResource

Office 365 Search Backups Resource. Continues a Search Backups session that was opened via POST /o365-organizations/{uuid}/search-backups/{sessionType}/sessions.

The sessionId is the restore session uuid returned by the open-session call. To stop a session, use the existing O365RestoreSessionResource.stopRestoreSession(String).

Method Summary

Modifier and Type	Method	Description
O365MailItemSearchSetResponse	searchSession(String sessionId, String mailboxId, Integer offset, Integer limit, O365SearchQueryRequest request)	Search inside an open Search Backups session with free-form text matched against subject, sender and receiver.
O365SharePointItemSearchSetResponse	searchSharePointSession(String sessionId, String siteId, Integer offset, Integer limit, O365SearchQueryRequest request)	Search inside an open Search Backups session for SharePoint items within a specific site.

Method Details

searchSession

@POST
@Path("/sessions/{sessionId}/mailboxes/{mailboxId}/search")
@Consumes("application/json")
O365MailItemSearchSetResponse searchSession(@PathParam("sessionId")
 String sessionId,
 @PathParam("mailboxId")
 String mailboxId,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 O365SearchQueryRequest request)

Search inside an open Search Backups session with free-form text matched against subject, sender and receiver. Requires Permission.MANAGE_ILAND_O365_RESTORE_SESSION (same as other O365 search endpoints). Page with offset/limit; limit must be between 1 and 100, values above 100 are rejected with 400. Stop when a page returns fewer than limit hits (no total count).

Parameters:

sessionId - the restore session uuid

mailboxId - the Veeam mailbox uuid, or the literal all to search across every mailbox in the session

offset - the result offset, default 0

limit - the result limit, default 30, max 100

request - the free-form search query body; the query must be at least 2 characters, blank or shorter queries are rejected with 400

Returns:

a O365MailItemSearchSetResponse instance

searchSharePointSession

@POST
@Path("/sessions/{sessionId}/sharepoint-sites/{siteId}/search")
@Consumes("application/json")
O365SharePointItemSearchSetResponse searchSharePointSession(@PathParam("sessionId")
 String sessionId,
 @PathParam("siteId")
 String siteId,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 O365SearchQueryRequest request)

Search inside an open Search Backups session for SharePoint items within a specific site. The query is passed through to the VBO API as-is; use VBO native search syntax (e.g. filename:, title:) to scope results. Requires Permission.MANAGE_ILAND_O365_RESTORE_SESSION. Page with offset/limit; limit must be between 1 and 100, values above 100 are rejected with 400. Stop when a page returns fewer than limit hits (no total count).

Parameters:

sessionId - the restore session uuid

siteId - the SharePoint site Veeam native ID

offset - the result offset, default 0

limit - the result limit, default 30, max 100

request - the VBO search query body; the query must be at least 2 characters, blank or shorter queries are rejected with 400

Returns:

a O365SharePointItemSearchSetResponse instance