Version 4.0.24.20 (latest)
Get Project Workspace
Returns information about the state of the project files in the currently selected workspace
Request
GET
/projects/{project_id}/current_workspace
Datatype
Description
Request
path
Expand HTTP Path definition...
project_id
Project Id
query
Expand HTTP Query definition...
fields
Requested fields
Response
200: Project Workspace
Datatype
Description
(object)
can
lock
Operations the current user is able to perform on this object
project_id
lock
The id of the project
workspace_id
lock
The id of the local workspace containing the project files
git_status
lock
The status of the local git directory
git_head
lock
Git head revision name
dependency_status
lock
Status of the dependencies in your project. Valid values are: "lock_optional", "lock_required", "lock_error", "install_none".
git_branch
lock
GitBranch
Expand GitBranch definition...
can
lock
Operations the current user is able to perform on this object
name
The short name on the local. Updating `name` results in `git checkout `
remote
lock
The name of the remote
remote_name
lock
The short name on the remote
error
lock
Name of error
message
lock
Message describing an error if present
owner_name
lock
Name of the owner of a personal branch
readonly
lock
Whether or not this branch is readonly
personal
lock
Whether or not this branch is a personal branch - readonly for all developers except the owner
is_local
lock
Whether or not a local ref exists for the branch
is_remote
lock
Whether or not a remote ref exists for the branch
is_production
lock
Whether or not this is the production branch
ahead_count
lock
Number of commits the local branch is ahead of the remote
behind_count
lock
Number of commits the local branch is behind the remote
commit_at
lock
UNIX timestamp at which this branch was last committed.
ref
The resolved ref of this branch. Updating `ref` results in `git reset --hard ``.
remote_ref
lock
The resolved ref of this branch remote.
lookml_type
lock
The lookml syntax used by all files in this project
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link