Method: projects.locations.documents.documentLinks.create

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

HTTP request


Path parameters



Required. Parent of the document-link to be created. parent of document-link should be a document. Format: projects/{projectNumber}/locations/{location}/documents/{source_document_id}. It takes the form projects/{project}/locations/{location}/documents/{document}.

Request body

The request body contains data with the following structure:

JSON representation
  "documentLink": {
    object (DocumentLink)
  "requestMetadata": {
    object (RequestMetadata)

object (RequestMetadata)

The meta information collected about the document creator, used to enforce access control for the service.

Response body

If successful, the response body contains a newly created instance of DocumentLink.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • contentwarehouse.documents.update

For more information, see the IAM documentation.