Method: schemas.patch

Full name: projects.locations.schemas.patch

Updates a schema. Editable fields are:

  • displayName
  • labels

HTTP request

PATCH https://{endpoint}/v1/{schema.name}

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

Path parameters

Parameters
schema.name

string

Identifier. The resource name of the Schema. Format: projects/{project}/locations/{location}/schemas/{schema} It takes the form projects/{project}/locations/{location}/schemas/{schema}.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The update mask to apply to the resource. Note: Only the following fields can be updated:

  • displayName
  • labels

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of NextSchema.

Response body

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

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.schemas.update

For more information, see the IAM documentation.