Method: dataset.getDatasetSchema

Full name: projects.locations.processors.dataset.getDatasetSchema

Gets the DatasetSchema of a Dataset.

HTTP request

Choose a location:

global us eu asia-south1 asia-southeast1 northamerica-northeast1 australia-southeast1 europe-west2 europe-west3

GET https://documentai.googleapis.com/v1beta3/{name}

Path parameters

Parameters
name	string Required. The dataset schema resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema It takes the form projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema.

Query parameters

Parameters
visibleFieldsOnly	boolean If set, only returns the visible fields of the schema.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of DatasetSchema.

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 name resource:

• documentai.datasetSchemas.get

For more information, see the IAM documentation.