Docs »

Records »

Types »

Role

Name (singular): Role
Name (plural): Roles
Alias (uri): role
Identifier (ID): cerberusweb.contexts.role

Records API

These fields are available in the Records API and packages:

Req’d Field Type Notes
  editor_query_worker text  
  links links An array of record type:id tuples to link to. Prefix with - to unlink.
  member_query_worker text  
x name text The name of this role
  params object JSON-encoded key/value object
  privs_mode text [””, all, itemized]
  reader_query_worker text  
  updated_at timestamp The date/time when this record was last modified

Dictionary Placeholders

These placeholders are available in dictionaries for bot behaviors, snippets, and API responses:

Field Type Description
_label text Label
editor_query_worker text Editor Query
id number Id
member_query_worker text Member Query
name text Name
privs_mode text Privileges Mode
reader_query_worker text Reader Query
updated_at date Updated

These optional placeholders are also available with key expansion in dictionaries and the API:

Field Type Description
comments comments Comments
custom_<id> mixed Custom Fields
links links Links

Search Query Fields

These filters are available in role search queries:

Field Type Description
editor: record Editor
fieldset: record Fieldset
id: number Id
links: links Record Links
member: record Member
name: text Name
privsMode: text Privileges Mode
reader: record Reader

Worklist Columns

These columns are available on role worklists:

Column Description
cf_<id> Custom Field
w_editor_query_worker Editor Query
w_id Id
w_member_query_worker Member Query
w_name Name
w_privs_mode Privileges Mode
w_reader_query_worker Reader Query
w_updated_at Updated