Verzendlabelgegevens ophalen

Zie Hardware-inzendingen beheren met behulp van API's van Microsoft voor een inleiding tot Microsoft Hardware-API's, inclusief vereisten voor het gebruik van de API.

Gebruik de volgende methoden in Microsoft Hardware-API's om gegevens op te halen voor het verzenden van labels van hardwareproducten die zijn geregistreerd bij uw Hardware Dev Center-account.

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

Voordat u deze methoden kunt gebruiken, moeten het product en de inzending al bestaan in uw Dev Center-account. Als u verzendingen voor producten wilt maken of beheren, raadpleegt u de methoden in Productinzendingen beheren.

Prerequisites

Als u dit nog niet hebt gedaan, voltooit u alle Prerequisites voor de Microsoft Hardware-API's voordat u een van deze methoden probeert te gebruiken.

Gegevensbronnen

De Microsoft API-methoden voor hardwaredashboards voor het ophalen van verzendlabelgegevens gebruiken de volgende JSON-gegevensbronnen.

Verzendlabelresource

Deze resource vertegenwoordigt een verzendlabel dat is gemaakt voor het verzenden van uw product dat is geregistreerd bij uw account.

{
  "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,
    "blockDuaCreation": false
  },
  "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"
}

Deze resource heeft de volgende waarden:

object voor publicatiespecificaties

Dit object vertegenwoordigt de specificaties van hoe een object wordt gepubliceerd naar Windows Update. Dit object is alleen beschikbaar/nodig wanneer de bestemming van het verzendlabel windowsUpdate is

{
  "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"
  }
}

Dit object heeft de volgende waarden

Aanvullende informatie voor het Microsoft-object

Dit object vertegenwoordigt enkele aanvullende informatie die is vereist voor Microsoft om het verzendlabel te controleren. Dit object is alleen beschikbaar/nodig als de bestemming van het verzendlabel windowsUpdate is en het verzendlabel is gemarkeerd als isAutoInstallDuringOSUpgrade of isAutoInstallOnApplicableSystems.

{
    "microsoftContact": "abc@microsoft.com",
    "validationsPerformed": "Validation 1",
    "affectedOems": [
      "OEM1",
      "OEM2"
    ],
    "isRebootRequired": false,
    "isCoEngineered": true,
    "isForUnreleasedHardware": true,
    "hasUiSoftware": false,
    "businessJustification": "This is a business justification"
}

Dit object heeft de volgende waarden

Object voor geadresseerdespecificaties

Dit object vertegenwoordigt de details en voorwaarden waaronder de inzending wordt gedeeld met een andere partner. Dit object is alleen beschikbaar/nodig wanneer de bestemming van het verzendlabel een andere Partner is.

{
	"receiverPublisherId": "27691110",
	"enforceChidTargeting": false,
    "blockDuaCreation": false
}

Dit object heeft de volgende waarden

Object als doel

Dit object vertegenwoordigt de doelgegevens van het verzendlabel dat is vereist wanneer het wordt gepubliceerd naar Windows Update.

{
  "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
  }
}

Dit object heeft de volgende waarden

Hardware-id-object

Dit object vertegenwoordigt de details van de hardware-id waarop het verzendlabel moet worden gericht. Raadpleeg hardware-id's voor meer informatie.

{
	"bundleId": "amd64",
	"infId": "foo.inf",
	"operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_FULL",
	"pnpString": "hid\\vid_dummy256f&pid_dummyc62f",
	"distributionState": "pendingAdd"
}

Dit object heeft de volgende waarden

Het hardware-id-object moet een geldige combinatie van bundel-id, PNP-id, OS-code en INF-naam bevatten tijdens het maken van een nieuw verzendlabel. Als u de toegestane/geldige combinaties van deze kenmerken voor uw inzending (pakket) wilt ophalen, kunt u het metagegevensbestand van het stuurprogramma downloaden dat als koppeling wordt opgegeven wanneer u details van een inzending krijgt. Raadpleeg de metagegevens van stuurprogrammapakketten voor meer informatie.

CHIDs-object

Dit object vertegenwoordigt de CHID (computerhardware-id) waarop het verzendlabel moet worden gericht. Raadpleeg het gebruik van CHID's voor meer informatie.

{
	"chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
	"distributionState": "pendingAdd"
}

Dit object heeft de volgende waarden

In object Service-publicatiegegevens

Dit object vertegenwoordigt distributiebereiken die worden gedefinieerd door een vloer en plafond. Een verdieping beschrijft de vroegste Windows versie waar het stuurprogramma naar wordt verdeeld en een plafond markeert de nieuwste versie. Door een vloer en plafond toe te voegen, kunt u de distributie van uw chauffeur beperken.

{
  "flooring": "RS1",
  "ceiling": "RS3",

}

Dit object heeft de volgende waarden

Zie Limiting driver distribution by Windows versions voor meer informatie over deze waarden.

Co-Engineering-object Publicatiegegevens van het stuurprogramma

Dit object vertegenwoordigt distributiebereiken die worden gedefinieerd door een vloer en plafond bij het ontwikkelen van stuurprogramma's voor nieuwere en niet-uitgebrachte versies van Windows. Dit object is alleen beschikbaar voor Microsoft co-engineeringpartners. Een verdieping beschrijft de vroegste Windows versie waar het stuurprogramma naar wordt verdeeld en een plafond markeert de nieuwste versie. Door een vloer en plafond toe te voegen, kunt u de distributie van uw chauffeur beperken.

{
  "flooringBuildNumber": 17135,
  "ceilingBuildNumber": 17139
}

Dit object heeft de volgende waarden

Zie Het beperken van de distributie van stuurprogramma's op basis van Windows-versies voor meer informatie.

Statusobject voor de werkstroom van verzendlabels

Dit object vertegenwoordigt de status van de werkstroom voor een bepaalde entiteit.

{
      "currentStep": "Created",
      "state": "completed",
      "messages": []
    }

Dit object heeft de volgende waarden

Foutcodes

Zie Foutcodes voor informatie over de foutcodes.

Zie ook

• API-voorbeelden voor hardware-dashboards (GitHub)