Sign in

v1

latestOpenAPI 3.0.02026-07-26221117272.0 KB
Field

Get field by guid

Gets a single field by its guid

get/api/v11/Field/{guid}

Path parameters

guidstring uuid required

Guid of a Field to be loaded

Headers

X-HawkSearch-ApiKeystring required

Response

OK

FieldIdinteger
SyncGuidstring uuid
Labelstring
Namestring required
IsPrimaryKeyboolean required
Typestring
FieldTypestring required
Boostinteger
FacetHandlerinteger
IsOutputboolean required
IsShingleboolean required
IsBestFragmentboolean required
IsDictionaryboolean required
IsSortboolean required
IsPrefixboolean
IsHiddenboolean required
IsCompareboolean required
SortOrderinteger
PartialQuerystring
IsKeywordTextboolean required
IsQueryboolean required
IsQueryTextboolean required
SkipCustomboolean required
StripHtmlboolean required
MinNGramAnalyzerinteger
MaxNGramAnalyzerinteger
CoordinateTypeinteger
OmitNormsboolean
ItemMappingstring
DefaultValuestring
UseForPredictionboolean
CopyTostring
Analyzerstring
DoNotStoreboolean
Tagsstring
Iterationsinteger[]
AnalyzerLanguagestring
PreviewMappingstring
OmitTfAndPosboolean
CreateDatestring date-time
ModifyDatestring date-time
IsChildboolean
IsHierarchicalboolean

Example response

{
  "SyncGuid": "00000000-0000-0000-0000-000000000000"
}