reportRoot: getPrinterArchivedPrintJobs

Namespace: microsoft.graph

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

This API is supported in the following national cloud deployments.

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

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

In addition to the following permissions, the user's tenant must have an active Universal Print subscription.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Reports.Read.All
Delegated (personal Microsoft account)	Not Supported.
Application	Not Supported.

HTTP request

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

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.

Request headers

Name	Description
Authorization	Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

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

Examples

Request

HTTP

GET https://graph.microsoft.com/v1.0/reports/getPrinterArchivedPrintJobs(printerId='{id}',startDateTime=<timestamp>,endDateTime=<timestamp>)

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Reports.GetPrinterArchivedPrintJobsWithPrinterIdWithStartDateTimeWithEndDateTime(DateTimeOffset.Parse("{endDateTime}"),"{printerId}",DateTimeOffset.Parse("{startDateTime}")).GetAsync();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc reports get-printer-archived-print-jobs-with-printer-id-with-start-date-time-with-end-date-time get --printer-id {printer-id} --start-date-time {start-date-time-id} --end-date-time {end-date-time-id} 

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



printerId := "{printerId}"
startDateTime , err := time.Parse(time.RFC3339, "{startDateTime}")
endDateTime , err := time.Parse(time.RFC3339, "{endDateTime}")
getPrinterArchivedPrintJobs, err := graphClient.Reports().GetPrinterArchivedPrintJobsWithPrinterIdWithStartDateTimeWithEndDateTime(&printerId, &startDateTime, &endDateTime).Get(context.Background(), nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW VERSION OF THE SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->reports()->getPrinterArchivedPrintJobsWithPrinterIdWithStartDateTimeWithEndDateTime(new \DateTime('{endDateTime}'),'{printerId}', new \DateTime('{startDateTime}'))->get()->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(request_adapter)


result = await graph_client.reports.get_printer_archived_print_jobs(printer_id='{printer_id}',start_date_time={start_date_time},end_date_time={end_date_time}.get()

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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",
      }
    }
  ]
}