---
title: "Data Types"
slug: "data-types"
updated: 2025-01-31T19:15:30Z
published: 2025-01-31T19:15:30Z
canonical: "docs.visualvault.com/data-types"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.visualvault.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Data Types

[Login to view all articles and content.](https://docs.visualvault.com/Login)

### Document

```custom

{
	"href": "Text"
	"dataType": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"documentId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"description": "Text"
	"releaseState": "0"
	"checkInStatus": "0"
	"revision": "0"
	"reviewDate": "Text"
	"expireDate": "Text"
	"archive": "0"
	"abstract": "Text"
	"keywords": "Text"
	"changeText": "Text"
	"folderId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"folderName": "Text"
	"folderPath": "Text"
	"fileId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fileName": "Text"
	"fileSize": "0"
	"extension": "Text"
	"contentType": "Text"
	"checkedInBy": "Text"
	"checkedOutById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"checkedOutBy": "Text"
	"checkOutDate": "Text"
	"createDate": "Text"
	"createById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createBy": "Text"
	"modifyDate": "Text"
	"modifyById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyBy": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | The url path. |
| dataType | string | Data type of object. |
| id | guid | Revision Id of the Document. |
| documentId | guid | Document Id. |
| name | string | Document Name. |
| description | string | Description of Document. |
| releaseState | int | Document release state. - Unreleased (0) - Released (1) - Pending (2) |
| checkInStatus | int | Document check in status. - Checked In (0) - Checked Out (1) |
| revision | int | Document revision number. |
| reviewDate | string | Date reviewed. |
| expireDate | string | Date expires. |
| archive | int | Archive status - Active (0) - Archived (1) - Deleted (2) - Purged (3) |
| abstract | string | Abstract. |
| keywords | string | Keywords. |
| changeText | string | Reason text changed. |
| folderId | guid | Folder Id containing the document. |
| folderName | string | Name of folder. |
| folderPath | string | Path to folder. |
| fileId | guid | File Id. |
| fileName | string | File Name. |
| fileSize | int | Size of file in bytes. |
| extension | string | File extension. |
| contentType | string | Content type of file. |
| checkedInBy | string | User whom checked in file. |
| checkedOutById | guid | Id of user whom checked out document. |
| checkedOutBy | string | User whom checked out file. |
| checkOutDate | string | Date document checked out. |
| createDate | string | Date document created. |
| createById | guid | Id of user whom created document. |
| createBy | string | User whom created document. |
| modifyDate | string | Most recent date that the document was modified. |
| modifyById | guid | Id of user whom modified document. |
| modifyBy | string | User whom modified document. |

### DocumentIndexField

```custom

{
	"href": "Text"
	"dataType": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"dhId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fieldId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fieldType": "0"
	"label": "Text"
	"description": "Text"
	"ordinalPosition": "0"
	"required": "true"
	"units": "Text"
	"value": "Text"
	"createDate": "Text"
	"createById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createBy": "Text"
	"modifyDate": "Text"
	"modifyById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyBy": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | The path to document. |
| dataType | string | Data type of object. |
| id | guid | Revision Id of the Document. |
| dhId | guid | Revision Id of the Document Index Field. |
| fieldId | guid | Document Index Field Id. |
| fieldType | int | The data type of the index field. - MultiLineTextBox (0) - TextBox (1) - DatasourceDropDown (2) - AjaxTextBox (3) - Calendar (4) - Numeric (5) - DropDownList (6) - UsersDropDownList (7) - ModifiableDropDownList (8) - ModifiableDatasourceDropDown (9) |
| label | string | Name of Document Index Field. |
| description | string | Description of Document Index Field. |
| ordinalPosition | int | order postion of indexfield displayed. |
| required | boolean | True or False if Document Index Field is required for Document. |
| units | string | Units of Index Field. |
| value | string | Value of Document Index Field. |
| createDate | string | Date Document Index Field created. |
| createById | guid | Id of user whom created Document Index Field. |
| createBy | string | User whom created Document Index Field. |
| modifyDate | string | Most recent date that the Document Index Field was modified. |
| modifyById | guid | Id of user whom modified Document Index Field. |
| modifyBy | string | User whom modified Document Index Field. |

### Folder

```custom

{
	"href": "Text"
	"dataType": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"modifyDate": "Text"
	"modifyById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createDate": "Text"
	"createById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"topLevelFolderId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"folderType": "0"
	"status": "0"
	"folderPath": "Text"
	"parentFolderId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | Url path to folder. |
| dataType | string | Datatype. |
| id | guid | Folder Id. |
| name | string | Name of folder. |
| modifyDate | string | The date/time the folder was last modified. |
| modifyById | guid | Id of the user whom modified the folder. |
| createDate | string | The date/time the folder was created. |
| createById | guid | The Id of the user that created the folder. |
| topLevelFolderId | guid | Id of top level folder. |
| folderType | int | The folder type. - Current Store (0) - Document Library (1) - Container (2) - Subcontainer (3) - Folder (4) - Template (5) - Not a folder (6) |
| status | int | Current folder status. - Active (0) - Deleted (1) |
| folderPath | string | The path of the folder starting at the root of the document library. For example, '/General' or '/Attachments'. |
| parentFolderId | guid | Id of the parent folder. |

### FolderIndexField

```custom

{
	"href": "Text"
	"datatype": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"definitionpkey": "0"
	"folderid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fieldtype": "0"
	"label": "Text"
	"description": "Text"
	"ordinalposition": "0"
	"folderordinalposition": "0"
	"required": "true"
	"connectionid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"queryid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"querydisplayfield": "Text"
	"queryvaluefield": "Text"
	"dropdownlistid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"defaultvalue": "Text"
	"globalrequired": "true"
	"globalconnectionid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"globalqueryid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"globalqueryvaluefield": "Text"
	"globalquerydisplayfield": "Text"
	"globaldropdownlistid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"globaldefaultvalue": "Text"
	"createdate": "Text"
	"createbyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createby": "Text"
	"modifydate": "Text"
	"modifybyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyby": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | The path to document. |
| datatype | string | Data type of object. |
| id | guid | Id of the Folder Index Field. |
| definitionpkey | int | Primary key. |
| folderid | guid | Folder Id. |
| fieldtype | int | Type of field. - MultiLineTextBox (0) - SingleLineTextBox (1) - DatasourceDropDown (2) - AjaxTextBox (3) - Calendar (4) - Numeric (5) - DropDownList (6) - UsersDropDownList (7) - ModifiableDropDownList (8) - ModifiableDatasourceDropDown (9) |
| label | string | Name of Document Index Field. |
| description | string | Description of Folder Index Field. |
| ordinalposition | int | order position displayed of Index Field. |
| folderordinalposition | int | Order position displayed of Index Field in folder. |
| required | boolean | True or False if Folder Index Field is required for Document. |
| connectionid | guid | Id of connection. |
| queryid | guid | Id of query. |
| querydisplayfield | string | Display field type of query. |
| queryvaluefield | string | Value of field query. |
| dropdownlistid | guid | Id of drop down list. |
| defaultvalue | string | Default value of Folder Index Field. |
| globalrequired | boolean | True or false if Folder Index Field is required. |
| globalconnectionid | guid | Global connection Id. |
| globalqueryid | guid | Global query Id. |
| globalqueryvaluefield | string | Value of global field query. |
| globalquerydisplayfield | string | Display field type of global query. |
| globaldropdownlistid | guid | Id of drop down list globally. |
| globaldefaultvalue | string | Default value globally. |
| createdate | string | Date Folder Index Field created. |
| createbyid | guid | Id of user whom created Folder Index Field. |
| createby | string | User whom created Folder Index Field. |
| modifydate | string | Most recent date that the Folder Index Field was modified. |
| modifybyid | guid | Id of user whom modified Folder Index Field. |
| modifyby | string | User whom modified Folder Index Field. |

### FormInstance

```custom

{
	"href": "Text"
	"datatype": "Text"
	"revisionid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"instancename": "Text"
	"modifydate": "Text"
	"modifybyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyby": "Text"
	"createdate": "Text"
	"createbyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createby": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | URL path to object. |
| datatype | string | Object type. |
| revisionid | guid | The revision specific ID of the form instance. |
| instancename | string | The name of the form instance. |
| modifydate | string | The date/time the form instance was last modified. |
| modifybyid | guid | The ID of the user that last modified the form instance. |
| modifyby | string | The display name of the user that last modified the form instance. |
| createdate | string | The date/time that the form instance was created. |
| createbyid | guid | The ID of the user that create the form instance. |
| createby | string | The display name of the user that created the form instance. |

### FormTemplate

```custom

{
	"href": "Text"
	"datatype": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"modifydate": "2023-01-01"
	"modifybyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyby": "Text"
	"createdate": "2023-01-01"
	"createbyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createby": "Text"
	"description": "Text"
	"revisionid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"revision": "0"
	"templaterevision": "0"
	"status": "0"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | The url path. |
| datatype | string | Data type of object. |
| id | guid | Revision Id of the Form Template. |
| name | string | Form Template Name. |
| modifydate | datetime | The date/time the form template was last modified. |
| modifybyid | guid | The ID of the user that last modified the form template. |
| modifyby | string | The display name of the user that last modified the form template. |
| createdate | datetime | The date/time the form template was created. |
| createbyid | guid | The ID of the user that created the form template. |
| createby | string | The display name of the user that created the form template. |
| description | string | The description of the form template. |
| revisionid | guid | The revision specific ID of the form template. |
| revision | int | Current revision of the form. Each time you revise a form, this number increases by one. |
| templaterevision | int | Revision Number of Template. |
| status | int | Current status of the form template. - CheckedIn (1) - CheckedOut (2) |

### Group

```custom

{
	"href": "Text"
	"datatype": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"description": "Text"
	"siteid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | The url path. |
| datatype | string | Data type of object. |
| id | guid | The Id of the group used. |
| name | string | The name of the group. |
| description | string | The description of the group. |
| siteid | guid | The Id of the site that the group belongs to. |

### IndexFieldDefinition

```custom

{
	"href": "Text"
	"datatype": "Text"
	"pkey": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fieldtype": "0"
	"label": "Text"
	"description": "Text"
	"required": "true"
	"connectionid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"queryid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"querydisplayfield": "Text"
	"queryvaluefield": "Text"
	"dropdownlistid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"defaultvalue": "Text"
	"createdate": "Text"
	"createbyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createby": "Text"
	"modifydate": "Text"
	"modifybyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyby": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | The path to document. |
| datatype | string | Data type of object. |
| pkey | guid | Primary key. |
| id | guid | Id of the Folder Index Field |
| fieldtype | int | Type of field. - MultiLineTextBox (0) - SingleLineTextBox (1) - DatasourceDropDown (2) - AjaxTextBox (3) - Calendar (4) - Numeric (5) - DropDownList (6) - UsersDropDownList (7) - ModifiableDropDownList (8) - ModifiableDatasourceDropDown (9) |
| label | string | Name of Index Field Definition. |
| description | string | Description of Index Field Definition. |
| required | boolean | True or False if Index Field is required. |
| connectionid | guid | Id of connection. |
| queryid | guid | Id of query. |
| querydisplayfield | string | Display field type of query. |
| queryvaluefield | string | Value of field query. |
| dropdownlistid | guid | Id of drop down list. |
| defaultvalue | string | Default value of Index Field Definition. |
| createdate | string | Date Index Field Definition was created. |
| createbyid | guid | Id of user whom created Index Field Definition. |
| createby | string | User whom created Index Field Definition. |
| modifydate | string | Most recent date that the Index Field Definition was modified. |
| modifybyid | guid | Id of user whom modified Index Field Definition. |
| modifyby | string | User whom modified Index Field Definition. |

### IndexFieldSelectOption

```custom

{
	"href": "Text"
	"datatype": "Text"
	"display": "Text"
	"value": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | The url path. |
| datatype | string | Data type of object. |
| display | string | The value displayed. |
| value | string | The value stored. |

### Site

```custom

{
	"href": "Text"
	"datatype": "Text"
	"description": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"sitetype": "Text"
	"status": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | The url path. |
| datatype | string | Data type of object. |
| description | string | A description of the site. |
| id | guid | The ID of the site, used in API calls. |
| name | string | The name of the site. |
| sitetype | string | The type of the site. - Location - Customer - Supplier |
| status | string | The status of the site. - Open - Closed |

### User

```custom

{
	"href": "Text"
	"datatype": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"userid": "Text"
	"firstname": "Text"
	"middleinitial": "Text"
	"lastname": "Text"
	"passwordexpires": "2023-01-01"
	"useridexpires": "2023-01-01"
	"emailaddress": "Text"
	"siteid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"useridneverexpires": "true"
	"passwordneverexpires": "true"
	"enabled": "true"
	"lastipaddress": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| href | string | The url path. |
| datatype | string | Data type of object. |
| id | guid | The ID of the user, used in API calls. |
| name | string | The display name of the user. |
| userid | string | The username of the user. |
| firstname | string | The first name of the user. |
| middleinitial | string | The middle initial of the user. |
| lastname | string | The last name of the user. |
| passwordexpires | datetime | The date/time that the password of the user expires. Can be null. |
| useridexpires | datetime | The date/time that the UserID of the user expires and needs to be changed. Can be null. |
| emailaddress | string | The email address of the user. |
| siteid | guid | The ID of the home site of the user. |
| useridneverexpires | bool | True if the UserID never expires. |
| passwordneverexpires | bool | True if the password never expires. |
| enabled | bool | True if the user is enabled. |
| lastipaddress | string | The last IP address that the user did a web login from. |

### IndexField

```custom

{
	"indexfield": "value"
	"indexfield2": "value"
	"indexfield3": "value"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexfield | value | The value of the index field. |
| indexfield2 | value | The value of the index field. |
| indexfield3 | value | The value of the index field. |

### DocumentList

```custom

{
	"dhDocId": "Text"
	"dhFilename": "Text"
	"dhId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| dhDocId | string | Document DhDocID. |
| dhFilename | string | The name of the file. |
| dhId | guid | Document DhId |

### DhId

```custom

{
	"documentId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"documentId2": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"documentId3": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentId | guid | DhId of the document. |
| documentId2 | guid | DhId of the document. |
| documentId3 | guid | DhId of the document. |

### FileParameter

```custom

{
	"source": "Text"
	"command": "Text"
	"ocrStatus": "Text"
	"keepAnnotations": "true"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| source | string |  |
| command | string |  |
| ocrStatus | string |  |
| keepAnnotations | bool |  |

### SecurityMemberApplyAction

```custom

{
	"memberID": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"memberType": "Text"
	"roleType": "Text"
	"action": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| memberID | guid | The member ID. |
| memberType | string | The member type. - User - Group |
| roleType | string | The role type. - None (0) - Owner (1) - Editor (2) - Publisher (3) - Viewer (4) - Member (5) |
| action | string | The security action. - Add - Remove |

### DropDownQuery

```custom

{
	"fieldId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fieldName": "Text"
	"parameterValue": "Text"
	"value": "Text"
	"type": "field"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| fieldId | guid |  |
| fieldName | string |  |
| parameterValue | string |  |
| value | string |  |
| type | field |  |

### FormTemplateCategoryRelation

```custom

{
	"relationId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"categoryId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"categoryName": "Text"
	"formTemplateId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"formTemplateName": "Text"
	"formTemplateDescription": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| relationId | guid |  |
| categoryId | guid |  |
| categoryName | string |  |
| formTemplateId | guid |  |
| formTemplateName | string |  |
| formTemplateDescription | string |  |

### FormControlList

```custom

{
	"id1": "Text"
	"value1": "Text"
	"id2": "Text"
	"value2": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| id1 | string |  |
| value1 | string |  |
| id2 | string |  |
| value2 | string |  |

### FieldList

```custom

{
	"field": ""Value 1""
	"field2": ""Value 2""
	"field3": ""Value 3""
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| field | value | The value of the given field. |
| field2 | value | The value of the given field. |
| field3 | value | The value of the given field. |

### FillinMapping

```custom

{
	"targetId": "Text"
	"value": "Text"
	"text": "Text"
}
```

| Parameter | Type | Description |
| --- | --- | --- |
| targetId | string |  |
| value | string |  |
| text | string |  |