获取 printJob

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

检索打印作业的属性和关系。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

注意: 对于具有取消其他用户作业的委派权限的应用,已登录用户必须是打印机管理员角色的成员。

对于具有应用程序权限以检索用户作业的应用,该应用需要一个授予 “获取打印机 访问权限”的权限,以及 “权限” 表中所述的应用程序权限之一。

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) PrintJob.ReadBasic PrintJob.Read、PrintJob.Read.All、PrintJob.ReadBasic.All、PrintJob.ReadWrite、PrintJob.ReadWrite.All、PrintJob.ReadWriteBasic、PrintJob.ReadWriteBasic.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 PrintJob.ReadBasic.All PrintJob.Read.All、PrintJob.ReadWrite.All、PrintJob.ReadWriteBasic.All

HTTP 请求

若要从打印机获取作业,请执行以下操作:

GET /print/printers/{id}/jobs/{id}

若要从打印机共享获取作业,请执行以下操作:

GET /print/shares/{id}/jobs/{id}

可选的查询参数

此方法支持一些 OData 查询参数来帮助自定义响应。 若要了解一般信息,请参阅 OData 查询参数

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在 200 OK 响应正文中返回响应代码和 printJob 对象。

示例

示例 1:获取打印作业

请求

以下示例显示了获取打印作业的元数据的请求。

GET https://graph.microsoft.com/beta/print/printers/c05f3726-0d4b-4aa1-8fe9-2eb981bb26fb/jobs/5182

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#print/printers('c05f3726-0d4b-4aa1-8fe9-2eb981bb26fb')/jobs/$entity",
  "id": "5182",
  "displayName": "testjob",
  "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": []
  },
  "redirectedTo": null,
  "redirectedFrom": null,
  "isFetchable": false
}

示例 2:使用任务列表获取打印作业

请求

以下示例显示了获取打印作业的请求,以及正在运行或已针对该作业运行的任何 任务

GET https://graph.microsoft.com/beta/print/printers/c05f3726-0d4b-4aa1-8fe9-2eb981bb26fb/jobs/5182?$expand=tasks

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#print/printers('c05f3726-0d4b-4aa1-8fe9-2eb981bb26fb')/jobs(tasks())/$entity",
  "id": "5182",
  "displayName": "testjob",
  "createdDateTime": "2020-06-30T17:18:52.3930472Z",
  "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": []
  },
  "redirectedTo": null,
  "redirectedFrom": null,
  "isFetchable": false,
  "configuration": {},
  "tasks": [
    {
      "id": "d036638b-1272-4bba-9227-732463823ed3",
      "parentUrl": "https://graph.microsoft.com/beta/print/printers/c05f3726-0d4b-4aa1-8fe9-2eb981bb26fb/jobs/5182",
      "status": {
        "state": "processing",
        "description": "The task is being processed."
      }
    }
  ]
}

示例 3:获取打印作业及其关联的文档数据

请求

以下示例显示了获取打印作业及其关联的文档数据的请求。

GET https://graph.microsoft.com/beta/print/printers/86b6d420-7e6b-4797-a05c-af4e56cd81bd/jobs/31216?$expand=documents

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#print/printers('86b6d420-7e6b-4797-a05c-af4e56cd81bd')/jobs(documents())/$entity",
  "id": "31216",
  "displayName": "testjob",
  "createdDateTime": "2020-06-26T04:20:06.5715544Z",
  "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": []
  },
  "redirectedTo": null,
  "redirectedFrom": null,
  "isFetchable": false,
  "configuration": {},
  "documents": [
    {
      "id": "ca96c367-c3ad-478a-bbce-fbd1cd856e73",
      "displayName": "",
      "contentType": "application/oxps",
      "size": 276604
    }
  ]
}