IndexFields
- 23 May 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
IndexFields
- Updated on 23 May 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
GET /indexfields
Returns a list of index fields.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| q | String | A VisualVault REST API Data Query. |
Response Codes
| Code | Description |
|---|---|
| 400 | Bad Request |
POST /indexfields
Create a new index field.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| label* | String | Label for the index field. |
| description | String | Document description. |
| fieldType | String | Index field type.
|
| dropDownListId | Guid | The drop down list ID. |
| queryId | Guid | The query ID. |
| queryDisplayField | String | The value to display. |
| queryValueField | String | The value to assign. |
| required | Bool | Sets the index field 'Required' status. |
| defaultValue | String | Sets the default value of the index field. |
Response Codes
| Code | Description |
|---|---|
| 400 | Bad Request |
PUT /indexfields/{id}
Update an existing index field.
Route Parameters
| Parameter | Type | Description |
|---|---|---|
| id* | Guid | The index field id. |
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| label | String | Label for the index field. |
| description | String | Document description. |
| dropDownListId | Guid | The drop down list ID. |
| queryId | Guid | The query ID. |
| queryValueField | String | The value to assign. |
| queryDisplayField | String | The value to display. |
| required | Bool | Sets the index field 'Required' status. |
| defaultValue | String | Sets the default value of the index field. |
Response Codes
| Code | Description |
|---|---|
| 400 | Bad Request |
PUT /indexfields/{id}/folders/{childId}
Relate an index field to a document library folder.
Route Parameters
| Parameter | Type | Description |
|---|---|---|
| id* | Guid | The index field id. |
| childId* | Guid | The folder id. |
Was this article helpful?
