2025-10-28
▼ ▲ documentai.projects.locations.schemas.create
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}`
Required : Yes
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas
HTTP Method : POST
Path : v1/{+parent}/schemas
Description : Creates a schema.
▼ ▲ documentai.projects.locations.schemas.list
Parameters :
pageToken
Location : query
Type : string
Description : Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema.
pageSize
Location : query
Format : int32
Description : 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`.
Type : integer
parent
Description : Required. Format: `projects/{project}/locations/{location}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Schemas.
Path : v1/{+parent}/schemas
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas
HTTP Method : GET
▼ ▲ documentai.projects.locations.schemas.get
Path : v1/{+name}
Description : Gets a schema.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}
HTTP Method : GET
Parameter Order : name
Parameters :
name
Type : string
Location : path
Required : Yes
Description : Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemas/[^/]+$
▼ ▲ documentai.projects.locations.schemas.delete
Parameters :
force
Type : boolean
Description : 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.)
Location : query
name
Description : Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}`
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/schemas/[^/]+$
Description : Deletes a schema.
Parameter Order : name
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ documentai.projects.locations.schemas.patch
Parameter Order : name
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a schema. Editable fields are: - `display_name` - `labels`
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}
HTTP Method : PATCH
Parameters :
updateMask
Type : string
Location : query
Description : Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.
Format : google-fieldmask
name
Description : Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/schemas/[^/]+$
Type : string
Location : path
▼ ▲ documentai.projects.locations.schemas.schemaVersions.delete
HTTP Method : DELETE
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$
Location : path
Required : Yes
Type : string
Description : Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
Path : v1/{+name}
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}
Description : Deletes a schema version.
▼ ▲ documentai.projects.locations.schemas.schemaVersions.create
Description : Creates a schema version.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+parent}/schemaVersions
Parameter Order : parent
Parameters :
parent
Description : Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/schemas/[^/]+$
Required : Yes
▼ ▲ documentai.projects.locations.schemas.schemaVersions.patch
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$
Description : Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
Location : path
Required : Yes
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}
HTTP Method : PATCH
Description : Updates a schema version. Editable fields are: - `display_name` - `labels`
▼ ▲ documentai.projects.locations.schemas.schemaVersions.list
Description : Lists SchemaVersions.
Path : v1/{+parent}/schemaVersions
Parameters :
pageToken
Type : string
Location : query
Description : Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.
parent
Description : Required. Format: `projects/{project}/locations/{location}/schemas/{schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemas/[^/]+$
Required : Yes
Type : string
Location : path
pageSize
Format : int32
Location : query
Description : Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.
Type : integer
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions
▼ ▲ documentai.projects.locations.schemas.schemaVersions.get
Description : Gets a schema version.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}
HTTP Method : GET
Path : v1/{+name}
Parameters :
name
Location : path
Description : Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$
Type : string
▼ ▲ documentai.projects.locations.schemas.schemaVersions.generate
Path : v1/{+parent}/schemaVersions:generate
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions:generate
Parameter Order : parent
Description : Generates a schema version.
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/schemas/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`
HTTP Method : POST