Skip to content

WorkspaceResource

API Access class for workspace

Source code in src/specklepy/api/resources/current/workspace_resource.py 
15
16
17
18
19
20
21
def __init__(self, account, basepath, client, server_version) -> None:
    super().__init__(
        account=account,
        basepath=basepath,
        client=client,
        server_version=server_version,
    )

get 

get(workspace_id: str) -> Workspace
Source code in src/specklepy/api/resources/current/workspace_resource.py 
23
24
25
def get(self, workspace_id: str) -> Workspace:
    metrics.track(metrics.SDK, self.account, {"name": "Workspace Get"})
    return super().get(workspace_id)

get_projects 

get_projects(
    workspace_id: str,
    limit: int = 25,
    cursor: str | None = None,
    filter: WorksaceProjectsFilter | None = None,
) -> ResourceCollection[Project]
Source code in src/specklepy/api/resources/current/workspace_resource.py 
27
28
29
30
31
32
33
34
35
def get_projects(
    self,
    workspace_id: str,
    limit: int = 25,
    cursor: str | None = None,
    filter: WorksaceProjectsFilter | None = None,
) -> ResourceCollection[Project]:
    metrics.track(metrics.SDK, self.account, {"name": "Workspace Get Projects"})
    return super().get_projects(workspace_id, limit, cursor, filter)

get_projects_with_permissions 

get_projects_with_permissions(
    workspace_id: str,
    limit: int = 25,
    cursor: str | None = None,
    filter: WorksaceProjectsFilter | None = None,
) -> ResourceCollection[ProjectWithPermissions]
Source code in src/specklepy/api/resources/current/workspace_resource.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def get_projects_with_permissions(
    self,
    workspace_id: str,
    limit: int = 25,
    cursor: str | None = None,
    filter: WorksaceProjectsFilter | None = None,
) -> ResourceCollection[ProjectWithPermissions]:
    metrics.track(
        metrics.SDK,
        self.account,
        {"name": "Workspace Get Projects With Permissions"},
    )
    return super().get_projects_with_permissions(
        workspace_id, limit, cursor, filter
    )