Exports search results as an Excel spreadsheet or queues the export for background processing.

post

https://localhost:44395/api/portal/search/export

Behavior: Executes the search query and exports matching results as an XLSX file. If no sort fields are provided, results are sorted by masterId by default. When the background flag is set, the export is queued as a batch action and the caller receives a 204 response immediately; the exported file is delivered via email when ready.

Authorization: Requires a valid Bearer token.

Side Effects: When running in background mode, creates a batch job for asynchronous processing.

Error Scenarios: Returns 204 if no records match the search criteria. Returns 400 if the search model is null or invalid.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

background

boolean

Defaults to false

When true, queues the export for background processing and returns immediately. Defaults to false.

Body Params

The search query model defining which results to export.

pageSize

int32

Gets or sets the size of the page (the number of items returned for this page)

pageOffset

string

Gets or sets the offset of the page (zero based).

searchQuery

string | null

Gets or sets a text string to search within all of the text fields to match

filters

array of objects | null

Gets or sets a list of the filters to apply for this search

filters

searchTextFields

array of objects | null

Gets or sets a list of the search text fields to apply for this search.

searchTextFields

filterBinder

int32

enum

0 = And

1 = Or

Allowed:

sortFields

array of objects | null

Gets or sets the fields to sort by

sortFields

returnedFieldNames

array of strings | null

deprecated

returnedFieldNames

fullUrlFieldNames

array of strings | null

Gets or sets the list of fields that should have the FullURL calculated. The calculations are expensive and greatly slow down the query. Use this field to only return the ones that are actually needed.

fullUrlFieldNames

distinctOnFieldName

string | null

Gets or sets optional property that will be used to aggregate results records to distinct occurances of this field's values.

includeVideoClips

boolean

Gets or sets a value indicating whether specify if the video search results are grouped by include clips of the videos also.

searchResultFields

array of objects | null

Gets or sets the list of fields and optionally the sub fields and related records that should be returned as a result

searchResultFields

similarAssetId

uuid | null

Gets or sets when SimilarAssetId has a value, then the search results are a special type of results and bring back the items that are the most similar to the item represented here. This search is only enabled when Vector searching has been enabled. When this has a value, the SearchQuery value and PageOffset values are ignored.

minScore

double | null

Gets or sets specifies the minimum score to match when returning results. If omitted, the system default will be used - which is usually .65

excludeTotalRecordCount

boolean

Gets or sets a value indicating whether normally, the total record count is returned but the query can be made faster if this value is excluded.

useLlmSearch

boolean

Gets or sets a value indicating whether gets or Sets a value representing if the search engine should try and use the LLM search instead of the standard search.

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

204

No matching records found, or background export was queued.

200The export file was generated successfully.

400The search model is null or invalid.

401Caller is not authenticated.