reportRoot: getPrinterArchivedPrintJobs

Namespace: microsoft.graph

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 /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. Learn more about authentication and authorization.

Request body

Don't 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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Reports.GetPrinterArchivedPrintJobsWithPrinterIdWithStartDateTimeWithEndDateTime(DateTimeOffset.Parse("{endDateTime}"),"{printerId}",DateTimeOffset.Parse("{startDateTime}")).GetAsGetPrinterArchivedPrintJobsWithPrinterIdWithStartDateTimeWithEndDateTimeGetResponseAsync();

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

CLI

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

// Code snippets are only available for the latest major version. Current major version is $v1.*

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
printerId := "{printerId}"
startDateTime , err := time.Parse(time.RFC3339, "{startDateTime}")
endDateTime , err := time.Parse(time.RFC3339, "{endDateTime}")
getPrinterArchivedPrintJobs, err := graphClient.Reports().GetPrinterArchivedPrintJobsWithPrinterIdWithStartDateTimeWithEndDateTime(&printerId, &startDateTime, &endDateTime).GetAsGetPrinterArchivedPrintJobsWithPrinterIdWithStartDateTimeWithEndDateTimeGetResponse(context.Background(), nil)

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

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.reports().getPrinterArchivedPrintJobsWithPrinterIdWithStartDateTimeWithEndDateTime(OffsetDateTime.parse("{endDateTime}"), "{printerId}", OffsetDateTime.parse("{startDateTime}")).get();

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

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$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.

PowerShell

Import-Module Microsoft.Graph.Reports

Get-MgReportPrinterArchivedPrintJob

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

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.reports.get_printer_archived_print_jobs_with_printer_id_with_start_date_time_with_end_date_time("{endDateTime}","{printerId}","{startDateTime}").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",
      }
    }
  ]
}