Dashboard submission objects

重要

仪表板提交 REST API 已被弃用,并且不再可用。 APIs for driver submissions are under consideration for a future release.

These objects contain information about the dashboard submissions.

The following list shows the dashboard submission objects:

Asset

The collateral associated with the dashboard submission, such as Hardware Certification Kit (HCK) packages and signed catalogs.

These assets are stored in Azure Storage and can be accessed using the Shared Access Signature (SAS) URI and the Azure Storage API. For more information about downloading assets, see Create a production device submission.

Properties

The following table shows the asset properties.

Property name Type Description

DeviceSigningAssetID

GUID

The unique identifier for the asset. Use this property to request an SAS URL to download the asset.

Name

String

A user-friendly description of the asset.

AssetType

AssetType

An enumeration identifying a specific asset.

Methods

Get and Put methods are supported on all properties.

Example object

Asset : {
 "DeviceSigningAssetID" : "4e53d41f-4ccc-481c-bd00-0f73400f5d6a",
 "Name" : "contoso_toaster.hckx",
 "AssetType" : "InitialUpload"
}

AssetType

An enumeration describing an asset associated with a dashboard submission.

Possible values:

  • InitialUpload – a submission that has been uploaded.

  • SignedFile – a signed file.

MarketingName

Name describing your product. These names appear on the Windows Certified Products List in the SysDev Dashboard.

Properties

The following table shows the MarketingName properties.

Property name Type Description

Name

String

A custom string describing your product.

Locale

String

A set of strings defining the locale for your product.

Methods

Get and Put methods are supported on all properties.

Example object

MarketingName : {
"Name" : "Localized Contoso Toaster",
"Locales" : ["en-US"]
}

OSSelection

Describes the supported operating systems for your product. It also contains the classification of your submission as listed in the Hardware Certification Taxonomy. You can also use this object to get down-level signatures.

Properties

The following table shows the OSSelection properties.

Property name Type Description Required? Default

OS

String

The operating system for this product.

Yes

Unclassified

ProductType

String

The product type as listed in the Hardware Certification Taxonomy. You can also find this value in the Hardware Certification Object Model.

No

SignatureOnly

QualificationLevel

String

A string defining the requested qualification for the specified operating system. Possible values:

  • SignatureOnly

  • Accepted

  • Certified

Ni

SignatureOnly

Methods

Get and Put methods are supported on all properties.

Example object

{
"OS" : "Windows 8",
"ProductType" : "Printer",
"QualificationLevel" : "Signature Only"
}

SigningRequest

The initial input object for the File Signing Services.

Properties

The following table shows the asset properties.

Property name Type Description Required?

ProductName

String

The primary product name.

Yes

AnnouncementDate

DateTime

The date and time that the product will appear on Dashboard reports, such as the Certified Products List and Windows Compatibility Center.

No

PublishingDate

DateTime

The date and time that the product will be published to Windows Update.

No

MarketingNames

MarketingName[]

The list of marketing names for the product. Each request has one primary name (required), and any number of aliases.

No

OSSelections

String

Describes the supported operating systems for your product. It also contains the classification of your submission as listed in the Hardware Certification Taxonomy. You can also use this object to get down-level signatures.

InitialUploadFileSize

Long

The length in bytes of the file to be uploaded.

TestHarnessType

String

The type of kit that was used to create this package. Value should be either HLK or HCK.

Methods

Get and Put methods are supported on all properties.

Example object

{
"ProductName" : "Testing Name",
"MarketingNames" : ["Localized Contoso Toaster"],
"AnnouncementDate" : "2015-01-01T00:00:00",
"PublishingDate" : "2015-11-11T00:00:00",
"OSSelections" : [{
"OS" : "Windows 8",
"ProductType" : "Printer",
"QualificationLevel" : "Signature Only"
}
], 
"InitialUploadFileSize":1233334563,
“TestHarnessType”:”HLK”
}

SigningRequestInfo

Describes a Dashboard submission. You can use this object to determine whether Dashboard processing is complete, select assets for download, or view qualifications that have been granted.

Properties

The following table shows the SigningRequestInfo properties.

Property name Type Description

RequestID

GUID

The unique identifier for this submission. Use this to access the request through PATCH and GET service calls.

ProductName

String

The primary product name.

SubmissionID

String

The Dashboard submission ID for the submission.

Status

String

The processing status of the request.

CreatedDate

DateTime

The date and time that the request was generated.

AnnouncementDate

DateTime

The date and time that the product will appear on Microsoft reports, such as the Windows Certified Products List and Windows Compatibility Center.

PublishingDate

DateTime

The date and time that the product will be published to Windows Update.

VerificationReport

URL

The location of the Certification Verification Report PDF file.

MarketingNames

MarketingName []

The list of marketing names for the submission. Each submission has one primary name (required), and any number of aliases in this collection.

Assets

Asset[]

The list of asset associated with the submission. Assets describe the uploaded packages, signed files, and DUA shell packages.

OSSelections

String

Describes the supported operating systems for your product. It also contains the classification of your submission as listed in the Hardware Certification Taxonomy. You can also use this object to get down-level signatures.

Methods

Get and Put methods are supported on all properties.

Example object

{
"RequestID" : "2b70c57a-7898-48dc-b877-4c0541885eb9",
"ProductName" : "Contoso Toaster",
"SubmissionID" : 33,
"Status" : "Approved",
"CreatedDate" : "2014-01-01T00:00:00",
"AnnouncementDate" : "2015-01-01T00:00:00",
"PublishingDate" : "2015-11-11T00:00:00",
"VerificationReport" : "https://sysdev.microsoft.com/LogoVerificationReport.aspx?sid=32",
"OSSelections" : [{
"OS" : "Windows 8",
"ProductType" : "Printer",
"QualificationLevel" : "Signature Only"
}
],
"MarketingNames" : [{
"Name" : " Localized Contoso Toaster ",
"Locales" : ["en-US"]
}
],
"Assets" : [{
"DeviceSigningAssetID" : "4e53d41f-4ccc-481c-bd00-0f73400f5d6a",
"Name" : "32.hckx",
"AssetType" : 1
}
]
}

SigningRequestUpdate

The object used for updating an existing submission. You can also use this object to mark a submission as UploadComplete to start backend processing.

Properties

The following table shows the asset properties.

Property name Type Description Required?

RequestID

GUID

The unique identifier for this submission. Use this to access the request through PATCH and GET service calls.

Yes

ProductName

String

The primary product name.

No

AnnouncementDate

DateTime

The date and time that the product will appear on Dashboard reports, such as the Certified Products List and Windows Compatibility Center.

No

PublishingDate

DateTime

The date and time that the product will be published to Windows Update.

No

MarketingNames

MarketingName[]

The list of marketing names for the product. Each request has one primary name (required), and any number of aliases.

No

UploadComplete

Bool

A flag specifying when you have successfully uploaded the initial package for this submission. Use Update an existing submission procedure to set this property to TRUE to start backend processing.

No

Methods

Get and Put methods are supported on all properties.

Example object

{
"RequestID" : "2b70c57a-7898-48dc-b877-4c0541885eb9",
"ProductName" : "Contoso Toaster",
"AnnouncementDate" : "2015-01-01T00:00:00",
"PublishingDate" : "2015-11-11T00:00:00",
"MarketingNames" : [{
"Name" : "Localized Contoso Toaster",
"Locales" : ["en-US"]
}
],
"UploadComplete" : true
}

Send comments about this topic to Microsoft