reports: getPrinterArchivedPrintJobs

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.

Get a list of archived print jobs that were queued for particular printer.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Reports.Read.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

HTTP request

GET /print/reports/getPrinterArchivedPrintJobs(printerId='{printerId}',startDateTime='{startDateTime}',endDateTime='{endDateTime}')
GET /reports/getPrinterArchivedPrintJobs(printerId='{printerId}',startDateTime='{startDateTime}',endDateTime='{endDateTime}')

Request headers

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

Function parameters

In the request URL, provide the following function parameters with values:

Parameter Type Required? Description
printerId Edm.String Yes The ID of the printer to return data for.
startDateTime Edm.DateTimeOffset No The start date (inclusive) for the time period to include data from.
endDateTime Edm.DateTimeOffset No The end date (inclusive) for the time period to include data from.

Note: If a value is not required, pass the parameter with null value.

Response

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

Example

The following example shows how to call this API.

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/reports/getPrinterArchivedPrintJobs(printerId='016b5565-3bbf-4067-b9ff-4d68167eb1a6',startDateTime=2021-05-24,endDateTime=2021-05-25)
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

{
  "value": [
    {
      "id": "016b5565-3bbf-4067-b9ff-4d68167eb1a6",
      "printerId": "016b5565-3bbf-4067-b9ff-4d68167eb1a6",
      "printerName": "printerName1",
      "processingState": "completed",
      "createdDateTime": "2023-06-29T00:00:00.0000000Z",
      "acquiredDateTime": "2023-06-29T00:00:01.0000000Z",
      "completionDateTime": "2023-06-29T00:00:02.0000000Z",
      "acquiredByPrinter": true,
      "copiesPrinted": 1,
      "pageCount": 1,
      "blackAndWhitePageCount": 1,
      "colorPageCount": 0,
      "simplexPageCount": 0,
      "duplexPageCount": 1,
      "createdBy": {
        "displayName": "username",
        "userPrincipalName": "username@contoso.com",
      }
    }
  ]
}