course_lessons_get
Lists lessons or reads one video, text or live-coaching lesson, or prepares a lesson editor change in the Course app (pApp C00007). Read only; changes go through the matching apply tool.
Inputs
| Field | Required here | Contract |
|---|---|---|
view |
No | one of: course-editor, list, detail (by kind) |
view.postId |
Yes | When view.kind is course-editor: integer; greater than 0 |
view.change |
Yes | When view.kind is course-editor: one of: edit, restore-assets (by kind) |
view.change.fields |
Yes | When view.kind is course-editor and view.change.kind is edit: object |
view.change.fields.title |
No | When view.kind is course-editor and view.change.kind is edit: string; min length 1; max length 100 |
view.change.fields.description |
No | When view.kind is course-editor and view.change.kind is edit: string; max length 5000 |
view.change.fields.introduction |
No | When view.kind is course-editor and view.change.kind is edit: string; max length 250 |
view.change.fields.contentHtml |
No | When view.kind is course-editor and view.change.kind is edit: string; min length 2; max length 30000 |
view.change.fields.ageRating |
No | When view.kind is course-editor and view.change.kind is edit: integer; minimum 0; maximum 10000000 |
view.change.fields.coaching |
No | When view.kind is course-editor and view.change.kind is edit: object |
view.change.fields.coaching.link |
Yes | When view.kind is course-editor and view.change.kind is edit: string; max length 4096; format uri |
view.change.fields.coaching.startsAt |
Yes | When view.kind is course-editor and view.change.kind is edit: string; pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$; format date-time |
view.change.fields.coaching.durationMinutes |
Yes | When view.kind is course-editor and view.change.kind is edit: integer; greater than 0 |
view.change.fields.alerts |
No | When view.kind is course-editor and view.change.kind is edit: object |
view.change.fields.alerts.beforeStart |
Yes | When view.kind is course-editor and view.change.kind is edit: boolean |
view.change.fields.alerts.atStart |
Yes | When view.kind is course-editor and view.change.kind is edit: boolean |
view.change.fields.attachments |
No | When view.kind is course-editor and view.change.kind is edit: object |
view.change.fields.attachments.keepIndices |
Yes | When view.kind is course-editor and view.change.kind is edit: array; items: integer; minimum 0; maximum 9; max items 10 |
view.change.fields.attachments.addUploadTaskIds |
No | When view.kind is course-editor and view.change.kind is edit: array; items: string; pattern ^[A-Za-z0-9_-]{8,80}$; max items 10; default [] |
view.change.fields.thumbnailImageTaskId |
No | When view.kind is course-editor and view.change.kind is edit: string; pattern ^[A-Za-z0-9_-]{8,80}$ |
view.change.fields.inlineImages |
No | When view.kind is course-editor and view.change.kind is edit: array; min items 1; max items 100 |
view.change.fields.inlineImages[].token |
Yes | When view.kind is course-editor and view.change.kind is edit: string; pattern ^[A-Za-z][A-Za-z0-9_-]{0,39}$ |
view.change.fields.inlineImages[].imageTaskId |
Yes | When view.kind is course-editor and view.change.kind is edit: string; pattern ^[A-Za-z0-9_-]{8,80}$ |
view.change.sourceTaskId |
Yes | When view.kind is course-editor and view.change.kind is restore-assets: string; pattern ^[A-Za-z0-9_-]{8,80}$ |
view.query |
No | When view.kind is list: object; default {"page":1,"limit":15} |
view.query.page |
No | When view.kind is list: integer; minimum 1; maximum 10000; default 1 |
view.query.limit |
No | When view.kind is list: 15 or 30 or 50 or 100; default 15 |
view.query.search |
No | When view.kind is list: string; max length 200 |
view.query.isPublished |
No | When view.kind is list: boolean |
view.query.type |
No | When view.kind is list: VOD, PLAIN, LIVE_COACHING |
view.postId |
Yes | When view.kind is detail: integer; greater than 0 |