Full name: projects.locations.schemas.list
Lists Schemas.
HTTP request
GET https://{endpoint}/v1/{parent}/schemas
Where {endpoint}
is one of the supported service endpoints
.
Path parameters
parent
string
Required. Format: projects/{project}/locations/{location}
It takes the form projects/{project}/locations/{location}
.
Authorization requires the following IAM
permission on the specified resource parent
:
-
documentai.schemas.list
Query parameters
| Parameters | |
|---|---|
pageSize
|
Optional. The maximum number of schema groups to return. If unspecified, at most |
pageToken
|
Optional. Returns the schema groups sorted by creation time. The page token will point to the next Schema. |
Request body
The request body must be empty.
Response body
Response message for schemas.list.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"schemas"
:
[
{
object (
|
| Fields | |
|---|---|
schemas[]
|
The list of Schemas. |
nextPageToken
|
Points to the next Schema, otherwise empty. |
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
IAM Permissions
Requires the following IAM
permission on the parent
resource:
-
documentai.schemas.list
For more information, see the IAM documentation .
