IndexFields

  • Actualizado en May 23, 2023
  • Publicado el Apr 21, 2023
  • 1 minuto(s) leído(s)
  • MB
  • DH
 Prev Next
This content is currently unavailable in Spanish. You are viewing the default (English) version.


 GET   /indexfields

Returns a list of index fields.

Query Parameters
ParameterTypeDescription
qStringA VisualVault REST API Data Query.
Response Codes
CodeDescription
400Bad Request


 POST   /indexfields

Create a new index field.

Body Parameters
ParameterTypeDescription
label*StringLabel for the index field.
descriptionStringDocument description.
fieldTypeStringIndex field type.
  • MultiLineTextBox
  • SingleLineTextBox
  • DatasourceDropDown
  • Calendar
  • Numeric
  • DropDownList
  • UsersDropDownList
  • ModifiableDropDownList
  • ModifiableDatasourceDropDown
dropDownListIdGuidThe drop down list ID.
queryIdGuidThe query ID.
queryDisplayFieldStringThe value to display.
queryValueFieldStringThe value to assign.
requiredBoolSets the index field 'Required' status.
defaultValueStringSets the default value of the index field.
Response Codes
CodeDescription
400Bad Request


 PUT   /indexfields/{id}

Update an existing index field.

Route Parameters
ParameterTypeDescription
id*GuidThe index field id.
Body Parameters
ParameterTypeDescription
labelStringLabel for the index field.
descriptionStringDocument description.
dropDownListIdGuidThe drop down list ID.
queryIdGuidThe query ID.
queryValueFieldStringThe value to assign.
queryDisplayFieldStringThe value to display.
requiredBoolSets the index field 'Required' status.
defaultValueStringSets the default value of the index field.
Response Codes
CodeDescription
400Bad Request


 PUT   /indexfields/{id}/folders/{childId}

Relate an index field to a document library folder.

Route Parameters
ParameterTypeDescription
id*GuidThe index field id.
childId*GuidThe folder id.