The Folder Entity also called directory, is a way to organize Synapcus files. A folder is a storage cloud space, or container, where many files can be placed into groups and organize the Synapcus process. A folder can also contain other folders.
Database level
The entity's attributes are shown below. Mandatory fields are marked with a red star:
|
Name |
Type |
Label |
Description |
|---|---|---|---|
|
form * |
String |
Form |
Represents the entity form. Will always be "fld". |
|
fld_name * |
String |
Name |
The object name |
|
fld_created_from * |
String |
|
The parent process type under which the folder has been created and referenced. (e.g. "sop") |
|
fld_creation_date * |
Date/Time |
|
Represents the creation date and time of the object. |
|
fld_parent_unid * |
String |
|
The unique ID of the parent process type under which the folder has been created and referenced. |
|
fld_sender_name |
String |
|
The parent user under which the folder has been created and referenced. |
|
fld_sender_unid |
String |
|
The unique ID of the parent user under which the folder has been created and referenced. |
|
fld_sop_name |
String |
|
Represents the parent process document name if the parent ="sop" |
|
fld_sop_nr |
String |
|
Represents the parent process number if the parent ="sop" |
|
fld_sop_unid |
String |
|
Represents the unique ID of the parent process if the parent ="sop" |
|
sbd_fldpath_unid * |
String |
|
The unique ID of the folder as a path. |
|
sbd_fld_unid * |
String |
|
The unique ID of the parent folder, if any. |
|
sbd_sac_unid * |
String |
|
The unique ID of the parent activity. |
|
sbd_state * |
Number |
|
Represents the state of the folder as a number. |
|
sbd_state_text * |
String |
|
Represents the state of the folder as a text. |
|
sbd_type * |
Number |
|
Represents the folder type code. Will always be "fld" |
|
sbd_type_text * |
String |
|
Represents the folder type text. |
|
sdoc_created_from * |
String |
|
The parent process type under which the folder has been created and referenced. (e.g. "sop") |
QEE classes level
The class representing the Folder is QEEFld
Inherits from: QEEObject and QEESbd
REST level
The endpoints dealing with Folder are:
xrFld (GET, POST, PUT, DELETE)
xrFlds (GET, PUT, DELETE)