printTask resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a task that is executing or has been executed as a result of a Universal Print event.

For details about how to use this resource to add pull printing support to Universal Print, see Extending Universal Print to support pull printing.

Methods

Method	Return Type	Description
List tasks	printTask	Get a list of tasks that have been created based on a particular printTaskDefinition. The list includes currently running tasks and recently completed tasks.
Get task	printTask	Get details about a print task.
Update task	printTask	Updates a print task.

Properties

Property	Type	Description
id	String	The printTask's identifier. Read-only.
status	printTaskStatus	The current execution status of this printTask. The calling application is responsible for updating this status when processing is finished, unless the related printJob has been redirected to another printer. Failure to report completion will result in the related print job being blocked from printing and eventually deleted.
parentUrl	String	The URL for the print entity that triggered this task. For example, https://graph.microsoft.com/beta/print/printers/{printerId}/jobs/{jobId}. Read-only.

Relationships

Relationship	Type	Description
trigger	printTaskTrigger	The printTaskTrigger that triggered this task's execution. Read-only.
definition	printTaskDefinition	The printTaskDefinition that was used to create this task. Read-only.

JSON representation

The following JSON representation shows the resource type.

{
  "id": "String (identifier)",
  "status": {"@odata.type": "microsoft.graph.printTaskStatus"},
  "parentUrl": "String",
  "trigger": {"@odata.type": "microsoft.graph.printTaskTrigger"},
  "definition": {"@odata.type": "microsoft.graph.printTaskDefinition"}
}