place: getOperation

命名空间:microsoft.graph

重要

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

按 ID 获取 placeOperation

注意

使用此 API 时,以下方面适用:

  • 作在创建后将保留 15 天。
  • API 级限制:
    • 此 API 的限制为每秒三次调用。 有关详细信息,请参阅 Microsoft Graph 服务特定的限制
    • 长时间运行的作进度每 30 秒更新一次;因此,检索作的频率不应超过每 30 秒一次。

权限

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

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

HTTP 请求

GET /places/getOperation(id='{id}')

函数参数

在请求 URL 中,提供以下查询参数(含值)。

参数 类型 说明
id String 放置作的 ID。 必需。

请求标头

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

请求正文

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

响应

如果成功,此函数在 200 OK 响应正文中返回响应代码和 placeOperation 对象。

作详细信息结构

响应中的作详细信息镜像请求有效负载的层次结构:

  • 请求中的每个顶级位置都显示为 详细信息 数组中的顶级条目,顺序与请求相同。
  • 在请求中使用 children@delta 指定的层次结构保留在响应的 数组中,顺序与请求相同。
  • 成功创建或更新的位置将在 succeededPlace 属性中返回。
  • 在处理过程中遇到的任何错误都会在 error 属性中返回。

示例

示例 1:获取成功的作

以下示例演示 upsert places API 的示例部分中显示的 upsert places 请求的作响应。 响应结构镜像请求层次结构,请求的每个顶级位置都出现在 详细信息 数组中,子位置嵌套在 数组中。

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/beta/places/getOperation(id='0f5d3cc5-d1bd-4cba-9b0e-e9ad68527ab5')

响应

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.placeOperation",
  "id": "0f5d3cc5-d1bd-4cba-9b0e-e9ad68527ab5",
  "status": "succeeded",
  "progress": {
    "totalPlaceCount": 9,
    "succeededPlaceCount": 9,
    "failedPlaceCount": 0
  },
  "details": [
    {
      "children": [
        {
          "succeededPlace": {
            "@odata.type": "#microsoft.graph.floor",
            "id": "5f54d496-7328-415a-930e-990be3a98766",
            "displayName": "Demo Floor 1",
            "parentId": "25e5905a-7fee-4f36-ba31-29e85c14bf18"
          }
        }
      ],
      "succeededPlace": {
        "@odata.type": "#microsoft.graph.building",
        "id": "25e5905a-7fee-4f36-ba31-29e85c14bf18",
        "displayName": "Demo Building A",
        "hasWiFi": true,
        "wifiState": "enabled"
      }
    },
    {
      "children": [
        {
          "children": [
            {
              "children": [
                {
                  "succeededPlace": {
                    "@odata.type": "#microsoft.graph.desk",
                    "id": "211ffb37-e880-475a-b73a-43f484609536",
                    "displayName": "desk1",
                    "parentId": "f5b54c22-5474-47aa-878a-0bfdc72e30f1",
                    "mode": {
                      "@odata.type": "#microsoft.graph.unavailablePlaceMode",
                      "reason": "New"
                    }
                  }
                },
                {
                  "succeededPlace": {
                    "@odata.type": "#microsoft.graph.room",
                    "id": "ddb3bfc7-c7af-40fb-a8be-26af40ee6cf3",
                    "placeId": "9112a87a-7994-4f73-9037-0939ef1c7d55",
                    "displayName": "Demo Room 1",
                    "parentId": "f5b54c22-5474-47aa-878a-0bfdc72e30f1",
                    "emailAddress": "DemoRoom19975d7971764579926925@contoso.onmicrosoft.com"
                  }
                }
              ],
              "succeededPlace": {
                "@odata.type": "#microsoft.graph.section",
                "id": "f5b54c22-5474-47aa-878a-0bfdc72e30f1",
                "displayName": "Demo Section A",
                "parentId": "23bfdc52-59d6-419d-ab18-54a51fe060f6"
              }
            }
          ],
          "succeededPlace": {
            "@odata.type": "#microsoft.graph.floor",
            "id": "23bfdc52-59d6-419d-ab18-54a51fe060f6",
            "displayName": "Demo Floor 1",
            "parentId": "15369a66-e9f4-4803-8e7e-fa6b811fbd92"
          }
        }
      ],
      "succeededPlace": {
        "@odata.type": "#microsoft.graph.building",
        "id": "15369a66-e9f4-4803-8e7e-fa6b811fbd92",
        "displayName": "Demo Building B"
      }
    },
    {
      "succeededPlace": {
        "@odata.type": "#microsoft.graph.workspace",
        "id": "8628af02-04c3-4882-88cc-06108de2d637",
        "placeId": "ebbc6ed0-8fda-41d2-9d07-c0f990337515",
        "displayName": "Demo Workspace 1",
        "parentId": "2cb2701d-0896-4c69-91bb-582d82d7c68c",
        "emailAddress": "DemoWorkspace1bb13cf171764579932835@contoso.onmicrosoft.com",
        "mode": {
          "@odata.type": "#microsoft.graph.reservablePlaceMode"
        }
      }
    },
    {
      "succeededPlace": {
        "@odata.type": "#microsoft.graph.section",
        "id": "2cb2701d-0896-4c69-91bb-582d82d7c68c",
        "displayName": "s1",
        "parentId": "94eb964a-b166-4f0a-953d-54dc9032d9d5",
        "tags": [
          "Working Section",
          "CVP"
        ]
      }
    }
  ]
}

示例 2:获取包含错误的部分成功的作

以下示例演示了部分成功的作。

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/beta/places/getOperation(id='116d12e4-3361-43f9-b722-af5b510760c9')

响应

以下示例显示了 partiallySucceededed 的响应。 作部分成功,创建一个位置,两个位置失败。

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.placeOperation",
  "id": "15cc23bd-f215-42bf-92ad-bb84fbcd6606",
  "status": "partiallySucceeded",
  "progress": {
    "totalPlaceCount": 3,
    "succeededPlaceCount": 1,
    "failedPlaceCount": 2
  },
  "details": [
    {
      "error": null,
      "children": [
        {
          "error": {
            "code": "BadRequest",
            "message": "Requested Place not found: 881a74c1-a092-4f67-b354-174ca814df8b"
          }
        }
      ],
      "succeededPlace": {
        "@odata.type": "#microsoft.graph.building",
        "id": "25e5905a-7fee-4f36-ba31-29e85c14bf18",
        "displayName": "Demo Building 3"
      }
    },
    {
      "error": {
        "code": "BadRequest",
        "message": "A Place with the same name, type, parentId and address already exists with ID 9ba9753e-181a-471f-aa84-9ed238afae58."
      }
    }
  ]
}