Method: schemas.delete

Full name: projects.locations.schemas.delete

Deletes a schema.

HTTP request

DELETE https://{endpoint}/v1beta3/{name}

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

Path parameters

Parameters
name

string

Required. The name of the Schema to be deleted. Format: projects/{project}/locations/{location}/schemas/{schema} It takes the form projects/{project}/locations/{location}/schemas/{schema}.

Authorization requires the following IAM permission on the specified resource name:

  • documentai.schemas.delete

Query parameters

Parameters
force

boolean

Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.)

Request body

The request body must be empty.

Response body

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

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.delete

For more information, see the IAM documentation.