GET
/
v1
/
worksheets
/
{worksheet}
{
  "name": "<string>",
  "project": "<string>",
  "database": "<string>",
  "title": "<string>",
  "creator": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "content": "<string>",
  "contentSize": "<string>",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "starred": true
}

Path Parameters

worksheet
string
required

The worksheet id.

Response

OK

name
string
required

The name of the worksheet resource, generated by the server. Canonical parent is project. Format: worksheets/{worksheet}

project
string
required

The project resource name. Format: projects/{project}

title
string
required

The title of the worksheet.

content
string<bytes>
required

The content of the worksheet. By default, it will be cut off in SearchWorksheet() method. If it doesn't match the content_size, you can use GetWorksheet() request to retrieve the full content.

visibility
enum<string>
required
Available options:
VISIBILITY_UNSPECIFIED,
PROJECT_READ,
PROJECT_WRITE,
PRIVATE
database
string

The database resource name. Format: instances/{instance}/databases/{database} If the database parent doesn't exist, the database field is empty.

creator
string

The creator of the Worksheet. Format: users/{email}

createTime
string<date-time>

The create time of the worksheet.

updateTime
string<date-time>

The last update time of the worksheet.

contentSize
string

content_size is the full size of the content, may not match the size of the content field.

starred
boolean

starred indicates whether the worksheet is starred by the current authenticated user.