course_catalogs_get
Lists, searches or reads class catalogs, their memberships, classes and extension in the Course app (pApp C00007). Read only; changes go through the matching apply tool.
Inputs
| Field | Required here | Contract |
|---|---|---|
view |
No | When alternative 1: one of: catalogs, catalog_search, catalog_details, catalog_memberships, catalog_contents, catalog_extension, catalog_bulk_state (by kind); default {"kind":"catalogs"} |
view.page |
No | When alternative 1 and view.kind is catalog_search: integer; minimum 1; maximum 1000000; default 1 |
view.limit |
No | When alternative 1 and view.kind is catalog_search: 15 or 30 or 50 or 100; default 15 |
view.search |
No | When alternative 1 and view.kind is catalog_search: string; max length 500 |
view.isActive |
No | When alternative 1 and view.kind is catalog_search: boolean |
view.catalogId |
Yes | When alternative 1 and view.kind is catalog_details: string; min length 1; max length 128; pattern ^[A-Za-z0-9_-]+$ |
view.catalogId |
Yes | When alternative 1 and view.kind is catalog_memberships: string; min length 1; max length 128; pattern ^[A-Za-z0-9_-]+$ |
view.catalogId |
Yes | When alternative 1 and view.kind is catalog_contents: string; min length 1; max length 128; pattern ^[A-Za-z0-9_-]+$ |
view.seriesIds |
No | When alternative 1 and view.kind is catalog_contents: array; items: integer; greater than 0; max items 200 |
view.catalogId |
Yes | When alternative 1 and view.kind is catalog_extension: string; min length 1; max length 128; pattern ^[A-Za-z0-9_-]+$ |
view.catalogIds |
Yes | When alternative 1 and view.kind is catalog_bulk_state: array; items: string; min length 1; max length 128; pattern ^[A-Za-z0-9_-]+$; min items 1; max items 100 |
view |
Yes | When alternative 2: object |
view.kind |
Yes | When alternative 2: catalog_creation |