Skip to content

WorkspaceResource

API Access class for workspaces

Source code in src/specklepy/api/resources/current/workspace_resource.py 
21
22
23
24
25
26
27
28
def __init__(self, account, basepath, client, server_version) -> None:
    super().__init__(
        account=account,
        basepath=basepath,
        client=client,
        name=NAME,
        server_version=server_version,
    )

get 

get(workspace_id: str) -> Workspace
Source code in src/specklepy/api/resources/current/workspace_resource.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def get(self, workspace_id: str) -> Workspace:
    QUERY = gql(
        """
        query WorkspaceGet($workspaceId: String!) {
          data:workspace(id: $workspaceId) {
            id
            name
            role
            slug
            logo
            createdAt
            updatedAt
            readOnly
            description
            creationState
            {
              completed
            }
            permissions {
              canCreateProject {
                authorized
                code
                message
              }
            }
          }
        }
        """
    )

    variables = {
        "workspaceId": workspace_id,
    }

    return self.make_request_and_parse_response(
        DataResponse[Workspace], QUERY, variables
    ).data

get_projects 

get_projects(
    workspace_id: str,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[WorksaceProjectsFilter] = None,
) -> ResourceCollection[Project]
Source code in src/specklepy/api/resources/current/workspace_resource.py 
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def get_projects(
    self,
    workspace_id: str,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[WorksaceProjectsFilter] = None,
) -> ResourceCollection[Project]:
    QUERY = gql(
        """
        query Workspace($workspaceId: String!, $limit: Int!, $cursor: String, $filter: WorkspaceProjectsFilter) {
          data:workspace(id: $workspaceId) {
            data:projects(limit: $limit, cursor: $cursor, filter: $filter) {
              cursor
              items {
                allowPublicComments
                createdAt
                description
                id
                name
                role
                sourceApps
                updatedAt
                visibility
                workspaceId
              }
              totalCount
            }
          }
        }
        """  # noqa: E501
    )

    variables = {
        "workspaceId": workspace_id,
        "limit": limit,
        "cursor": cursor,
        "filter": filter.model_dump(warnings="error", by_alias=True)
        if filter
        else None,
    }

    return self.make_request_and_parse_response(
        DataResponse[DataResponse[ResourceCollection[Project]]], QUERY, variables
    ).data.data

get_projects_with_permissions 

get_projects_with_permissions(
    workspace_id: str,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[WorksaceProjectsFilter] = None,
) -> ResourceCollection[ProjectWithPermissions]
Source code in src/specklepy/api/resources/current/workspace_resource.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
def get_projects_with_permissions(
    self,
    workspace_id: str,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[WorksaceProjectsFilter] = None,
) -> ResourceCollection[ProjectWithPermissions]:
    QUERY = gql(
        """
        query Workspace($workspaceId: String!, $limit: Int!, $cursor: String, $filter: WorkspaceProjectsFilter) {
          data:workspace(id: $workspaceId) {
            data:projects(limit: $limit, cursor: $cursor, filter: $filter) {
              cursor
              items {
                allowPublicComments
                createdAt
                description
                id
                name
                role
                sourceApps
                updatedAt
                visibility
                workspaceId
                permissions {
                  canCreateModel {
                    code
                    authorized
                    message
                  }
                  canDelete {
                    code
                    authorized
                    message
                  }
                  canLoad {
                    code
                    authorized
                    message
                  }
                  canPublish {
                    code
                    authorized
                    message
                  }
                }
              }
              totalCount
            }
          }
        }
        """  # noqa: E501
    )

    variables = {
        "workspaceId": workspace_id,
        "limit": limit,
        "cursor": cursor,
        "filter": filter.model_dump(warnings="error", by_alias=True)
        if filter
        else None,
    }

    return self.make_request_and_parse_response(
        DataResponse[DataResponse[ResourceCollection[ProjectWithPermissions]]],
        QUERY,
        variables,
    ).data.data