Skip to main content

FileReferenceDto

The file reference parameters.

NameTypeDescriptionNotes
referenceDataFileReferenceDataDtoHow this document is named when another spreadsheet refers to it. Send it back as it stands to resolve the reference again.[optional]
errorStringFilled in when the reference resolved to nothing; the rest of the descriptor is then empty and must not be handed to the editors.[optional] [example: File not found] [nullable]
pathStringThe title of the document the reference resolved to.[optional] [example: Budget 2026.xlsx] [nullable]
urlURI (uri)Where the content is fetched from. It is addressed to the host the document service can reach, which on a deployment with a private editor network is not the address a browser should follow.[optional] [example: https://portal.example.com/filehandler.ashx?action=download&fileid=512] [nullable]
fileTypeStringThe format the content is in, without the leading dot.[optional] [example: xlsx] [nullable]
keyStringIdentifies the exact revision to the editors: two clients that receive the same key read the same co-editing session, and the key changes as soon as the document is saved.[optional] [example: 1_512_3] [nullable]
linkStringThe address of the document in the portal web editor - the link to put in front of a person, unlike the download address above.[optional] [example: https://portal.example.com/doceditor?fileid=512] [nullable]
tokenStringSigns this descriptor so that the editors can trust it. It stays empty on a portal that has no signature secret configured for the document service.[optional] [example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...] [nullable]