Advanced Search

The advanced search API allows fine-grained searching of repository content. This feature is only available via the REST API, at POST /api/v1/_query/advanced.

To use advanced search:

1. Use PostgreSQL as the repository database. Advanced search indexing is not available on SQL Server.

2. Set RepositorySettings:Features:EnableAdvancedSearch to true in appsettings.json and restart the application. Items are indexed for advanced search when they are registered.

3. To index items that were registered before the feature was enabled, reindex the database using the Repository CLI.

Requests to the endpoint return HTTP status 503 while the feature is disabled.

See also

View the Advanced Search API documentation.

Property Names

The following sections list the property names that can be searched for each type of content. Besides the values listed below, custom fields are indexed for each type. To search for values of a custom field, use the custom field ID as the property name.

Text Properties

The following values may be used for the propertyName parameter for textFacets.

• abstract

• dcAccessRights

• dcAlternateTitle

• dcContributor

• dcCoverage

• dcCreator

• dcDescription

• dcFormat

• dcPublisher

• dcRelation

• dcRights

• dcSource

• dcSubjects

• dcSubTitle

• dcTitle

• dcType

• description

• label

• name

• purpose

• synonym

• versionRationale

Controlled Vocabulary Properties

The following values may be used for the propertyName parameter for codeValueFacets.

• abbreviations

• aggregationMethod

• analysisUnit

• byteOrder

• contributorRole

• countryCode

• dataCollectionFrequency

• dateTimeType

• displayLayout

• externalComplianceCode

• fundingRole

• genericOutputFormat

• keyword

• kindsOfData

• language

• levelCodeStructure

• levelOfInformationClassification

• levelTypeCode

• managingAgency

• materialType

• measurementUnit

• numericType

• processingStatus

• publisherRole

• recommendedDataType

• relationshipMapping

• responseUnit

• role

• seriesContext

• softwareFunction

• softwarePackage

• sourceUnit

• storageFormat

• subject

• subjectArea

• typeOfActionToMinimizeLosses

• typeOfCollectionSituation

• typeOfDataSource

• typeOfDeviationFromSampleDesign

• typeOfGroup

• typeOfInformationClassification

• typeOfInstrument

• typeOfMeasurement

• typeOfMethodology

• typeOfModeOfCollection

• typeOfName

• typeOfResourcePackage

• typeOfSamplingProcedure

• typeOfSequence

• typeOfTimeMethod

Numeric Properties

Only custom fields of type Numeric are indexed for numeric searching. Use the custom field ID as propertyName parameter for decimalFacets.

Locator Properties

DDI UserIDs are indexed as locators. Use the UserID’s Type as the propertyName parameter for locatorFacets.

Boolean Properties

The following values may be used for the propertyName parameter for booleanFacets.

• isPublished

Timestamp Properties

The following values may be used for the propertyName parameter for dateFacets.

• authorizationSource

• caseLawDate

• dataCollectionDate

• dataCollectionFrequency

• dataFileVersionDate

• embargo

• floatingMap

• releaseDate

• temporalCoverage

• terminationDate

• validFrom

• validTo

• versionDate