Получение данных метки доставки

Статья
02/22/2024

Общие сведения об API оборудования Майкрософт, включая предварительные требования для использования API, см. в статье "Управление отправкой оборудования с помощью API".

Используйте следующие методы в API оборудования Майкрософт, чтобы получить данные для доставки меток оборудования, зарегистрированных в вашей учетной записи Центр разработки оборудования.

https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/

Прежде чем использовать эти методы, продукт и отправка уже должны существовать в вашей учетной записи Центр разработки. Сведения о создании и управлении отправками для продуктов см. в разделе "Управление отправками продуктов".

Description	Method	URI
Получение данных для всех меток доставки отправки	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/`
Получение данных для определенной метки доставки отправки	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}`

Необходимые компоненты

Если это еще не сделано, выполните все предварительные требования для API оборудования Майкрософт, прежде чем пытаться использовать любой из этих методов.

Ресурсы данных

Методы API аппаратной панели мониторинга Майкрософт для получения данных меток доставки используют следующие ресурсы данных JSON.

Ресурс ShippingLabel

Этот ресурс представляет метку доставки, созданную для отправки продукта, зарегистрированного в вашей учетной записи.

{
  "id": 1152921504606978422,
  "productId": 14461751976964157,
  "submissionId": 1152921504621467613,
  "publishingSpecifications": {
    "goLiveDate": "2018-04-12T05:28:32.721Z",
    "visibleToAccounts": [
      27691110, 27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": true,
    "isDisclosureRestricted": false,
    "publishToWindows10s": false,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1", "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": true,
      "isForUnreleasedHardware": true,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    }
  },
  "recipientSpecifications": {
    "receiverPublisherId": "27691110",
    "enforceChidTargeting": true
  },
  "targeting": {
    "hardwareIds": [
      {
        "bundleId": "amd64",
        "infId": "foo.inf",
        "operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_FULL",
        "pnpString": "hid\\vid_dummy256f&pid_dummyc62f",
        "distributionState": "pendingAdd"
      }
    ],
    "chids": [
      {
        "chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
        "distributionState": "pendingAdd"
      }
    ],
    "restrictedToAudiences": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000001"
      ],
    "inServicePublishInfo": {
      "flooring": "RS1",
      "ceiling": "RS3"
    },
    "coEngDriverPublishInfo": {
      "flooringBuildNumber": 17135,
      "ceilingBuildNumber": 17139
    }  
  },
  "workflowStatus": {
    "currentStep": "finalizePublishing",
    "state": "completed",
    "messages": [],
    "errorReport": ""
  },
  "links": [
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978422",
      "rel": "self",
      "method": "GET"
    }
  ],
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

Этот ресурс имеет следующие значения:

Значение	Тип	Описание
id	длинный	Идентификатор метки доставки
productId	длинный	Идентификатор частного продукта, к которому связана эта метка доставки
submissionId	длинный	Идентификатор отправки, к которому связана эта метка доставки
публикацияSpecifications	объект	Дополнительные сведения см. в объекте спецификаций публикации
recipientSpecifications	массив объектов	Дополнительные сведения см. в объекте спецификаций получателей
на клиентов	объект	Дополнительные сведения см. в статье о целевом объекте
workflowStatus	объект	Этот объект показывает состояние рабочего процесса для этой метки доставки. Дополнительные сведения см. в объекте состояния рабочего процесса доставки
ссылки	массив объектов	Дополнительные сведения см . в разделе "Объект ссылки".
name	строка	Имя метки доставки
destination	строка	Указывает назначение метки доставки. Возможные значения: (описание в скобках): anotherPartner (эта метка доставки предназначена для обмена отправкой с другим партнером) windowsUpdate (эта метка доставки предназначена для публикации в Обновл. Windows) Notset

Объект "Спецификации публикации"

Этот объект представляет спецификации публикации объекта в Обновл. Windows. Этот объект будет доступен или необходим только в том случае, если назначение метки доставки — windowsUpdate

{
  "goLiveDate": "2018-04-12T05:28:32.721Z",
  "visibleToAccounts": [
    27691110,
    27691111
  ],
  "isAutoInstallDuringOSUpgrade": true,
  "isAutoInstallOnApplicableSystems": true,
  "isDisclosureRestricted": false,
  "publishToWindows10s": false,
  "additionalInfoForMsApproval": {
    "microsoftContact": "abc@microsoft.com",
    "validationsPerformed": "Validation 1",
    "affectedOems": [
      "OEM1",
      "OEM2"
    ],
    "isRebootRequired": false,
    "isCoEngineered": true,
    "isForUnreleasedHardware": true,
    "hasUiSoftware": false,
    "businessJustification": "This is a business justification"
  }
}