Overview API Reference API Explorer Need help?

documentFile resource type

Represents a file associated with a document.

Properties

Property	Type	Description
createdDateTime	DateTimeOffset	Date and time the file was created. Read-only.
filename	String	The filename of the file (includes extension). Read-write.
id	String	The file ID is a unique identifier that represents the file. It is a key field and cannot be null. Read-only.
isTemporary	Boolean	Indicates that the file contents are accessible for only 1 hour before the file expires and is removed. Read-only.
mimeType	String	The MIME type of the file.
size	Int64	Size of the file in bytes.
templateFileReference	templateFileReference	File used as a template for this file. Read-only.

Instance annotations

Instance annotations are properties with special behaviors. These temporary properties either define the behavior the service should perform or provide short-term values, such as a download URL for an item that expires.

Property	Type	Description
@api.downloadURL	String	A URL that can be used to download this file's content. Authentication isn't required with this URL. Read-only.

JSON format

The JSON representation below illustrates the resource type.

{
  "createdDateTime": "string (timestamp)",
  "filename": "string",
  "id": "string (identifier)",
  "isTemporary": false,
  "mimeType": "string",
  "size": 1024,
  "templateFileReference": {"@odata.type": "wordfields.templateFileReference"},

  /* instance properties */
  "@api.downloadURL": "string (URL)"
}

Methods

Resources