Records Response

RecordsResponse entity

id

  

string

   

required

Unique Folder (record) identifier.

name

  

string

   

Folder name.

---

description

  

string

   

Folder description.

---

uniqueReference

  

string

   

Unique reference used to identify the Folder (

record

) externally.

---

storageLocation

  

string

   

Physical data storage location.

---

recordSubtypeName

  

string

   

Record Subtype name.

---

recordSubtype

  

object

   

Record Subtype.

---

recordSubtypeOther

  

string

   

Record Subtype name if

recordSubtypeName = "other"

.

---

recordTypeName

  

string

   

The Hanger (

recordType

) name.

---

recordType

  

object

   

Hanger (

recordType

).

---

active

  

boolean

   

active = true

if the entity has not been deleted.

---

recordDetails

  

   

Specific Folder (

record

) fields.

---

status

  

string

   

Folder (

record

) status.

---

updatedAt

  

string

   

Date and time of most recent Folder (

record

) modification.

---

filesHistory

  

array of RecordsDetails objects

   

File (

record file

) history.

---

userSidedrawerRole

  

   

The User's role within the Drawer (

sidedrawer

). For example, "sd_editor".

---

userRecordRole

  

   

The User's role within the Folder (

record

). For example, "rec_editor".

---

---