Edit

printTaskDefinition resource type

  • Article

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 an abstract definition for a task that can be triggered when various events occur within Universal Print.

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

This resource supports:

Methods

Method Return Type Description
List printTaskDefinition collection Get a complete list of printTaskDefinitions created within Universal Print.
Create printTaskDefinition Create a new printTaskDefinition.
Update printTaskDefinition Update a printTaskDefinition.
Delete None Delete a printTaskDefinition.
List tasks printTask Get a list of tasks that have been created based on this definition. The list includes currently running tasks and recently completed tasks.
Get task printTask Gets a task that has been created based on this definition.
Update task printTask Update a task that has been created based on this definition. Applications that register task triggers are responsible for updating task 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.

Properties

Property Type Description
id String The printTaskDefinition's identifier. Read-only.
displayName String The name of the printTaskDefinition.
createdBy appIdentity The application that created the printTaskDefinition. Read-only.

Relationships

Relationship Type Description
tasks printTask collection A list of tasks that have been created based on this definition. The list includes currently running tasks and recently completed tasks. Read-only.

JSON representation

The following is a JSON representation of the resource.

{
  "id": "String (identifier)",
  "displayName": "String",
  "createdBy": {"@odata.type": "microsoft.graph.appIdentity"},
  "tasks": [{"@odata.type": "microsoft.graph.printTask"}]
}