Method: projects.locations.documentSchemas.list

Lists document schemas.

HTTP request

GET https://contentwarehouse.googleapis.com/v1/{parent}/documentSchemas

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of document schemas. Format: projects/{projectNumber}/locations/{location}. It takes the form projects/{project}/locations/{location}.

Query parameters

Parameters
pageSize

integer

The maximum number of document schemas to return. The service may return fewer than this value. If unspecified, at most 50 document schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

A page token, received from a previous documentSchemas.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to documentSchemas.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

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

Response message for DocumentSchemaService.ListDocumentSchemas.

JSON representation
{
  "documentSchemas": [
    {
      object (DocumentSchema)
    }
  ],
  "nextPageToken": string
}
Fields
documentSchemas[]

object (DocumentSchema)

The document schemas from the specified parent.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

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:

  • contentwarehouse.documentSchemas.list

For more information, see the IAM documentation.