次の方法で共有

配送先住所ラベルの更新

  • [アーティクル]

Microsoft ハードウェア API の以下のメソッドを使用して、配送先住所ラベル情報を更新します。 このメソッドを使用する前に、配送先住所ラベルが既に作成されていることを確認してください。 配送先住所ラベルの作成について詳しくは、「新しい配送先住所ラベルを作成する」をご覧ください。

前提条件

Microsoft ハードウェア API に関するすべての前提条件がまだ満たされていない場合は、ここに記載されているメソッドを使用する前に前提条件を整えてください。

要求

このメソッドの構文は次のとおりです。 ヘッダーと要求本文の使用例と説明については、このトピックの他のセクションをご覧ください。

メソッド 要求 URI
PATCH https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels/{shippingLabelId}

メソッドのproductID, submissionID およびshippingLabelIDは、更新する製品、申請、および配送先住所ラベルを表します。

要求ヘッダー

Header 型 説明
承認 String 必須。 Bearer<token>形式のMicrosoft Entra IDアクセストークン。
同意する String 省略可能。 コンテンツの種類を指定します。 使用できる値は"application/json"です。

要求パラメーター

このメソッドには要求パラメーターを指定しないでください。

要求本文

配送先住所ラベルのJSON要求本文の例を次に示します。 配送先住所ラベルでは、次の種類の変更のみ加えることができます。

  • ハードウェア ID の追加
  • ハードウェア ID の削除/失効
  • CHID の追加
  • CHID の削除
  • 対象ユーザーの追加
  • 対象ユーザーの更新/削除
  • 変更についてビジネス上の妥当性を示す
{
  "targeting": {
    "chids": [
      {
        "action": "add",
        "chid": "812fac65-9c26-473c-b3a9-1eb3803ac22c"
      },
      {
        "action": "remove",
        "chid": "aed6336d-0958-444c-89b6-bf471191d6f0"
      }
    ],
    "hardwareIds": [
      {
        "action": "remove",
        "bundleId": "a2dfbcd8-1d4a-4885-90a3-2ac8360542da",
        "infId": "foo.inf",
        "operatingSystemCode": "WINDOWS_v100_X64_RS3_FULL",
        "pnpString": "pci\\ven_8086&dev_5a85"
      },
      {
        "action": "add",
        "bundleId": "48140805-45a3-4a76-8818-e75c117adba9",
        "infId": "foo.inf",
        "operatingSystemCode": "WINDOWS_v100_X64_RS3_FULL",
        "pnpString": "pci\\ven_8086&dev_5a85"
      }
    ],
    "restrictedToAudiences": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000001"
    ],
    "inServicePublishInfo": {
      "flooring": "RS1",
      "ceiling": "RS3"
    },
    "businessJustification": "Business justification for updating shipping label"
  }
}

要求内のフィールドについて詳しくは、「ShippingLabel resource (ShippingLabel リソース)」をご覧ください。

注意する点:

  • CHID や HardwareIDs を更新する場合は、action の値を指定する必要があります。

  • 対象ユーザーは更新専用のフィールドです。 このフィールドに値を指定すると、以前の値が上書きされます。 値を空白のままにすると、以前の値が削除されます。

  • 組織の対象ユーザーの一覧を取得する方法については、「対象ユーザー データの取得」をご覧ください。

  • ハードウェアIDオブジェクトには、出荷ラベルを更新するときに、バンドルID、PNP ID、OSコード、およびINF名の有効な組み合わせが含まれている必要があります。 申請 (パッケージ) に対するこれらの属性の有効な/許可された組み合わせを取得するには、申請の詳細を取得するときに (リンクとして提供される) ドライバーのメタデータ ファイルをダウンロードします。 詳しくは、ドライバー パッケージのメタデータに関する記事をご覧ください。

要求の例

次の例では、出荷ラベルを更新する方法を示します。

PATCH https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964156/submissions/1152921504621467600/shippingLabels/1152921504606980300 HTTP/1.1
Authorization: Bearer <your access token>

回答

応答は HTTP の状態が 204 で空になります。

この手順の後、「配送先住所ラベルの取得」のメソッドを使用して、配送先住所ラベルの更新に関する詳細を取得してください。

エラー コード

エラー コードについて詳しくは、「Error codes (エラー コード)」をご覧ください。

関連項目