v1

latestOpenAPI 3.0.02026-07-232635107.7 KB
SearchForRepositories

Execute search of archives/repositories

get/search/v1/archives

Query parameters

sps.repositoryCountriesstring[]

Repository location Country filter. <para>Country codes</para>

sps.repositoryRegionsstring[]

Repository location Region filter. <para>Region codes</para>

sps.repositoryCountiesstring[]

Repository location County filter. <para>County codes</para>

sps.repositoryTypesstring[]

Repository type filter.

sps.archiveCodeinteger

Archon Code

sps.titleContainsstring

String which should be contained in the repository title

sps.searchQuerystring required

Search query. <para>May contain boolean expressions, i.e. AND, OR, NOT, quotations marks, brackets and/or wild card (*).</para>

sps.returnHighlightedboolean

Highlight search terms in search results. <para>If highlight is enabled only a snippet containing highlighted text is returned</para>

sps.sortByOption'RELEVANCE' | 'REFERENCE_ASCENDING' | 'DATE_ASCENDING' | 'DATE_DESCENDING' | 'TITLE_ASCENDING' | 'TITLE_DESCENDING'

Search results sort option

sps.pageinteger

Page number. <para><b>Range [0, 100]</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>

sps.resultsPageSizeinteger

Search results page size. <para><b>Range [0, 1000], default 15</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>

sps.titleFirstLetterstring

Filter by the first letter of the record title. <para>Enabled when sorting by Title in {SortByOption} and number of results is less then 10,000</para>

sps.batchStartMarkstring

Cursor Mark value. <para>Search result batch start mark used for deep paging.</para><para>To invoke deep paging use wild card (*). For subsequent requests use the value of "NextBatchMark" field.</para>

sps.preferenceQueryStringParameterstring

Query string parameter for user preferences. <para>Used to pass user-specific preferences as part of the search request.</para>

Response

OK

Countinteger

Gets or sets the total count of search results.

NextBatchMarkstring

Gets or sets the marker for the next batch of results.