contentwarehouse API (contentwarehouse:v1)

2022-09-30

32 new methods | New API

Additions

    Methods
  • contentwarehouse.projects.locations.initialize

      HTTP Method: POST

      Description: Provisions resources for given tenant project. Returns a long running operation.

      Parameter Order: location

      Path: v1/{+location}:initialize

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

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

      Parameters:

        location

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

          Required: Yes

          Type: string

          Description: Required. The location to be initialized Format: projects/{project_number}/locations/{location}.

          Location: path

  • contentwarehouse.projects.locations.synonymSets.get

      Description: Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist

      HTTP Method: GET

      Path: v1/{+name}

      Parameter Order: name

      Parameters:

        name

          Required: Yes

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

          Type: string

          Description: Required. The name of the synonymSet to retrieve Format: projects/{project_number}/locations/{location}/synonymSets/{context}.

          Location: path

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}

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

  • contentwarehouse.projects.locations.synonymSets.create

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

      Description: Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context.

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

      Parameters:

        parent

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

          Location: path

          Description: Required. The parent name. Format: projects/{project_number}/locations/{location}.

          Required: Yes

          Type: string

      HTTP Method: POST

      Parameter Order: parent

      Path: v1/{+parent}/synonymSets

  • contentwarehouse.projects.locations.synonymSets.delete

      Description: Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found.

      Parameters:

        name

          Type: string

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

          Location: path

          Required: Yes

          Description: Required. The name of the synonymSet to delete Format: projects/{project_number}/locations/{location}/synonymSets/{context}.

      HTTP Method: DELETE

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}

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

      Path: v1/{+name}

  • contentwarehouse.projects.locations.synonymSets.list

      Parameter Order: parent

      Path: v1/{+parent}/synonymSets

      Description: Returns all SynonymSets (for all contexts) for the specified location.

      Parameters:

        parent

          Type: string

          Required: Yes

          Description: Required. The parent name. Format: projects/{project_number}/locations/{location}.

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

          Location: path

        pageSize

          Description: The maximum number of synonymSets to return. The service may return fewer than this value. If unspecified, at most 50 rule sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Format: int32

          Location: query

          Type: integer

        pageToken

          Location: query

          Description: A page token, received from a previous `ListSynonymSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSynonymSets` must match the call that provided the page token.

          Type: string

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

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

      HTTP Method: GET

  • contentwarehouse.projects.locations.synonymSets.patch

      Description: Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found.

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

      Parameter Order: name

      Parameters:

        name

          Required: Yes

          Description: Required. The name of the synonymSet to update Format: projects/{project_number}/locations/{location}/synonymSets/{context}.

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

          Type: string

          Location: path

      HTTP Method: PATCH

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}

      Path: v1/{+name}

  • contentwarehouse.projects.locations.documentSchemas.get

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}

      Parameters:

        name

          Required: Yes

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

          Location: path

          Description: Required. The name of the document schema to retrieve.

          Type: string

      HTTP Method: GET

      Description: Gets a document schema. Returns NOT_FOUND if the document schema does not exist.

      Parameter Order: name

      Path: v1/{+name}

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

  • contentwarehouse.projects.locations.documentSchemas.patch

      Path: v1/{+name}

      Description: Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties and updating existing properties will result into INVALID_ARGUMENT.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}

      HTTP Method: PATCH

      Parameter Order: name

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

      Parameters:

        name

          Type: string

          Location: path

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

          Description: Required. The name of the document schema to update. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

          Required: Yes

  • contentwarehouse.projects.locations.documentSchemas.delete

      Path: v1/{+name}

      HTTP Method: DELETE

      Description: Deletes a document schema. Returns NOT_FOUND if the document schema does not exist.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}

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

      Parameters:

        name

          Type: string

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

          Description: Required. The name of the document schema to delete.

          Required: Yes

          Location: path

      Parameter Order: name

  • contentwarehouse.projects.locations.documentSchemas.create

      Parameters:

        parent

          Description: Required. The parent name.

          Type: string

          Required: Yes

          Location: path

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

      HTTP Method: POST

      Parameter Order: parent

      Path: v1/{+parent}/documentSchemas

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

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

      Description: Creates a document schema.

  • contentwarehouse.projects.locations.documentSchemas.list

      Description: Lists document schemas.

      HTTP Method: GET

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

      Path: v1/{+parent}/documentSchemas

      Parameter Order: parent

      Parameters:

        pageSize

          Type: integer

          Description: The maximum number of document schemas to return. The service may return fewer than this value. If unspecified, at most 50 document schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Location: query

          Format: int32

        parent

          Description: Required. The parent, which owns this collection of document schemas. Format: projects/{project_number}/locations/{location}.

          Location: path

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

          Type: string

          Required: Yes

        pageToken

          Type: string

          Description: A page token, received from a previous `ListDocumentSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDocumentSchemas` must match the call that provided the page token.

          Location: query

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

  • contentwarehouse.projects.locations.documents.referenceId.get

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get

      Description: Gets a document. Returns NOT_FOUND if the document does not exist.

      Parameters:

        name

          Required: Yes

          Type: string

          Description: Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

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

          Location: path

      Parameter Order: name

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

      Path: v1/{+name}:get

  • contentwarehouse.projects.locations.documents.referenceId.patch

      Description: Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

      Parameter Order: name

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

      Path: v1/{+name}

      HTTP Method: PATCH

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}

      Parameters:

        name

          Description: Required. The name of the document to update. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

          Required: Yes

          Location: path

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

          Type: string

  • contentwarehouse.projects.locations.documents.referenceId.delete

      Parameter Order: name

      Description: Deletes a document. Returns NOT_FOUND if the document does not exist.

      Path: v1/{+name}:delete

      Parameters:

        name

          Location: path

          Required: Yes

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

          Description: Required. The name of the document to delete. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

          Type: string

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

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete

  • contentwarehouse.projects.locations.documents.documentLinks.delete

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

      HTTP Method: POST

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks/{documentLinksId}:delete

      Parameters:

        name

          Required: Yes

          Type: string

          Location: path

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

          Description: Required. The name of the document-link to be deleted. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.

      Path: v1/{+name}:delete

      Description: Remove the link between the source and target documents.

  • contentwarehouse.projects.locations.documents.documentLinks.create

      Parameters:

        parent

          Type: string

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

          Location: path

          Description: Required. Parent of the document-link to be created. parent of document-link should be a document. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}.

          Required: Yes

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks

      Path: v1/{+parent}/documentLinks

      Parameter Order: parent

      HTTP Method: POST

      Description: Create a link between a source document and a target document.

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

  • contentwarehouse.projects.locations.documents.linkedTargets

      HTTP Method: POST

      Path: v1/{+parent}/linkedTargets

      Parameters:

        parent

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

          Type: string

          Required: Yes

          Description: Required. The name of the document, for which all target links are returned. Format: projects/{project_number}/locations/{location}/documents/{target_document_id}.

          Location: path

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

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedTargets

      Description: Return all target document-links from the document.

      Parameter Order: parent

  • contentwarehouse.projects.locations.documents.create

      HTTP Method: POST

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

      Parameters:

        parent

          Required: Yes

          Type: string

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

          Location: path

          Description: Required. The parent name. Format: projects/{project_number}/locations/{location}.

      Parameter Order: parent

      Path: v1/{+parent}/documents

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

      Description: Creates a document.

  • contentwarehouse.projects.locations.documents.patch

      Parameters:

        name

          Required: Yes

          Description: Required. The name of the document to update. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

          Type: string

          Location: path

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

      Description: Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

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

      Parameter Order: name

      HTTP Method: PATCH

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}

  • contentwarehouse.projects.locations.documents.linkedSources

      HTTP Method: POST

      Description: Return all source document-links from the document.

      Path: v1/{+parent}/linkedSources

      Parameter Order: parent

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

      Parameters:

        parent

          Description: Required. The name of the document, for which all source links are returned. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}.

          Type: string

          Required: Yes

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

          Location: path

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources

  • contentwarehouse.projects.locations.documents.get

      Description: Gets a document. Returns NOT_FOUND if the document does not exist.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:get

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

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

          Location: path

          Required: Yes

          Type: string

      Path: v1/{+name}:get

      Parameter Order: name

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

  • contentwarehouse.projects.locations.documents.search

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

      Parameter Order: parent

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

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

      HTTP Method: POST

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

      Parameters:

        parent

          Required: Yes

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

          Description: Required. The parent, which owns this collection of documents. Format: projects/{project_number}/locations/{location}.

          Location: path

          Type: string

  • contentwarehouse.projects.locations.documents.delete

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

      Parameters:

        name

          Location: path

          Required: Yes

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

          Type: string

          Description: Required. The name of the document to delete. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

      HTTP Method: POST

      Path: v1/{+name}:delete

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete

      Description: Deletes a document. Returns NOT_FOUND if the document does not exist.

      Parameter Order: name

  • contentwarehouse.projects.locations.documents.fetchAcl

      Parameters:

        resource

          Location: path

          Type: string

          Required: Yes

          Description: Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for project: projects/{project_number}.

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

      Path: v1/{+resource}:fetchAcl

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

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

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl

      HTTP Method: POST

      Parameter Order: resource

  • contentwarehouse.projects.locations.documents.setAcl

      Path: v1/{+resource}:setAcl

      Parameters:

        resource

          Description: Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for project: projects/{project_number}.

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

          Type: string

          Required: Yes

          Location: path

      Parameter Order: resource

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

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:setAcl

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

  • contentwarehouse.projects.locations.ruleSets.create

      Description: Creates a ruleset.

      Parameters:

        parent

          Description: Required. The parent name. Format: projects/{project_number}/locations/{location}.

          Required: Yes

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

          Location: path

          Type: string

      Path: v1/{+parent}/ruleSets

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

      HTTP Method: POST

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

      Parameter Order: parent

  • contentwarehouse.projects.locations.ruleSets.delete

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

      Description: Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}

      Path: v1/{+name}

      Parameters:

        name

          Required: Yes

          Description: Required. The name of the rule set to delete. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.

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

          Type: string

          Location: path

      Parameter Order: name

      HTTP Method: DELETE

  • contentwarehouse.projects.locations.ruleSets.patch

      Parameters:

        name

          Location: path

          Required: Yes

          Description: Required. The name of the rule set to update. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.

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

          Type: string

      Path: v1/{+name}

      Description: Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}

      Parameter Order: name

      HTTP Method: PATCH

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

  • contentwarehouse.projects.locations.ruleSets.list

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

      Description: Lists rulesets.

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: A page token, received from a previous `ListRuleSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRuleSets` must match the call that provided the page token.

        parent

          Required: Yes

          Description: Required. The parent, which owns this collection of document. Format: projects/{project_number}/locations/{location}.

          Location: path

          Type: string

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

        pageSize

          Description: The maximum number of rule sets to return. The service may return fewer than this value. If unspecified, at most 50 rule sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Format: int32

          Type: integer

          Location: query

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

      Parameter Order: parent

      HTTP Method: GET

      Path: v1/{+parent}/ruleSets

  • contentwarehouse.projects.locations.ruleSets.get

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}

      Parameters:

        name

          Description: Required. The name of the rule set to retrieve. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.

          Required: Yes

          Type: string

          Location: path

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

      HTTP Method: GET

      Path: v1/{+name}

      Description: Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

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

  • contentwarehouse.projects.fetchAcl

      Flat Path: v1/projects/{projectsId}:fetchAcl

      Parameter Order: resource

      HTTP Method: POST

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

      Parameters:

        resource

          Required: Yes

          Description: Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for project: projects/{project_number}.

          Pattern: ^projects/[^/]+$

          Location: path

          Type: string

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

      Path: v1/{+resource}:fetchAcl

  • contentwarehouse.projects.setAcl

      HTTP Method: POST

      Path: v1/{+resource}:setAcl

      Flat Path: v1/projects/{projectsId}:setAcl

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

      Parameters:

        resource

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+$

          Location: path

          Description: Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for project: projects/{project_number}.

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

      Parameter Order: resource