Skip to main content
POST
/
v1
/
worksheets:search
cURL
curl --request POST \
  --url https://api.example.com/v1/worksheets:search \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": "<string>"
}
'
{
  "worksheets": [
    {
      "name": "<string>",
      "project": "<string>",
      "title": "<string>",
      "content": "<string>",
      "visibility": "VISIBILITY_UNSPECIFIED",
      "database": "<string>",
      "creator": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z",
      "contentSize": "<string>",
      "starred": true,
      "folders": [
        "<string>"
      ]
    }
  ]
}

Body

application/json
​
filter
string

To filter the search result. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filter:

  • creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
  • starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
  • visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
  • project: the project full name in "projects/{id}" format, support "==" operator.

For example: creator == "users/{email}" creator != "users/{email}" starred == true starred == false visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"] visibility == "PRIVATE" project == "projects/{project resource id}"

Response

OK

​
worksheets
object[]

The worksheets that matched the search criteria.