Skip to content

IterableFormItem

Source code in docs_src/capo_glue/types/iterable_form_item.py
class IterableFormItem(TypedDict, closed=True):
    item_id: NotRequired["capo_glue.types.item_id.ItemId"]
    """<p>The unique identifier of the item.</p>"""
    item_name: NotRequired["capo_glue.types.item_name.ItemName"]
    """<p>The name of the item.</p>"""
    glossary_terms: NotRequired[
        "capo_glue.types.glossary_term_id_list.GlossaryTermIdList"
    ]
    """<p>The identifiers of the glossary terms associated with the item.</p>"""
    forms: NotRequired["capo_glue.types.asset_form_map.AssetFormMap"]
    """<p>The forms on the item, keyed by form name.</p>"""
    attachments: NotRequired["capo_glue.types.asset_form_map.AssetFormMap"]
    """<p>Additional attachments on the item for more context, keyed by attachment name.</p>"""

attachments instance-attribute

attachments: NotRequired[AssetFormMap]

Additional attachments on the item for more context, keyed by attachment name.

forms instance-attribute

forms: NotRequired[AssetFormMap]

The forms on the item, keyed by form name.

glossary_terms instance-attribute

glossary_terms: NotRequired[GlossaryTermIdList]

The identifiers of the glossary terms associated with the item.

item_id instance-attribute

item_id: NotRequired[ItemId]

The unique identifier of the item.

item_name instance-attribute

item_name: NotRequired[ItemName]

The name of the item.