2023-03-16
▼ ▲ contentwarehouse.projects.locations.documents.lock
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/documents/[^/]+$
Location: path
Description: Required. The name of the document to lock. Format: projects/{project_number}/locations/{location}/documents/{document}.
Parameter Order: name
Description: Lock the document so the document cannot be updated by other users.
Path: v1/{+name}:lock
▼ ▲ contentwarehouse.projects.locations.collections.get
HTTP Method: GET
Description: Gets a collection.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Type: string
Description: Required. The name of the collection to retrieve.
Required: Yes
▼ ▲ contentwarehouse.projects.locations.collections.setCollectionAcl
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Required: Yes
Type: string
Description: Required. The name of the collection for which the policy is being set. projects/{project_number}/locations/{location}/collections/{document_id}.
HTTP Method: POST
Path: v1/{+name}:setCollectionAcl
Description: Sets the access control policy for the collection. Replaces any existing policy.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:setCollectionAcl
▼ ▲ contentwarehouse.projects.locations.collections.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.
Path: v1/{+name}: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
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:fetchCollectionAcl
Parameter Order: name
▼ ▲ contentwarehouse.projects.locations.collections.search
HTTP Method: POST
Description: Searches for collections using provided SearchCollectionsRequest. This call only returns collections that the caller has permission to search against.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v1/{+parent}/collections:search
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections:search
Parameters:
parent
Type: string
Description: Required. The parent, which owns the collections. Format: projects/{project_number}/locations/{location}.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
▼ ▲ contentwarehouse.projects.locations.collections.create
Parameters:
parent
Description: Required. The parent name.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Path: v1/{+parent}/collections
Description: Creates a collection.
Parameter Order: parent
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections
▼ ▲ contentwarehouse.projects.locations.collections.delete
Parameters:
name
Description: Required. The name of the collection to delete.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Type: string
Required: Yes
Parameter Order: name
Description: Deletes a collection.
Path: v1/{+name}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}
▼ ▲ contentwarehouse.projects.locations.links.delete
Description: Deletes a link between a collection and a document.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/links/[^/]+$
Description: Required. The name of the link to delete.
Location: path
Required: Yes
Type: string
Path: v1/{+name}
Parameter Order: name
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/links/{linksId}
▼ ▲ contentwarehouse.projects.locations.links.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/links/{linksId}
Description: Gets a link.
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/links/[^/]+$
Type: string
Description: Required. The name of the link to retrieve.
Required: Yes
Location: path
HTTP Method: GET
▼ ▲ contentwarehouse.projects.locations.links.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
parent
Type: string
Description: Required. The parent name.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Path: v1/{+parent}/links
Description: Creates a link.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/links
HTTP Method: POST
▼ ▲ contentwarehouse.projects.locations.links.patch
Description: Updates the link using provided UpdateLinkRequest.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}/links/{linksId}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/links/{linksId}
Parameter Order:
HTTP Method: PATCH
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
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
linksId
Type: string
Required: Yes
Location: path