Overview API Reference API Explorer Need help?

templateFile resource type

Represents a file associated with a template.

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.
lastModifiedDateTime	DateTimeOffset	Date and time the file was last modified. Read-only.
mimeType	String	The MIME type of the file.
size	Int64	Size of the file in bytes.

Relationships

Relationship	Type	Description
mergeFields	mergeField collection	The list of merge fields associated with the file that are used within its contents..

Note: The name specified in mergeField corresponds to the name of the property used in the template. To retrieve additional metadata for the property, look for a property that matches the name in the template resource to which this file belongs.

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)",
  "lastModifiedDateTime": "string (timestamp)",
  "mergeFields": [{"@odata.type": "wordfields.mergeField"}],
  "mimeType": "string",
  "size": 1024,

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

Methods

Resources