Method: projects.locations.documents.referenceId.get

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

HTTP request

POST https://contentwarehouse.googleapis.com/v1/{name}:get

Path parameters

Parameters
name

string

Required. The name of the document to retrieve. Format: projects/{projectNumber}/locations/{location}/documents/{documentId} or projects/{projectNumber}/locations/{location}/documents/referenceId/{referenceId}. It takes the form projects/{project}/locations/{location}/documents/referenceId/{referenceid}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestMetadata": {
    object (RequestMetadata)
  }
}
Fields
requestMetadata

object (RequestMetadata)

The meta information collected about the end user, used to enforce access control for the service.

Response body

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

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:

  • contentwarehouse.documents.get

For more information, see the IAM documentation.