Read items in full
get_itemsRead items of one kind in full.
When to use:
Before update_items, to see current values and part ids (playlist items pli_…, schedule blocks sb_…).
Checking how many rows of a sheet a repeating creative plays, and how many fit.
Checking an approval request, a fired emergency, a device test run, a person's locations and roles, a role's permissions, or who this connection is (kind account).
When NOT to use:
Searching by name: use list_items first.
Why a screen is blank, its outages or its TV state: use get_screen_status (get_items returns a screen's settings and assigned content).
What to know:
Returns a playlist's items in order, a schedule's blocks, a layout's zones, an app's config, a screen's status and content.
A creative that repeats for each row also returns repeatStatus: rowCount and rowsThatFit (what the last sync holds and how many play), limitedBy (rows, bytes or null), loopSeconds, columns (each header and its row tag), missingColumns, firstRowBindings, lastSyncedAt and warnings to pass on. rowCount is null when this connection cannot read that data source.
Sign-in details of feeds and web links stay in the Brix console: a stored one reads as ••••••••, never as its value. Items outside this connection's locations read as not found.
Parameters:
kind: the kind of every id. account takes no ids and returns this connection's actor, workspace and permissions.
ids: prefix-typed ids from list_items (pl_… playlist, scr_… screen, sch_… schedule); required for every kind but account. Each id returns its item or not found; the rest still return.
device_test_runs: call again until status is finished.
Example: {kind:"playlists", ids:["pl_8f2c"]}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Item ids. | |
| kind | Yes | Kind of the ids. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | The kind that was acted on. | |
| failed | No | How many failed; the rest still ran. | |
| results | No | One row per id or item, in the order given. | |
| succeeded | No | How many ids or items succeeded. |