Sign in

v1

latestOpenAPI 3.0.02026-07-26221117272.0 KB
Field

Update field by id

Updates a single field by its id

put/api/v11/Field/{id}

Path parameters

idinteger required

Guid of a Field to be updated

Headers

X-HawkSearch-ApiKeystring required

Request body

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 request

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

Response

OK

object required