Method: schemas.list

Full name: projects.locations.schemas.list

Lists Schemas.

HTTP request

GET https://{endpoint}/v1beta3/{parent}/schemas

Where {endpoint} is one of the supported service endpoints.

Path parameters

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

integer

Optional. The maximum number of schema groups to return. If unspecified, at most 10 Schema will be returned. The maximum value is 20. Values above 20 will be coerced to 20.
pageToken

string

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 (NextSchema)
    }
  ],
  "nextPageToken": string
}
Fields
schemas[]

object (NextSchema)

The list of Schemas.
nextPageToken

string

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.