Document AI Warehouse API (contentwarehouse:v1)

▼ ▲ contentwarehouse.projects.locations.dataExportJobs.archiveDataExportJob

HTTP Method: DELETE

Scopes: https://www.googleapis.com/auth/cloud-platform

Parameter Order: name

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataExportJobs/{dataExportJobsId}

Parameters:

name

Description: Required. The resource name.

Location: path

Pattern: ^projects/[^/]+/locations/[^/]+/dataExportJobs/[^/]+$

Required: Yes

Type: string

Description: Archives a data export job.

Path: v1/{+name}

▼ ▲ contentwarehouse.projects.locations.dataExportJobs.create

Path: v1/{+parent}/dataExportJobs

HTTP Method: POST

Parameter Order: parent

Parameters:

parent

Type: string

Description: Required. The resource parent name.

Location: path

Pattern: ^projects/[^/]+/locations/[^/]+$

Required: Yes

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataExportJobs

Scopes: https://www.googleapis.com/auth/cloud-platform

Description: Creates a data export job.

▼ ▲ contentwarehouse.projects.locations.links.get

Description: Gets a link.

Parameter Order: name

Parameters:

name

Location: path

Description: Required. The name of the link to retrieve.

Pattern: ^projects/[^/]+/locations/[^/]+/links/[^/]+$

Type: string

Required: Yes

Path: v1/{+name}

HTTP Method: GET

Scopes: https://www.googleapis.com/auth/cloud-platform

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/links/{linksId}

▼ ▲ contentwarehouse.projects.locations.links.create

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/links

Parameter Order: parent

Scopes: https://www.googleapis.com/auth/cloud-platform

HTTP Method: POST

Parameters:

parent

Type: string

Pattern: ^projects/[^/]+/locations/[^/]+$

Description: Required. The parent name.

Required: Yes

Location: path

Description: Creates a link.

Path: v1/{+parent}/links

▼ ▲ contentwarehouse.projects.locations.links.patch

HTTP Method: PATCH

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/links/{linksId}

Parameters:

name

Location: path

Required: Yes

Description: The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.

Type: string

Pattern: ^projects/[^/]+/locations/[^/]+$

linksId

Type: string

Required: Yes

Location: path

Path: v1/{+name}/links/{linksId}

Parameter Order:

• name
• linksId

Description: Updates the link using provided UpdateLinkRequest.

Scopes: https://www.googleapis.com/auth/cloud-platform

▼ ▲ contentwarehouse.projects.locations.links.delete

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/links/{linksId}

Parameters:

name

Pattern: ^projects/[^/]+/locations/[^/]+/links/[^/]+$

Description: Required. The name of the link to delete.

Required: Yes

Type: string

Location: path

Path: v1/{+name}

Parameter Order: name

HTTP Method: DELETE

Scopes: https://www.googleapis.com/auth/cloud-platform

Description: Deletes a link between a collection and a document.

▼ ▲ contentwarehouse.projects.locations.collections.search

Path: v1/{+parent}/collections:search

Scopes: https://www.googleapis.com/auth/cloud-platform

Parameter Order: parent

HTTP Method: POST

Description: Searches for collections using provided SearchCollectionsRequest. This call only returns collections that the caller has permission to search against.

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections:search

Parameters:

parent

Pattern: ^projects/[^/]+/locations/[^/]+$

Required: Yes

Location: path

Description: Required. The parent, which owns the collections. Format: projects/{project_number}/locations/{location}.

Type: string

▼ ▲ contentwarehouse.projects.locations.collections.fetchCollectionAcl

Parameters:

name

Required: Yes

Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$

Location: path

Type: string

Description: Required. The name of the collection. projects/{project_number}/locations/{location}/collections/{document_id}.

HTTP Method: POST

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:fetchCollectionAcl

Parameter Order: name

Scopes: https://www.googleapis.com/auth/cloud-platform

Path: v1/{+name}:fetchCollectionAcl

Description: Gets the access control policy for the collection. Returns NOT_FOUND error if the collection does not exist. Returns an empty policy if the collection exists but does not have a policy set.

▼ ▲ contentwarehouse.projects.locations.collections.setCollectionAcl

HTTP Method: POST

Path: v1/{+name}:setCollectionAcl

Parameters:

name

Required: Yes

Description: Required. The name of the collection for which the policy is being set. projects/{project_number}/locations/{location}/collections/{document_id}.

Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$

Location: path

Type: string

Parameter Order: name

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:setCollectionAcl

Description: Sets the access control policy for the collection. Replaces any existing policy.

Scopes: https://www.googleapis.com/auth/cloud-platform

▼ ▲ contentwarehouse.projects.locations.collections.create

HTTP Method: POST

Path: v1/{+parent}/collections

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections

Parameter Order: parent

Description: Creates a collection.

Scopes: https://www.googleapis.com/auth/cloud-platform

Parameters:

parent

Required: Yes

Pattern: ^projects/[^/]+/locations/[^/]+$

Type: string

Location: path

Description: Required. The parent name.

▼ ▲ contentwarehouse.projects.locations.collections.get

Path: v1/{+name}

Scopes: https://www.googleapis.com/auth/cloud-platform

Parameters:

name

Description: Required. The name of the collection to retrieve.

Type: string

Required: Yes

Location: path

Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}

Description: Gets a collection.

Parameter Order: name

HTTP Method: GET

▼ ▲ contentwarehouse.projects.locations.collections.delete

HTTP Method: DELETE

Parameter Order: name

Description: Deletes a collection.

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}

Parameters:

name

Description: Required. The name of the collection to delete.

Required: Yes

Type: string

Location: path

Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$

Scopes: https://www.googleapis.com/auth/cloud-platform

Path: v1/{+name}