Skip to content

printjob.md

Latest commit

 

History

History
88 lines (73 loc) · 3.21 KB

printjob.md

File metadata and controls

88 lines (73 loc) · 3.21 KB
title printJob resource type
description Represents a print job that has been queued for a printer.
author braedenp-msft
ms.localizationpriority medium
ms.subservice universal-print
doc_type resourcePageType
ms.date 07/22/2024

printJob resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents a print job that has been queued for a printer.

Methods

Method Return Type Description
Get printJob Read properties and relationships of printJob object.
Create print job printJob Create a new print job object.
Update printJob Update a print job object.
Start None Start the print job.
Cancel None Cancel the print job.
Abort None Abort the print job.
Redirect printJob A print job that is queued for the destination printer.

Properties

Property Type Description
id String The ID of the print job. Read-only.
displayName String The name of the print job.
createdDateTime DateTimeOffset The DateTimeOffset when the job was created. Read-only.
status printJobStatus The status of the print job. Read-only.
configuration printJobConfiguration A group of settings that a printer should use to print a job.
isFetchable Edm.Boolean If true, document can be fetched by printer.
redirectedFrom Edm.String Contains the source job URL, if the job has been redirected from another printer.
redirectedTo Edm.String Contains the destination job URL, if the job has been redirected to another printer.

Relationships

Relationship Type Description
createdBy userIdentity Read-only. Nullable.
documents printDocument collection Read-only.
tasks printTask collection A list of printTasks that were triggered by this print job.

JSON representation

The following JSON representation shows the resource type.

{
  "id": "String (identifier)",
  "displayName": "String",
  "createdDateTime": "String (timestamp)",
  "isFetchable": "Boolean",
  "redirectedFrom": "String",
  "redirectedTo": "String",
  "status": {"@odata.type": "microsoft.graph.printJobStatus"},
  "createdBy": {"@odata.type": "microsoft.graph.userIdentity"},
  "configuration": {"@odata.type": "microsoft.graph.printJobConfiguration"},
  "documents": [ {"@odata.type": "microsoft.graph.printDocument"} ]
}