QueryWorkbookListItem¶

pydantic model openapi_client.models.query_workbook_list_item.QueryWorkbookListItem¶

A workbook as returned in the GET /workbooks listing. The listing projects a reduced attribute set, so the configuration objects (ChatConfiguration, QueryConfiguration), the expiry fields and the title-generation flags are never present here. Fetch GET /workbooks/{workbook_id} for the full record.

Fields:

access_type (str | None)
created_by (str | None)
creation_time (str | None)
is_pinned (bool | None)
last_modified_by (str | None)
last_modified_time (str | None)
recently_used (str | None)
title (str | None)
workbook_id (str | None)

field workbook_id: Optional[StrictStr] = None (alias 'WorkbookId')¶: Unique identifier for the workbook.

field title: Optional[StrictStr] = None (alias 'Title')¶: Workbook title.

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')¶: Workbook creation timestamp.

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')¶: User who created the workbook.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')¶: User who last modified the workbook. Absent if it has never been modified since creation.

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')¶: Last modification timestamp. Falls back to CreationTime when the workbook has never been modified.

field is_pinned: Optional[StrictBool] = None (alias 'IsPinned')¶: Whether the workbook is pinned for the caller. Defaults to false when not set.

field access_type: Optional[StrictStr] = None (alias 'AccessType')¶: The caller’s access level to the workbook.

field recently_used: Optional[StrictStr] = None (alias 'RecentlyUsed')¶: Computed recent-activity timestamp. Present only when the listing was requested with sortby=RecentlyUsed; it is not stored and is not returned for any other sort.

to_str()¶

Returns the string representation of the model using alias

Return type:: str

to_json()¶

Returns the JSON representation of the model using alias

Return type:: str

classmethod from_json(json_str)¶

Create an instance of QueryWorkbookListItem from a JSON string

Return type:: Optional[Self]

to_dict()¶

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:: Dict[str, Any]

classmethod from_dict(obj)¶

Create an instance of QueryWorkbookListItem from a dict

Return type:: Optional[Self]