Skip to content

PutAttachmentRequest

Source code in docs_src/capo_glue/types/put_attachment_request.py
class PutAttachmentRequest(TypedDict, closed=True):
    asset_identifier: "capo_glue.types.asset_id.AssetId"
    """<p>The unique identifier of the asset to attach the form to.</p>"""
    iterable_form_name: NotRequired[
        "capo_glue.types.iterable_form_name.IterableFormName"
    ]
    """<p>The name of the iterable form. When specified along with <code>itemIdentifier</code>, the attachment targets an item within the iterable form rather than the asset itself.</p>"""
    item_identifier: NotRequired["capo_glue.types.item_identifier.ItemIdentifier"]
    """<p>The identifier of the item within the iterable form. Required when <code>iterableFormName</code> is specified.</p>"""
    attachment_name: "capo_glue.types.attachment_name.AttachmentName"
    """<p>The name of the attachment.</p>"""
    content: "capo_glue.types.form_content.FormContent"
    """<p>The JSON content of the form, conforming to the schema of the specified form type.</p>"""
    form_type_id: "capo_glue.types.form_type_id.FormTypeId"
    """<p>The identifier of the form type for this attachment.</p>"""
    client_token: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""

asset_identifier instance-attribute

asset_identifier: AssetId

The unique identifier of the asset to attach the form to.

attachment_name instance-attribute

attachment_name: AttachmentName

The name of the attachment.

client_token instance-attribute

client_token: NotRequired[HashString]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

content instance-attribute

content: FormContent

The JSON content of the form, conforming to the schema of the specified form type.

form_type_id instance-attribute

form_type_id: FormTypeId

The identifier of the form type for this attachment.

item_identifier instance-attribute

item_identifier: NotRequired[ItemIdentifier]

The identifier of the item within the iterable form. Required when iterableFormName is specified.

iterable_form_name instance-attribute

iterable_form_name: NotRequired[IterableFormName]

The name of the iterable form. When specified along with itemIdentifier, the attachment targets an item within the iterable form rather than the asset itself.