Aktualisieren eines Versandetiketts

Verwenden Sie diese Methode in der Microsoft Hardware-API, um ein Versandetikett zu aktualisieren. Bevor Sie diese Methode verwenden, stellen Sie sicher, dass Sie bereits ein Versandetikett erstellt haben. Weitere Informationen zum Erstellen eines Versandetiketts finden Sie unter Erstellen eines neuen Versandetiketts.

Voraussetzungen

Falls noch nicht geschehen, füllen Sie alle prerequisites für die Microsoft Hardware-APIs aus, bevor Sie eine dieser Methoden verwenden.

Anforderung

Diese Methode weist die folgende Syntax auf. Die anderen Abschnitte in diesem Thema enthalten Verwendungsbeispiele und Beschreibungen des Kopf- und Anforderungstexts.

Methode Anforderungs-URI
PATCH https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels/{shippingLabelId}

Die "productID", "submissionID " und " shippingLabelID " in der Methode stellen das produkt-, übermittlungs- und versandetikett dar, das aktualisiert werden soll.

Anforderungs-Header

Header Typ Beschreibung
Autorisierung String Required. Das Microsoft Entra ID-Zugriffstoken in der Form Bearer<token>.
Akzeptieren String Dies ist optional. Gibt den Inhaltstyp an. Zulässiger Wert ist "application/json"

Anforderungsparameter

Stellen Sie keine Anforderungsparameter für diese Methode bereit.

Anforderungstext

Im folgenden Beispiel wird der JSON-Anforderungstext für ein Versandetikett veranschaulicht. Nur die folgenden Arten von Änderungen können an einem Versandetikett vorgenommen werden:

  • Hinzufügen von Hardware-IDs
  • Hardware-IDs entfernen/ungültig machen
  • CHIDs hinzufügen
  • CHIDs ENTFERNEN
  • Benutzergruppe hinzufügen
  • Benutzergruppe aktualisieren/entfernen
  • Bereitstellen der geschäftlichen Begründung für die Änderungen
{
  "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"
  }
}

Zum Teilen von Versandetiketten können Empfängerspezifikationen hinzugefügt werden. 

{
  {
    "recipientSpecifications": {
    "blockDuaCreation": true
   },
    "targeting": {
    "hardwareIds": [ ... ]
   }
  }
}

Ausführliche Informationen zu den Feldern in der Anforderung finden Sie in der ShippingLabel-Ressource.

Beachten Sie Folgendes:

  • Sie müssen beim Aktualisieren von CHIDs oder HardwareIDs einen Wert für die Aktion angeben.

  • Zielgruppe ist ein feld, das nur aktualisiert wird. Wenn Sie einen Wert in diesem Feld angeben, werden alle vorherigen Werte überschrieben. Wenn der Wert leer bleibt, wird der vorherige Wert entfernt.

  • Informationen zum Abrufen einer Liste von Zielgruppen für Ihre Organisation finden Sie unter "Zielgruppe abrufen".

  • Das Hardware-ID-Objekt sollte beim Aktualisieren einer Versandbezeichnung eine gültige Kombination aus Bundle-ID, PNP-ID, Betriebssystemcode und INF-Namen enthalten. Um die gültigen, zulässigen Kombinationen dieser Attribute für Ihre Übermittlung (Paket) abzurufen, laden Sie die Treibermetadatendatei (bereitgestellt als Link) herunter, wenn Sie die Details einer Übermittlung erhalten. Ausführliche Informationen finden Sie unter Treiberpaketmetadaten.

  • recipientSpecifications können jetzt im Textkörper der PATCH-Anforderung enthalten sein.

  • Nur enforceChidTargeting und blockDuaCreation können über PATCH aktualisiert werden. receiverPublisherId ist unveränderlich und kann nicht geändert werden, nachdem das Versandetikett erstellt wurde. Wenn Sie versuchen, sie zu ändern, wird ein Überprüfungsfehler zurückgegeben.

Beispiele anfordern

Im folgenden Beispiel wird das Aktualisieren eines Versandetiketts veranschaulicht.

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

Antwort

Die Antwort ist leer mit dem HTTP-Status 204.

Verwenden Sie nach diesem Schritt die Methode unter "Versandetikett abrufen ", um die aktualisierten Details des Versandetiketts abzurufen.

Überprüfungsfehler

Beim Versuch, receiverPublisherId über PATCH zu ändern:

{
    "error": {
        "code": "invalidInput",
        "message": "Validation Failed.",
        "validationErrors": [
            {
                "target": "recipientSpecifications.receiverPublisherId",
                "message": "ReceiverPublisherId cannot be changed after creation."
            }
        ]
    }
}

Fehlercodes

Weitere Informationen zu Fehlercodes finden Sie unter Fehlercodes.

Siehe auch

  • Zuletzt aktualisiert um