Skip to content

ResourceMetadata

Source code in docs_src/capo_workdocs/types/resource_metadata.py
class ResourceMetadata(TypedDict, closed=True):
    type: NotRequired["capo_workdocs.types.resource_type.ResourceType"]
    """<p>The type of resource.</p>"""
    name: NotRequired["capo_workdocs.types.resource_name_type.ResourceNameType"]
    """<p>The name of the resource.</p>"""
    original_name: NotRequired[
        "capo_workdocs.types.resource_name_type.ResourceNameType"
    ]
    """<p>The original name of the resource before a rename operation.</p>"""
    id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
    """<p>The ID of the resource.</p>"""
    version_id: NotRequired[
        "capo_workdocs.types.document_version_id_type.DocumentVersionIdType"
    ]
    """<p>The version ID of the resource. This is an optional field and is filled for action on document version.</p>"""
    owner: NotRequired["capo_workdocs.types.user_metadata.UserMetadata"]
    """<p>The owner of the resource.</p>"""
    parent_id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
    """<p>The parent ID of the resource before a rename operation.</p>"""

id instance-attribute

id: NotRequired[ResourceIdType]

The ID of the resource.

name instance-attribute

name: NotRequired[ResourceNameType]

The name of the resource.

original_name instance-attribute

original_name: NotRequired[ResourceNameType]

The original name of the resource before a rename operation.

owner instance-attribute

owner: NotRequired[UserMetadata]

The owner of the resource.

parent_id instance-attribute

parent_id: NotRequired[ResourceIdType]

The parent ID of the resource before a rename operation.

type instance-attribute

type: NotRequired[ResourceType]

The type of resource.

version_id instance-attribute

version_id: NotRequired[DocumentVersionIdType]

The version ID of the resource. This is an optional field and is filled for action on document version.