v25

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08143108383.9 KB

Borehole

Returns autocomplete suggestions for a borehole text column. When a filterRequest is supplied, suggestions are restricted to boreholes matching every active filter except the filter on the field being autocompleted, so the user can refine that field's value (filter-exclusion on the self-field).

post/api/v{version}/borehole/suggest

Path parameters

versionstring required

Query parameters

field'OriginalName' | 'ProjectName' | 'Name'

The set of borehole text columns that support suggestions. Bound from the query string as camelCase ("originalName", "projectName", "name").

The borehole column to search (originalName, projectName, or name).

querystring

The prefix string to match against; must be at least 2 characters.

limitinteger

Maximum number of suggestions to return (1–50, default 10).

Request body

originalNamestring nullable

Gets or sets the original name filter.

projectNamestring nullable

Gets or sets the project name filter.

namestring nullable

Gets or sets the alternate name filter.

statusIdinteger[] nullable

Gets or sets the status ID filter.

typeIdinteger[] nullable

Gets or sets the borehole type ID filter.

purposeIdinteger[] nullable

Gets or sets the purpose ID filter.

workflowStatusWorkflowStatus[] nullable

Gets or sets the workflow status filter. Matches boreholes whose workflow status is in this set.

workgroupIdinteger[] nullable

Gets or sets the workgroup ID filter.

idsinteger[] nullable

Gets or sets multiple borehole IDs filter.

restrictionUntilFromstring date nullable

Gets or sets the restriction until date start filter.

restrictionUntilTostring date nullable

Gets or sets the restriction until date end filter.

totalDepthMinnumber double nullable

Gets or sets the minimum total depth filter.

totalDepthMaxnumber double nullable

Gets or sets the maximum total depth filter.

topBedrockFreshMdMinnumber double nullable

Gets or sets the minimum top bedrock fresh depth filter.

topBedrockFreshMdMaxnumber double nullable

Gets or sets the maximum top bedrock fresh depth filter.

topBedrockWeatheredMdMinnumber double nullable

Gets or sets the minimum top bedrock weathered depth filter.

topBedrockWeatheredMdMaxnumber double nullable

Gets or sets the maximum top bedrock weathered depth filter.

restrictionIdinteger[] nullable

Gets or sets the restriction ID filter.

cantonstring[] nullable

Gets or sets the canton filter. Boreholes match if their canton is in this set.

municipalitystring[] nullable

Gets or sets the municipality filter. Boreholes match if their municipality is in this set.

logToolTypeIdinteger[] nullable

Gets or sets the log tool type codelist IDs filter. Boreholes match if any of their log files have at least one of these tool type codelist IDs in their BDMS.Models.LogFile.LogFileToolTypeCodes.

identifierTypeIdinteger[] nullable

Gets or sets the identifier type (codelist) IDs filter. Boreholes match if at least one BDMS.Models.BoreholeCodelist row has a CodelistId in this set; combined with BDMS.Models.FilterRequest.IdentifierValue the predicates apply on the same row (strict semantics).

identifierValuestring nullable

Gets or sets the identifier value substring filter (case-insensitive).

nationalInterest'False' | 'True' | 'Null'

Represents a boolean filter value for nullable boolean fields.

topBedrockIntersected'False' | 'True' | 'Null'

Represents a boolean filter value for nullable boolean fields.

hasGroundwater'False' | 'True' | 'Null'

Represents a boolean filter value for nullable boolean fields.

hasGeometry'False' | 'True'