Udostępnij przez

Tworzenie nowej etykiety wysyłkowej

Użyj tej metody w API sprzętowego Microsoftu, aby utworzyć nową etykietę wysyłkową. Przed użyciem tego upewnij się, że utworzono produkt i utworzono przesłanie dla tego produktu. Aby uzyskać szczegółowe informacje, zobacz utworzenie produktu oraz utworzenie przesyłania.

Wymagania wstępne

Jeśli jeszcze tego nie zrobiono, przed podjęciem próby użycia dowolnej z tych metod wykonaj wszystkie wymagania wstępne dla interfejsów API sprzętu firmy Microsoft.

Żądanie

Ta metoda ma następującą składnię. Zapoznaj się z poniższymi sekcjami, aby zapoznać się z przykładami użycia i opisami nagłówka i treści żądania.

Metoda Żądanie URI
Bez znajomości kontekstu, w którym "POST" jest używany, nie mogę zaproponować dokładnego tłumaczenia. Jeżeli dotyczy HTTP, pozostaw jako "POST". https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels

Identyfikator produktu i identyfikator przesyłania w metodzie reprezentują przesłanie, dla którego ma zostać utworzona etykieta wysyłkowa.

Nagłówek żądania

Nagłówek Typ Opis
Autoryzacja Sznurek To jest wymagane. Token dostępu microsoft Entra ID w postaci elementu nośnego<tokenu>.
Akceptować Sznurek Opcjonalny. Określa typ zawartości. Dozwolona wartość to "application/json"

Parametry żądania

Nie należy podawać parametrów żądania dla tej metody.

Ciało żądania

W poniższym przykładzie pokazano treść żądania JSON do utworzenia nowej etykiety wysyłkowej.

{
  "publishingSpecifications": {
    "goLiveDate": "2018-02-22T06:50:54.793Z",
    "visibleToAccounts": [
      27691110,
      27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": false,
    "manualAcquisition": false,
    "isDisclosureRestricted": false,
    "publishToWindows10s": true,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1",
        "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": false,
      "isForUnreleasedHardware": false,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    }
  },
  "targeting": {
    "hardwareIds": [
      {
        "bundleId": "3aba7558-10ca-42db-b1d1-57af5718aea3",
        "infId": "foo.inf",
        "operatingSystemCode": "WINDOWS_v100_RS3_FULL",
        "pnpString": "hid\\vid_dummy256f&pid_dummyc62f"
      }
    ],
    "chids": [
      {
        "chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
        "distributionState": "pendingAdd"
      }
    ],
    "restrictedToAudiences": [
      "00000000-0000-0000-0000-000000000001",
      "00000000-0000-0000-0000-000000000002"
      ],
    "inServicePublishInfo": {
      "flooring": "RS1",
      "ceiling": "RS3"
    }
  },
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

Aby uzyskać szczegółowe informacje o polach w żądaniu, zobacz element ShippingLabel.

Punkty do zapamiętania podczas tworzenia etykiet wysyłkowych

  • Podczas publikowania w usłudze Windows Update (docelowym jest windowsUpdate), należy dołączyć obiekt publishingSpecifications. W przypadku instalacji automatycznych (jeżeliisAutoInstallDuringOSUpgrade lub isAutoInstallOnApplicableSystems jest prawda), należy ustawić additionalInfoForMsApproval.
  • jeśli w etykiecie nadawczej isAutoInstallDuringOSUpgrade lub isAutoInstallOnApplicableSystems ma wartość true, wtedy manualAcquisition musi mieć wartość false, a sterownik zostanie opublikowany z ustawieniem "May request user input" ustawionym na wartość false.
  • jeśli w etykiecie wysyłkowej isAutoInstallDuringOSUpgrade i isAutoInstallOnApplicableSystems są fałszywe, manualAcquisition musi mieć wartość true, a sterownik zostanie opublikowany z ustawieniem "May request user input" (Może zażądać danych wejściowych użytkownika) ustawionym na wartość true.
  • W przypadku udostępniania innym partnerom (docelowy jest innypartner), należy dołączyć obiekt recipientSpecifications.

Wypełnianie informacji targetingowych

Obiekt docelowy zawiera dane, które instruują usługę Windows Update dla:

  • Sposób, w jaki sterownik powinien być ukierunkowany na identyfikatory sprzętu.

  • Czy należy zastosować CHID lub ograniczenia.

Obiekt identyfikatora sprzętu powinien zawierać prawidłową kombinację identyfikatora pakietu, identyfikatora PNP, kodu systemu operacyjnego i nazwy INF podczas tworzenia nowej etykiety wysyłkowej. Pobierz plik metadanych sterownika (podany jako link po otrzymaniu szczegółów przesłania), aby uzyskać dozwolone, prawidłowe kombinacje tych atrybutów do przesłania. Aby uzyskać więcej informacji, zobacz metadane pakietu sterowników .

Prośba o przykłady

W poniższym przykładzie pokazano, jak utworzyć nowy produkt.

POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels HTTP/1.1
Authorization: Bearer <your access token>

Odpowiedź

W poniższym przykładzie pokazano treść odpowiedzi JSON zwróconą przez pomyślnie złożone żądanie w celu utworzenia etykiety wysyłkowej. Szczegółowe informacje o wartościach w treści odpowiedzi są wyświetlane w tabeli poniżej przykładu.

{
  "id": 1152921504606997500,
  "productId": 14461751976964156,
  "submissionId": 1152921504621467600,
  "publishingSpecifications": {
    "goLiveDate": "2018-02-22T06:50:54.793+00:00",
    "visibleToAccounts": [
      27691110,
      27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": false,
    "isDisclosureRestricted": false,
    "publishToWindows10s": true,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1",
        "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": false,
      "isForUnreleasedHardware": false,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    },
    "manualAcquisition": false
  },
  "workflowStatus": {
    "currentStep": "preProcessShippingLabel",
    "state": "notStarted",
    "messages": []
  },
  "links": [
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606997603",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606997603",
      "rel": "update_shippinglabel",
      "method": "PATCH"
    }
  ],
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

Ciało odpowiedzi

Aby uzyskać szczegółowe informacje na temat treści odpowiedzi, zobacz zasób etykiety wysyłkowej .

Kody błędów

Aby uzyskać informacje o kodach błędów, zobacz Kody błędów.

Zobacz też

przykłady interfejsu API pulpitu nawigacyjnego sprzętu (GitHub)

  • Last updated on