Skip to content

Latest commit

 

History

History
142 lines (113 loc) · 5.1 KB

printer-list-jobs.md

File metadata and controls

142 lines (113 loc) · 5.1 KB
Raw
title description author ms.localizationpriority ms.subservice doc_type
List printJobs for a printer
Retrieve a list of print jobs associated with the printer.
nilakhan
medium
universal-print
apiPageType

List printJobs for a printer

Namespace: microsoft.graph

Retrieve a list of print jobs associated with the printer.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

GET /print/printers/{printerId}/jobs

Optional query parameters

This method supports some of the OData query parameters to help customize the response. For general information, see OData query parameters.

  • The documents property is omitted from the response by default. To also return a list of printDocuments for each print job, use $expand=documents.
  • This method supports filtering print jobs by the user who created them. Use $filter=createdBy/userPrincipalName eq '{upn}', where {upn} is the user principal name of the associated user.

Exceptions

Some operators are not supported: $count, $search.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of printJob objects in the response body.

Examples

Request

HTTP

GET https://graph.microsoft.com/v1.0/print/printers/{printerId}/jobs

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

CLI

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#print/printers('2f3453b7-4686-4b5b-9575-4f1e5b909ba7')/jobs",
  "value": [
    {
      "id": "103",
      "createdDateTime": "2020-02-04T00:00:00.0000000Z",
      "createdBy": {
        "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
        "displayName": "John Smith",
        "userPrincipalName": "john.smith@contoso.com"
      },
      "status": {
        "state": "completed",
        "description": "The print job has completed successfully and no further processing will take place.",
        "details": [          
        ],
        "isAcquiredByPrinter": true
      },
      "configuration": {        
      },
      "redirectedTo": null,
      "redirectedFrom": null,
      "isFetchable": false     
    }
  ]
}