Show / Hide Table of Contents

PrintJob.ReadWrite.All

Allows the application to read and update the metadata and document content of print jobs on behalf of the signed-in user. 

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A,D GET /print/printers/{id}/jobs
V1 A,D GET /print/printers/{id}/jobs/{id}
V1 A,D GET /print/printers/{id}/jobs/{id}/documents/{id}/$value
V1 A,D GET /print/printers/{printerId}/jobs
V1 A,D GET /print/printers/{printerId}/jobs/{printJobId}/documents/{printDocumentId}/$value
V1 D GET /print/services
V1 D GET /print/services/{id}
V1 D GET /print/services/{id}/endpoints
V1 D GET /print/services/{id}/endpoints/{name}
V1 D GET /print/services/{printServiceId}
V1 D GET /print/services/{printServiceId}/endpoints
V1 D GET /print/services/{printServiceId}/endpoints/{printServiceEndpointId}
V1 A,D GET /print/shares/{id}/jobs
V1 A,D GET /print/shares/{printerShareId}/jobs
V1 A PATCH /print/printers/{id}/jobs/{id}
V1 A PATCH /print/printers/{printerId}/jobs/{printJobId}
V1 A POST /print/printers/{id}/jobs/{id}/abort
V1 D POST /print/printers/{id}/jobs/{id}/cancel
V1 A,D POST /print/printers/{id}/jobs/{id}/documents/{id}/createUploadSession
V1 D POST /print/printers/{printerId}/jobs
V1 A POST /print/printers/{printerId}/jobs/{printJobId}/abort
V1 D POST /print/printers/{printerId}/jobs/{printJobId}/cancel
V1 D POST /print/shares/{id}/jobs/{id}/start
V1 D POST /print/shares/{printerShareId}/jobs
V1 D POST /print/shares/{printerShareId}/jobs/{printJobId}/start
V1 D POST print/printers/{id}/jobs
V1 D POST print/shares/{id}/jobs

Delegate Permission

Id 036b9544-e8c5-46ef-900a-0646cc42b271
Consent Type Admin
Display String Read and write print jobs
Description Allows the application to read and update the metadata and document content of print jobs on behalf of the signed-in user. 

Application Permission

Id 5114b07b-2898-4de7-a541-53b0004e2e13
Display String Read and write print jobs
Description Allows the application to read and update the metadata and document content of print jobs without a signed-in user.

Resources

printDocument

Property Type Description
contentType String The document's content (MIME) type. Read-only.
displayName String The document's name. Read-only.
id String The document's identifier. Read-only.
size Int64 The document's size in bytes. Read-only.

printer

Property Type Description
capabilities printerCapabilities The capabilities of the printer associated with this printer share. Inherited from printerBase.
defaults printerDefaults The printer's default print settings. Inherited from printerBase.
displayName String The name of the printer. Inherited from printerBase.
hasPhysicalDevice Boolean True if the printer has a physical device for printing. Read-only.
id String The document's identifier. Inherited from printerBase. Read-only.
isAcceptingJobs Boolean Whether the printer is currently accepting new print jobs. Inherited from printerBase.
isShared Boolean True if the printer is shared; false otherwise. Read-only.
lastSeenDateTime DateTimeOffset The most recent dateTimeOffset when a printer interacted with Universal Print. Read-only.
location printerLocation The physical and/or organizational location of the printer. Inherited from printerBase.
manufacturer String The manufacturer reported by the printer. Inherited from printerBase.
model String The model name reported by the printer. Inherited from printerBase.
registeredDateTime DateTimeOffset The DateTimeOffset when the printer was registered. Read-only.
status printerStatus The processing status of the printer, including any errors. Inherited from printerBase.

printerCapabilities

Property Type Description
bottomMargins Int32 collection A list of supported bottom margins(in microns) for the printer.
collation Boolean True if the printer supports collating when printing muliple copies of a multi-page document; false otherwise.
colorModes printColorMode collection The color modes supported by the printer. Valid values are described in the following table.
contentTypes String collection A list of supported content (MIME) types that the printer supports. It is not guaranteed that the Universal Print service supports printing all of these MIME types.
copiesPerJob integerRange The range of copies per job supported by the printer.
dpis Int32 collection The list of print resolutions in DPI that are supported by the printer.
duplexModes printDuplexMode collection The list of duplex modes that are supported by the printer. Valid values are described in the following table.
feedOrientations printerFeedOrientation collection The list of feed orientations that are supported by the printer.
finishings printFinishing collection Finishing processes the printer supports for a printed document.
inputBins String collection Supported input bins for the printer.
isColorPrintingSupported Boolean True if color printing is supported by the printer; false otherwise. Read-only.
isPageRangeSupported Boolean True if the printer supports printing by page ranges; false otherwise.
leftMargins Int32 collection A list of supported left margins(in microns) for the printer.
mediaColors String collection The media (i.e., paper) colors supported by the printer.
mediaSizes String collection The media sizes supported by the printer. Supports standard size names for ISO and ANSI media sizes. Valid values are in the following table.
mediaTypes String collection The media types supported by the printer.
multipageLayouts printMultipageLayout collection The presentation directions supported by the printer. Supported values are described in the following table.
orientations printOrientation collection The print orientations supported by the printer. Valid values are described in the following table.
outputBins String collection The printer's supported output bins (trays).
pagesPerSheet Int32 collection Supported number of Input Pages to impose upon a single Impression.
qualities printQuality collection The print qualities supported by the printer.
queueBufferSizeInBytes Int32 The maximum print job queue size that can be stored by the printer.
rightMargins Int32 collection A list of supported right margins(in microns) for the printer.
scalings printScaling collection Supported print scalings.
supportsFitPdfToPage Boolean True if the printer supports scaling PDF pages to match the print media size; false otherwise.
topMargins Int32 collection A list of supported top margins(in microns) for the printer.

printerShare

Property Type Description
allowAllUsers Boolean If true, all users and groups will be granted access to this printer share. This supersedes the allow lists defined by the allowedUsers and allowedGroups navigation properties.
capabilities printerCapabilities The capabilities of the printer associated with this printer share. Inherited from printerBase.
createdDateTime DateTimeOffset The DateTimeOffset when the printer share was created. Read-only.
defaults printerDefaults The default print settings of the printer associated with this printer share. Inherited from printerBase.
displayName String The name of the printer share that print clients should display. Inherited from printerBase.
id String The printerShare's identifier. Inherited from printerBase. Read-only.
isAcceptingJobs Boolean Whether the printer associated with this printer share is currently accepting new print jobs. Inherited from printerBase.
location printerLocation The physical and/or organizational location of the printer associated with this printer share. Inherited from printerBase.
manufacturer String The manufacturer reported by the printer associated with this printer share. Inherited from printerBase. Read-only.
model String The model name reported by the printer associated with this printer share. Inherited from printerBase. Read-only.
status printerStatus The processing status, including any errors, of the printer associated with this printer share.Inherited from printerBase. Read-only.

printJob

Property Type Description
configuration printJobConfiguration A group of settings that a printer should use to print a job.
createdBy userIdentity Read-only. Nullable.
createdDateTime DateTimeOffset The DateTimeOffset when the job was created. Read-only.
id String The ID of the print job. Read-only.
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.
status printJobStatus The status of the print job. Read-only.

printJobStatus

Property Type Description
description String A human-readable description of the print job's current processing state. Read-only.
details printJobProcessingDetail collection Additional details for print job state. Valid values are described in the following table. Read-only.
isAcquiredByPrinter Boolean True if the job was acknowledged by a printer; false otherwise. Read-only.
state printJobProcessingState The print job's current processing state. Valid values are described in the following table. Read-only.

printService

Property Type Description
id String The service's identifier. Read-only.

printServiceEndpoint

Property Type Description
displayName String A human-readable display name for the endpoint.
id String A unique name that identifies the service that the endpoint provides. Possible values are: discovery (Discovery Service), notification (Notification Service), ipp (IPP Service), and registration (Registration Service). Read-only.
uri String The URI that can be used to access the service.

printTask

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/v1.0/print/printers/{printerId}/jobs/{jobId}. Read-only.

uploadSession

Property Type Description
expirationDateTime DateTimeOffset The date and time in UTC that the upload session will expire. The complete file must be uploaded before this expiration time is reached.
nextExpectedRanges String collection A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format "start-end" (e.g. "0-26" to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value "{start}", the location in the file where the next upload should begin.
uploadUrl String The URL endpoint that accepts PUT requests for byte ranges of the file.
In This Article
Back to top Created by merill | Submit feedback