Skip to content

ResponseItem

Source code in docs_src/capo_workdocs/types/response_item.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class ResponseItem(TypedDict, closed=True):
    resource_type: NotRequired[
        "capo_workdocs.types.response_item_type.ResponseItemType"
    ]
    """<p>The type of item being returned.</p>"""
    web_url: NotRequired["capo_workdocs.types.response_item_web_url.ResponseItemWebUrl"]
    """<p>The webUrl of the item being returned.</p>"""
    document_metadata: NotRequired[
        "capo_workdocs.types.document_metadata.DocumentMetadata"
    ]
    """<p>The document that matches the query.</p>"""
    folder_metadata: NotRequired["capo_workdocs.types.folder_metadata.FolderMetadata"]
    """<p>The folder that matches the query.</p>"""
    comment_metadata: NotRequired[
        "capo_workdocs.types.comment_metadata.CommentMetadata"
    ]
    """<p>The comment that matches the query.</p>"""
    document_version_metadata: NotRequired[
        "capo_workdocs.types.document_version_metadata.DocumentVersionMetadata"
    ]
    """<p>The document version that matches the metadata.</p>"""

comment_metadata instance-attribute 

comment_metadata: NotRequired[CommentMetadata]

The comment that matches the query.

document_metadata instance-attribute 

document_metadata: NotRequired[DocumentMetadata]

The document that matches the query.

document_version_metadata instance-attribute 

document_version_metadata: NotRequired[DocumentVersionMetadata]

The document version that matches the metadata.

folder_metadata instance-attribute 

folder_metadata: NotRequired[FolderMetadata]

The folder that matches the query.

resource_type instance-attribute 

resource_type: NotRequired[ResponseItemType]

The type of item being returned.

web_url instance-attribute 

web_url: NotRequired[ResponseItemWebUrl]

The webUrl of the item being returned.