article_home_get
Reads home editor in the Article app (pApp B00001, or an instance code of the same family). Another app code is refused before any request.
Inputs
| Field | Required here | Contract |
|---|---|---|
view |
Yes | object |
view.kind |
Yes | article_home |
view.action |
No | one of: section-edit, section-visibility, banner-create, class-add, slide-edit, line-edit, banner-image, logo-clear, banner-class, slide-visibility, slide-duration-step, item-position, item-delete, restore-edit (by kind) |
view.action.sectionId |
Yes | When view.action.kind is section-edit: integer; greater than 0 |
view.action.fields |
Yes | When view.action.kind is section-edit: object |
view.action.fields.title |
No | When view.action.kind is section-edit: string; max length 40 |
view.action.fields.layout |
No | When view.action.kind is section-edit: 3_GRID_HORIZONTAL, 3_GRID_VERTICAL, 4_GRID_HORIZONTAL, 4_GRID_VERTICAL, 5_GRID_HORIZONTAL, 5_GRID_VERTICAL |
view.action.sectionId |
Yes | When view.action.kind is section-visibility: integer; greater than 0 |
view.action.visible |
Yes | When view.action.kind is section-visibility: boolean |
view.action.sectionId |
Yes | When view.action.kind is banner-create: integer; greater than 0 |
view.action.itemType |
Yes | When view.action.kind is banner-create: MAIN_BANNER_SLIDES, LINE_BANNER |
view.action.bannerType |
Yes | When view.action.kind is banner-create: SERIES, WEB_LINK |
view.action.sectionId |
Yes | When view.action.kind is class-add: integer; greater than 0 |
view.action.seriesId |
Yes | When view.action.kind is class-add: integer; greater than 0 |
view.action.sectionId |
Yes | When view.action.kind is slide-edit: integer; greater than 0 |
view.action.itemId |
Yes | When view.action.kind is slide-edit: integer; greater than 0 |
view.action.fields |
Yes | When view.action.kind is slide-edit: object |
view.action.fields.title |
No | When view.action.kind is slide-edit: string; max length 30 |
view.action.fields.description |
No | When view.action.kind is slide-edit: string; max length 50 |
view.action.fields.webLink |
No | When view.action.kind is slide-edit: string; max length 4096 |
view.action.sectionId |
Yes | When view.action.kind is line-edit: integer; greater than 0 |
view.action.itemId |
Yes | When view.action.kind is line-edit: integer; greater than 0 |
view.action.fields |
Yes | When view.action.kind is line-edit: object |
view.action.fields.webLink |
No | When view.action.kind is line-edit: string; max length 4096 |
view.action.fields.backgroundColor |
No | When view.action.kind is line-edit: string; pattern ^#[0-9a-fA-F]{8}$ |
view.action.sectionId |
Yes | When view.action.kind is banner-image: integer; greater than 0 |
view.action.itemId |
Yes | When view.action.kind is banner-image: integer; greater than 0 |
view.action.field |
Yes | When view.action.kind is banner-image: alternativeLogoSrc, backgroundDesktopImgSrc, backgroundMobileImgSrc, bannerImgSrc |
view.action.imageTaskId |
Yes | When view.action.kind is banner-image: string; pattern ^[A-Za-z0-9_-]{8,80}$ |
view.action.sectionId |
Yes | When view.action.kind is logo-clear: integer; greater than 0 |
view.action.itemId |
Yes | When view.action.kind is logo-clear: integer; greater than 0 |
view.action.sectionId |
Yes | When view.action.kind is banner-class: integer; greater than 0 |
view.action.itemType |
Yes | When view.action.kind is banner-class: MAIN_BANNER_SLIDES, LINE_BANNER |
view.action.itemId |
Yes | When view.action.kind is banner-class: integer; greater than 0 |
view.action.seriesId |
Yes | When view.action.kind is banner-class: integer; greater than 0 |
view.action.sectionId |
Yes | When view.action.kind is slide-visibility: integer; greater than 0 |
view.action.itemId |
Yes | When view.action.kind is slide-visibility: integer; greater than 0 |
view.action.visible |
Yes | When view.action.kind is slide-visibility: boolean |
view.action.sectionId |
Yes | When view.action.kind is slide-duration-step: integer; greater than 0 |
view.action.itemId |
Yes | When view.action.kind is slide-duration-step: integer; greater than 0 |
view.action.seconds |
Yes | When view.action.kind is slide-duration-step: 5 or 10 or 15 or 30 |
view.action.sectionId |
Yes | When view.action.kind is item-position: integer; greater than 0 |
view.action.itemType |
Yes | When view.action.kind is item-position: MAIN_BANNER_SLIDES, LINE_BANNER, SERIES_LIST |
view.action.itemId |
Yes | When view.action.kind is item-position: integer; greater than 0 |
view.action.previousItemId |
Yes | When view.action.kind is item-position: integer; greater than 0 or null |
view.action.nextItemId |
Yes | When view.action.kind is item-position: integer; greater than 0 or null |
view.action.sectionId |
Yes | When view.action.kind is item-delete: integer; greater than 0 |
view.action.itemType |
Yes | When view.action.kind is item-delete: MAIN_BANNER_SLIDES, LINE_BANNER, SERIES_LIST |
view.action.itemId |
Yes | When view.action.kind is item-delete: integer; greater than 0 |
view.action.confirmation |
Yes | When view.action.kind is item-delete: DELETE_HOME_ITEM |
view.action.sectionId |
Yes | When view.action.kind is restore-edit: integer; greater than 0 |
view.action.sourceTaskId |
Yes | When view.action.kind is restore-edit: string; pattern ^[A-Za-z0-9_-]{8,80}$ |
view.duration |
No | object |
view.duration.sectionId |
Yes | integer; greater than 0 |
view.duration.seconds |
Yes | 5 or 10 or 15 or 30 |
view.duration.itemIds |
No | array; items: integer; greater than 0; min items 1; max items 5 |
instanceCode |
No | string; pattern ^B(?:000|9[0-9]{2})01$; Optional: which installed Article app to use (its code, such as B00001 or B90101). Omit it when only one is installed; when several are, pick one from the installed list. |