document resource type
This resource represents the generated document.
Methods
| Method |
Response Type |
Description |
| Create |
document |
Returns a genereated document. |
Properties
| Property |
Type |
Description |
| createdDateTime |
DateTimeOffset |
Date and time of template creation. Read-only. |
| data |
object |
key-value pairs representing the values for the properties defined in the template. The keys in the data object must match the property names specified in the template. Read-write. |
| id |
String |
The document ID is a unique identifier that represents the document. It is a key field and cannot be null. Read-only. |
| name |
String |
The name of the document. Read-only. |
| templateReference |
templateReference |
The reference to template, which was used for creating this document. Read-only. |
Relationships
| Relationship |
Type |
Description |
| files |
documentFile collection |
The list of files associated with the document. |
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.
| Property |
Type |
Description |
| @api.templateFileId |
String |
The identifier of the template file to use for generating document if template has multiple files. Write-only. |
The JSON representation below shows the resource type.
{
"createdDateTime": "string (timestamp)",
"data": { "propertyName": "propertyValue" }
"files": [{"@odata.type": "wordfields.documentFile"}],
"id": "string (identifier)",
"name": "string",
"templateReference": {"@odata.type": "wordfields.templateReference"},
}
WordFields