rest.workspace.views¶
REST views for the workspace API
-
class
rest.workspace.views.WorkspaceDetail(**kwargs)¶ Bases:
rest_framework.views.APIViewWorkspace Detail
-
delete(request, pk)¶ Delete a Workspace
Parameters: - request – HTTP request
- pk – ObjectId
Returns: - 204
content: Deletion succeed
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
get(request, pk)¶ Get Workspace from db
Parameters: - request – HTTP request
- pk – ObjectId
Returns: Workspace
-
permission_classes= (<class 'rest_framework.permissions.IsAuthenticated'>,)¶
-
-
class
rest.workspace.views.WorkspaceList(**kwargs)¶ Bases:
rest_framework.views.APIViewList all user Workspace, or create a new one
-
get(request)¶ Get all user workspaces
Parameters: request – HTTP request Returns: - 200
- content: List of workspace
- code: 500 content: Internal server error
Return type: - code
-
permission_classes= (<class 'rest_framework.permissions.IsAuthenticated'>,)¶
-
post(request)¶ Create a Workspace
Parameters: - { – “title”: “document_title”,
- } –
- request – HTTP request
Returns: - 201
content: Created workspace
- code: 400 content: Validation error / not unique / model error
- code: 500 content: Internal server error
Return type: - code
-
-
rest.workspace.views.add_group_read_right_to_workspace(*args, **kwargs)¶ Add to the group the read right to the workspace
Parameters: - request – HTTP request
- pk – ObjectId
- group_id – ObjectId
Returns: - 200
content: None
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.add_group_write_right_to_workspace(*args, **kwargs)¶ Add to the group the write right to the workspace
Parameters: - request – HTTP request
- pk – ObjectId
- group_id – ObjectId
Returns: - 200
content: None
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.add_user_read_right_to_workspace(*args, **kwargs)¶ Add to the user the read right to the Workspace
Parameters: - request – HTTP request
- pk – ObjectId
- user_id – ObjectId
Returns: - 200
content: None
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.add_user_write_right_to_workspace(*args, **kwargs)¶ Add to the user the write right to the workspace
Parameters: - request – HTTP request
- pk – ObjectId
- user_id – ObjectId
Returns: - 200
content: None
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.get_list_group_can_access_workspace(*args, **kwargs)¶ Get list of groups that have read or write access to workspace
Parameters: request – HTTP request Returns: - 200
- content: list of group
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.get_list_group_can_read_workspace(*args, **kwargs)¶ Get list of groups that have read access to workspace
Parameters: request – HTTP request Returns: - 200
- content: list of group
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.get_list_group_can_write_workspace(*args, **kwargs)¶ Get list of groups that have write access to workspace
Parameters: request – HTTP request Returns: - 200
- content: list of group
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.get_list_user_can_access_workspace(*args, **kwargs)¶ Get list of users that have read or write access to workspace
Parameters: request – HTTP request Returns: - 200
- content: list of user
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.get_list_user_can_read_workspace(*args, **kwargs)¶ Get list of users that have read access to workspace
Parameters: request – HTTP request Returns: - 200
- content: list of user
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.get_list_user_can_write_workspace(*args, **kwargs)¶ Get list of users that have write access to workspace
Parameters: request – HTTP request Returns: - 200
- content: list of user
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.get_workspaces_with_read_access(*args, **kwargs)¶ Get all workspaces with read access
Parameters: request – HTTP request Returns: - 200
- content: list of workspace
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.get_workspaces_with_write_access(*args, **kwargs)¶ Get all workspaces with write access
Parameters: request – HTTP request Returns: - 200
- content: list of workspace
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.is_workspace_public(*args, **kwargs)¶ Is the workspace public
Parameters: - request – HTTP request
- pk – ObjectId
Returns: - 200
content: Boolean
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.remove_group_read_right_to_workspace(*args, **kwargs)¶ Remove from the group the read right to the workspace
Parameters: - request – HTTP request
- pk – ObjectId
- group_id – ObjectId
Returns: - 200
content: None
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.remove_group_write_right_to_workspace(*args, **kwargs)¶ Remove from the group the write right to the workspace
Parameters: - request – HTTP request
- pk – ObjectId
- group_id – ObjectId
Returns: - 200
content: None
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.remove_user_read_right_to_workspace(*args, **kwargs)¶ Remove from the user the read right to the workspace
Parameters: - request – HTTP request
- pk – ObjectId
- user_id – ObjectId
Returns: - 200
content: None
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.remove_user_write_right_to_workspace(*args, **kwargs)¶ Remove from the user the write right to the workspace
Parameters: - request – HTTP request
- pk – ObjectId
- user_id – ObjectId
Returns: - 200
content: None
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.set_workspace_private(*args, **kwargs)¶ Set the workspace private
Parameters: - request – HTTP request
- pk – ObjectId
Returns: - 200
content: None
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code
-
rest.workspace.views.set_workspace_public(*args, **kwargs)¶ Set the workspace public
Parameters: - request – HTTP request
- pk – ObjectId
Returns: - 200
content: None
- code: 403 content: Authentication error
- code: 404 content: Object was not found
- code: 500 content: Internal server error
Return type: - code