workspace

workspace#

Classes:

`JobGroup`	User-defined group of jobs within a workspace.
`Workspace`	A workspace within a project, which contains jobs and related data.
`WorkspaceLastAccessed`	Record for when a user last accessed a workspace.
`WorkspaceStats`	Statistics about the contents of a workspace.

class JobGroup#

User-defined group of jobs within a workspace.

Attributes:

`color`
`description`
`id`
`jobs`
`title`

color: str | None#

description: str | None#

id: int#

jobs: List[str]#

title: str | None#

class Workspace#

A workspace within a project, which contains jobs and related data. Jobs are stored in a flat structure within the project and linked to one or more workspaces.

Attributes:

`created_at`	When this object was first created.
`created_by_job_uid`
`created_by_user_id`	User ID that created the workspace.
`deleted`
`deleting`
`description`
`dumped_at`	When the model was last dumped to disk
`groups`
`id`
`imported_at`
`last_accessed`
`last_dumped_version`	The version of CryoSPARC last dumped at
`project_uid`	Project unique ID for , e.g., 'P1'.
`project_uid_num`	Numeric part of the project UID.
`starred_by`	List of user IDs who have starred the workspace.
`tags`
`title`
`uid`	Workspace unique ID, e.g., 'W1'.
`uid_num`	Numeric part of the workspace UID.
`updated_at`	When this object was last modified.
`workspace_stats`
`workspace_type`	Workspace type, either 'base' or 'live'.

created_at: datetime#: When this object was first created. Imported objects such as projects and jobs will retain the created time from their original CryoSPARC instance.

created_by_job_uid: str | None#

created_by_user_id: str | None#: User ID that created the workspace.

deleted: bool#

deleting: bool#

description: str | None#

dumped_at: datetime | None#: When the model was last dumped to disk

groups: List[JobGroup]#

id: str#

imported_at: datetime | None#

last_accessed: WorkspaceLastAccessed | None#

last_dumped_version: str | None#: The version of CryoSPARC last dumped at

project_uid: str#: Project unique ID for , e.g., ‘P1’.

project_uid_num: int#: Numeric part of the project UID.

starred_by: List[str]#: List of user IDs who have starred the workspace.

tags: List[str]#

title: str | None#

uid: str#: Workspace unique ID, e.g., ‘W1’.

uid_num: int#: Numeric part of the workspace UID.

updated_at: datetime#: When this object was last modified.

workspace_stats: WorkspaceStats#

workspace_type: Literal['base', 'live']#: Workspace type, either ‘base’ or ‘live’.

class WorkspaceLastAccessed#

Record for when a user last accessed a workspace.

Attributes:

`accessed_at`	Timestamp of the last access.
`name`	Username that last accessed the workspace.

accessed_at: datetime#: Timestamp of the last access.

name: str#: Username that last accessed the workspace.

class WorkspaceStats#

Statistics about the contents of a workspace.

Attributes:

`job_count`
`job_sections`	Number of jobs per section.
`job_status`	Number of jobs per status.
`job_types`	Number of jobs per type.
`updated_at`

job_count: int#

job_sections: Dict[str, int]#: Number of jobs per section.

job_status: Dict[str, int]#: Number of jobs per status.

job_types: Dict[str, int]#: Number of jobs per type.

updated_at: datetime | None#

workspace

Contents

workspace#