Skip to content

Study Document ​

lms.study_document

Fields ​

Every record also has id, created_at and updated_at.

FieldLabelTypeRules
useruserlink → core.userrequired
documentdocumentfilerequired
subject_labelsubject labeltextmax 255 characters
extracted_textextracted textlongtextmax 1000000 characters
processing_statusprocessing statusselectone of: Pending, Processed, Failed; default "Pending"
mind_mapmind mapjson
flashcardsflashcardsjson
quizquizjson
audio_overviewaudio overviewlongtextmax 200000 characters
video_overviewvideo overviewlongtextmax 200000 characters

Permissions ​

RoleCan
lms:adminread
lms:studentread, create, update, delete — only own rows (via user)
lms:facultyread, create, update, delete — only own rows (via user)

API ​

http
GET    /api/lms/study_document?<field>=<value>&limit=100&offset=0
POST   /api/lms/study_document
GET    /api/lms/study_document/:id
PATCH  /api/lms/study_document/:id
DELETE /api/lms/study_document/:id

Edulab Bench developer documentation