BcfDocumentReferenceResource Class Reference

Description

Represents one document-reference-scoped BCF API resource.

await topic.documentReference(documentReferenceId).update({ description: "Updated" });

Public Member Functions
	update (documentReferenceData)

Function Documentation

update()

update

(

documentReferenceData

)

Parameters

{object}

documentReferenceData - Fields to update (url only if external, description).

Returns

{Promise<ApiResponse>} The response containing the updated reference.

// Input:
{
  "url": "http://example.com/files/LegalRequirements_Update.pdf",
  "description": "The legal requirements for buildings."
}
 
// Output:
{
  "guid": "135ab37a-6122-448e-86fc-86503183b520",
  "url": "http://example.com/files/LegalRequirements_Update.pdf",
  "description": "The legal requirements for buildings."
}