Method: projects.locations.getStatus

Get the project status.

HTTP request

GET https://contentwarehouse.googleapis.com/v1/{location}:getStatus

Path parameters

Parameters
location

string

Required. The location to be queried Format: projects/{projectNumber}/locations/{location}. It takes the form projects/{project}/locations/{location}.

Request body

The request body must be empty.

Response body

status of a project, including the project state, dbType, aclMode and etc.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "location": string,
  "state": enum (ProjectState),
  "databaseType": enum (DatabaseType),
  "accessControlMode": enum (AccessControlMode),
  "documentCreatorDefaultRole": string,
  "qaEnabled": boolean
}
Fields
location

string

The location of the queried project.
state

enum (ProjectState)

state of the project.
databaseType

enum (DatabaseType)

Database type.
accessControlMode

enum (AccessControlMode)

Access control mode.
documentCreatorDefaultRole

string

The default role for the person who create a document.
qaEnabled

boolean

If the qa is enabled on this project.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ProjectState

state of a project.

Enums
PROJECT_STATE_UNSPECIFIED Default status, required by protobuf best practices.
PROJECT_STATE_PENDING The project is in the middle of a provision process.
PROJECT_STATE_COMPLETED All dependencies have been provisioned.
PROJECT_STATE_FAILED A provision process was previously initiated, but failed.
PROJECT_STATE_DELETING The project is in the middle of a deletion process.
PROJECT_STATE_DELETING_FAILED A deleting process was initiated, but failed.
PROJECT_STATE_DELETED The project is deleted.
PROJECT_STATE_NOT_FOUND The project is not found.