Get Project Workspace

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
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
project_id
string
Project Id
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields

Response

200: Project Workspace

Datatype
Description
(object)
can
object
Operations the current user is able to perform on this object
project_id
string
The id of the project
workspace_id
string
The id of the local workspace containing the project files
git_status
string
The status of the local git directory
git_head
string
Git head revision name
dependency_status
string
Status of the dependencies in your project. Valid values are: "lock_optional", "lock_required", "lock_error", "install_none".
git_branch
GitBranch
Expand GitBranch definition...
can
object
Operations the current user is able to perform on this object
name
string
The short name on the local. Updating `name` results in `git checkout `
remote
string
The name of the remote
remote_name
string
The short name on the remote
error
string
Name of error
message
string
Message describing an error if present
owner_name
string
Name of the owner of a personal branch
readonly
boolean
Whether or not this branch is readonly
personal
boolean
Whether or not this branch is a personal branch - readonly for all developers except the owner
is_local
boolean
Whether or not a local ref exists for the branch
is_remote
boolean
Whether or not a remote ref exists for the branch
is_production
boolean
Whether or not this is the production branch
ahead_count
integer
Number of commits the local branch is ahead of the remote
behind_count
integer
Number of commits the local branch is behind the remote
commit_at
integer
UNIX timestamp at which this branch was last committed.
ref
string
The resolved ref of this branch. Updating `ref` results in `git reset --hard ``.
remote_ref
string
The resolved ref of this branch remote.
lookml_type
string
The lookml syntax used by all files in this project

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link