A Folder (record
) is a section within a Drawer (sidedrawer
) and Hanger (recordType
), within which multiple files (recordFile
) can be stored.
Once created, Folders can be accessed via API calls with the sidedrawerId
of the Drawer to which they belong, and their specific recordId
.
A Record Subtype is the tag attached to a Folder within a Hanger.
More info about the organization of entities here.
{
"name": "Important Documents",
"description": "",
"uniqueReference": "",
"storageLocation": "CA",
"recordSubtypeName": "Sales Tax",
"recordSubtypeOther": "",
"recordTypeName": "Tax Documents",
"editable": true,
"recordDetails": {
"createdAt": "2024-07-01T16:48:25.540Z",
"customFields": [
{
"formType": "string",
"id": "{id}",
"label": "My folder detail label",
"value": "My folder details"
}
],
"updatedAt": "2024-07-01T16:48:25.540Z"
},
"status": "",
"externalKeys": [
{
"key": "key",
"value": "value"
}
]
}
Folder (record
) entity
record
) entityname
string required
Folder (record
) name.
description
string
Folder (record
) description.
uniqueReference
string
Folder (record
) unique reference.
storageLocation
string
Physical storage location.
recordSubtypeName
string required
Record Subtype name.
recordSubtypeOther
string
Record Subtype name if recordSubtypeName = "other"
.
recordTypeName
string required
Hanger name.
editable
boolean
Set editable = true
if the Folder (record
) should be editable.
recordDetails
Record Subtype Specific Fields required
Specific Folder (record
) fields.
status
string
Folder (record
) status.
externalKeys
array of External Key entities
External key-value pairs.