Fixing acrolinx and build issues

This commit is contained in:
Alekhya Jupudi 2021-11-10 19:14:58 +05:30
parent 5bdacc3ebf
commit d58ffa414c
2 changed files with 96 additions and 129 deletions

View File

@ -6,7 +6,7 @@ MS-HAID:
ms.assetid: ABE44EC8-CBE5-4775-BA8A-4564CB73531B ms.assetid: ABE44EC8-CBE5-4775-BA8A-4564CB73531B
ms.reviewer: ms.reviewer:
manager: dansimp manager: dansimp
description: description: Learn about data structures for Microsoft Store for Business.
ms.author: dansimp ms.author: dansimp
ms.topic: article ms.topic: article
ms.prod: w10 ms.prod: w10
@ -17,7 +17,6 @@ ms.date: 09/18/2017
# Data structures for Microsoft Store for Business # Data structures for Microsoft Store for Business
Here's the list of data structures used in the Microsoft Store for Business REST APIs: Here's the list of data structures used in the Microsoft Store for Business REST APIs:
- [AlternateIdentifier](#alternateidentifier) - [AlternateIdentifier](#alternateidentifier)
@ -56,36 +55,36 @@ Specifies the properties of the alternate identifier.
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|type|string|LegacyWindowStoreProductId, LegacyWindowsPhoneProductId, RedirectToThresholdProductId| |Type|String|LegacyWindowStoreProductId, LegacyWindowsPhoneProductId, RedirectToThresholdProductId|
|value|string|| |Value|String||
## BulkSeatOperationResultSet ## BulkSeatOperationResultSet
|Name|Type| |Name|Type|
|--- |--- | |--- |--- |
|seatDetails|collection of [SeatDetails](#seatdetails)| |seatDetails|Collection of [SeatDetails](#seatdetails)|
|failedSeatOperations|collection of [FailedSeatRequest](#failedseatrequest)| |failedSeatOperations|Collection of [FailedSeatRequest](#failedseatrequest)|
## FailedSeatRequest ## FailedSeatRequest
|Name|Type| |Name|Type|
|--- |--- | |--- |--- |
|failureReason|string| |failureReason|String|
|productKey|[ProductKey](#productkey)| |productKey|[ProductKey](#productkey)|
|userName|string| |userName|String|
## FrameworkPackageDetails ## FrameworkPackageDetails
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|packageId|string|| |packageId|String||
|contentId|string|Identifies a specific application.| |contentId|String|Identifies a specific application.|
|location|[PackageLocation](#packagelocation)|| |Location|[PackageLocation](#packagelocation)||
|packageFullName|string|| |packageFullName|String||
|packageIdentityName|string|| |packageIdentityName|String||
|architectures|collection of [ProductArchitectures](#productarchitectures)|| |Architectures|Collection of [ProductArchitectures](#productarchitectures)||
|packageFormat|[ProductPackageFormat](#productpackageformat)|| |packageFormat|[ProductPackageFormat](#productpackageformat)||
|platforms|collection of [ProductPlatform](#productplatform)|| |Platforms|Collection of [ProductPlatform](#productplatform)||
|fileSize|integer-64|Size of the file.| |fileSize|integer-64|Size of the file.|
|packageRank|integer-32|Optional| |packageRank|integer-32|Optional|
@ -93,42 +92,42 @@ Specifies the properties of the alternate identifier.
|Name|Description| |Name|Description|
|--- |--- | |--- |--- |
|open|Open distribution policy - licenses/seats can be assigned/consumed without limit| |Open|Open distribution policy - licenses/seats can be assigned/consumed without limit|
|restricted|Restricted distribution policy - licenses/seats must be assigned/consumed according to the available count| |Restricted|Restricted distribution policy - licenses/seats must be assigned/consumed according to the available count|
## InventoryEntryDetails ## InventoryEntryDetails
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|productKey|[ProductKey](#productkey)|Identifier used on subsequent requests to get additional content including product descriptions, offline license, and download URLs.| |productKey|[ProductKey](#productkey)|Identifier used on subsequent requests to get more content including product descriptions, offline license, and download URLs.|
|seatCapacity|integer-64|Total number of seats that have been purchased for an application.| |seatCapacity|integer-64|Total number of seats that have been purchased for an application.|
|availableSeats|integer-64|Number of available seats remaining for an application.| |availableSeats|integer-64|Number of available seats remaining for an application.|
|lastModified|dateTime|Specifies the last modified date for an application. Modifications for an application includes updated product details, updates to an application, and updates to the quantity of an application.| |lastModified|dateTime|Specifies the last modified date for an application. Modifications for an application include updated product details, updates to an application, and updates to the quantity of an application.|
|licenseType|[LicenseType](#licensetype)|Indicates whether the set of seats for a given application supports online or offline licensing.| |licenseType|[LicenseType](#licensetype)|Indicates whether the set of seats for a given application supports online or offline licensing.|
|distributionPolicy|[InventoryDistributionPolicy](#inventorydistributionpolicy)|| |distributionPolicy|[InventoryDistributionPolicy](#inventorydistributionpolicy)||
|status|[InventoryStatus](#inventorystatus)|| |Status|[InventoryStatus](#inventorystatus)||
## InventoryResultSet ## InventoryResultSet
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|continuationToken|string|Only available if there is a next page.| |continuationToken|String|Only available if there is a next page.|
|inventoryEntries|collection of [InventoryEntryDetails](#inventoryentrydetails)|| |inventoryEntries|Collection of [InventoryEntryDetails](#inventoryentrydetails)||
## InventoryStatus ## InventoryStatus
|Name|Description| |Name|Description|
|--- |--- | |--- |--- |
|active|Entry is available in the organizations inventory.| |Active|Entry is available in the organizations inventory.|
|removed|Entry has been removed from the organizations inventory.| |Removed|Entry has been removed from the organizations inventory.|
## LicenseType ## LicenseType
|Name|Description| |Name|Description|
|--- |--- | |--- |--- |
|online|Online license application.| |Online|Online license application.|
|offline|Offline license application.| |Offline|Offline license application.|
## LocalizedProductDetail ## LocalizedProductDetail
@ -137,11 +136,11 @@ Specifies the properties of the localized product.
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|language|string|Language or fallback language if the specified language is not available.| |Language|String|Language or fallback language if the specified language is not available.|
|displayName|string|Display name of the application.| |displayName|String|Display name of the application.|
|description|string|App description provided by developer can be up to 10,000 characters.| |Description|String|App description provided by developer can be up to 10,000 characters.|
|images|collection of [ProductImage](#productimage)|Artwork and icon associated with the application.| |Images|Collection of [ProductImage](#productimage)|Artwork and icon associated with the application.|
|publisher|[PublisherDetails](#publisherdetails)|Publisher of the application.| |Publisher|[PublisherDetails](#publisherdetails)|Publisher of the application.|
## OfflineLicense ## OfflineLicense
@ -149,33 +148,33 @@ Specifies the properties of the localized product.
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|productKey|[ProductKey](#productkey)|Identifies a set of seats associated with an application.| |productKey|[ProductKey](#productkey)|Identifies a set of seats associated with an application.|
|licenseBlob|string|Base-64 encoded offline license that can be installed via a CSP.| |licenseBlob|String|Base-64 encoded offline license that can be installed via a CSP.|
|licenseInstanceId|string|Version of the license.| |licenseInstanceId|String|Version of the license.|
|requestorId|string|Organization requesting the license.| |requestorId|String|Organization requesting the license.|
|contentId|string|Identifies the specific license required by an application.| |contentId|String|Identifies the specific license required by an application.|
## PackageContentInfo ## PackageContentInfo
|Name|Type| |Name|Type|
|--- |--- | |--- |--- |
|productPlatforms|collection of ProductPlatform| |productPlatforms|Collection of ProductPlatform|
|packageFormat|string| |packageFormat|String|
## PackageLocation ## PackageLocation
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|url|URI|CDN location of the packages. URL expiration is based on the estimated time to download the package.| |Url|URI|CDN location of the packages. URL expiration is based on the estimated time to download the package.|
## ProductArchitectures ## ProductArchitectures
|Name| |Name|
|--- | |--- |
|neutral| |Neutral|
|arm| |Arm|
|x86| |x86|
|x64| |x64|
@ -183,14 +182,14 @@ Specifies the properties of the localized product.
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|productKey|[ProductKey](#productkey)|Identifier used on subsequent requests to get additional content including product descriptions, offline license, and download URLs.| |productKey|[ProductKey](#productkey)|Identifier used on subsequent requests to get more content including product descriptions, offline license, and download URLs.|
|productType|string|Type of product.| |productType|String|Type of product.|
|supportedLanguages|collection of string|The set of localized languages for an application.| |supportedLanguages|Collection of string|The set of localized languages for an application.|
|publisherId|string|Publisher identifier.| |publisherId|String|Publisher identifier.|
|category|string|Application category.| |Category|String|Application category.|
|alternateIds|collection of [AlternateIdentifier](#alternateidentifier)|The identifiers that can be used to instantiate the installation of on online application.| |alternateIds|Collection of [AlternateIdentifier](#alternateidentifier)|The identifiers that can be used to instantiate the installation of on online application.|
|packageFamilyName|string|| |packageFamilyName|String||
|supportedPlatforms|collection of [ProductPlatform](#productplatform)|| |supportedPlatforms|Collection of [ProductPlatform](#productplatform)||
## ProductImage ## ProductImage
@ -199,13 +198,13 @@ Specifies the properties of the product image.
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|location|URI|Location of the download image.| |Location|URI|Location of the download image.|
|purpose|string|Tag for the purpose of the image, e.g. "screenshot" or "logo".| |Purpose|String|Tag for the purpose of the image, for example "screenshot" or "logo".|
|height|string|Height of the image in pixels.| |Height|String|Height of the image in pixels.|
|width|string|Width of the image in pixels.| |Width|String|Width of the image in pixels.|
|caption|string|Unlimited length.| |Caption|String|Unlimited length.|
|backgroundColor|string|Format "#RRGGBB"| |backgroundColor|String|Format "#RRGGBB"|
|foregroundColor|string|Format "#RRGGBB"| |foregroundColor|String|Format "#RRGGBB"|
|fileSize|integer-64|Size of the file.| |fileSize|integer-64|Size of the file.|
## ProductKey ## ProductKey
@ -214,22 +213,22 @@ Specifies the properties of the product key.
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|productId|string|Product identifier for an application that is used by the Store for Business.| |productId|String|Product identifier for an application that is used by the Store for Business.|
|skuId|string|Product identifier that specifies a specific SKU of an application.| |skuId|String|Product identifier that specifies a specific SKU of an application.|
## ProductPackageDetails ## ProductPackageDetails
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|frameworkDependencyPackages|collection of [FrameworkPackageDetails](#frameworkpackagedetails)|| |frameworkDependencyPackages|Collection of [FrameworkPackageDetails](#frameworkpackagedetails)||
|packageId|string|| |packageId|String||
|contentId|string|Identifies a specific application.| |contentId|String|Identifies a specific application.|
|location|[PackageLocation](#packagelocation)|| |Location|[PackageLocation](#packagelocation)||
|packageFullName|string|example,Microsoft.BingTranslator_1.1.10917.2059_x86__8wekyb3d8bbwe| |packageFullName|String|Example, Microsoft.BingTranslator_1.1.10917.2059_x86__8wekyb3d8bbwe|
|packageIdentityName|string|example, Microsoft.BingTranslator| |packageIdentityName|String|Example, Microsoft.BingTranslator|
|architectures|collection of [ProductArchitectures](#productarchitectures)|Values {x86, x64, arm, neutral}| |Architectures|Collection of [ProductArchitectures](#productarchitectures)|Values {x86, x64, arm, neutral}|
|packageFormat|[ProductPackageFormat](#productpackageformat)|Extension of the package file.| |packageFormat|[ProductPackageFormat](#productpackageformat)|Extension of the package file.|
|platforms|collection of [ProductPlatform](#productplatform)|| |Platforms|Collection of [ProductPlatform](#productplatform)||
|fileSize|integer-64|Size of the file.| |fileSize|integer-64|Size of the file.|
|packageRank|integer-32|Optional| |packageRank|integer-32|Optional|
@ -237,22 +236,22 @@ Specifies the properties of the product key.
|Name| |Name|
|--- | |--- |
|appx| |Appx|
|appxBundle| |appxBundle|
|xap| |Xap|
## ProductPackageSet ## ProductPackageSet
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|packageSetId|string|An identifier for the particular combination of application packages.| |packageSetId|String|An identifier for the particular combination of application packages.|
|productPackages|collection of [ProductPackageDetails](#productpackagedetails)|A collection of application packages.| |productPackages|Collection of [ProductPackageDetails](#productpackagedetails)|A collection of application packages.|
## ProductPlatform ## ProductPlatform
|Name|Type| |Name|Type|
|--- |--- | |--- |--- |
|platformName|string| |platformName|String|
|minVersion|[VersionInfo](#versioninfo)| |minVersion|[VersionInfo](#versioninfo)|
|maxTestedVersion|[VersionInfo](#versioninfo)| |maxTestedVersion|[VersionInfo](#versioninfo)|
@ -262,54 +261,54 @@ Specifies the properties of the publisher details.
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|publisherName|string|Name of the publisher.| |publisherName|String|Name of the publisher.|
|publisherWebsite|string|Website of the publisher.| |publisherWebsite|String|Website of the publisher.|
## SeatAction ## SeatAction
|Name| |Name|
|--- | |--- |
|assign| |Assign|
|reclaim| |Reclaim|
## SeatDetails ## SeatDetails
|Name|Type|Description| |Name|Type|Description|
|--- |--- |--- | |--- |--- |--- |
|assignedTo|string|Format = UPN (user@domain)| |assignedTo|String|Format = UPN (user@domain)|
|dateAssigned|datetime|| |dateAssigned|Datetime||
|state|[SeatState](#seatstate)|| |State|[SeatState](#seatstate)||
|productKey|[ProductKey](#productkey)|| |productKey|[ProductKey](#productkey)||
## SeatDetailsResultSet ## SeatDetailsResultSet
|Name|Type| |Name|Type|
|--- |--- | |--- |--- |
|seats|collection of [SeatDetails](#seatdetails)| |Seats|Collection of [SeatDetails](#seatdetails)|
|continuationToken|string| |continuationToken|String|
## SeatState ## SeatState
|Name| |Name|
|--- | |--- |
|active| |Active|
|revoked| |Revoked|
## SupportedProductPlatform ## SupportedProductPlatform
|Name|Type| |Name|Type|
|--- |--- | |--- |--- |
|platformName|string| |platformName|String|
|minVersion|[VersionInfo](#versioninfo)| |minVersion|[VersionInfo](#versioninfo)|
|maxTestedVersion|[VersionInfo](#versioninfo)| |maxTestedVersion|[VersionInfo](#versioninfo)|
|architectures|collection of [ProductArchitectures](#productarchitectures)| |Architectures|Collection of [ProductArchitectures](#productarchitectures)|
## VersionInfo ## VersionInfo
|Name|Type| |Name|Type|
|--- |--- | |--- |--- |
|major|integer-32| |Major|integer-32|
|minor|integer-32| |Minor|integer-32|
|build|integer-32| |Build|integer-32|
|revision|integer-32| |Revision|integer-32|

View File

@ -158,48 +158,16 @@ Supported operations are Get, Add, and Replace.
<a href="" id="-download-productid-status"></a>**/Download/*ProductID*/Status** <a href="" id="-download-productid-status"></a>**/Download/*ProductID*/Status**
Required. The integer value that indicates the status of the current download process. The following table shows the possible values. Required. The integer value that indicates the status of the current download process. The following table shows the possible values.
<table> |Value|Description|
<colgroup> |--- |--- |
<col width="50%" /> |0: CONFIRM|Waiting for confirmation from user.|
<col width="50%" /> |1: QUEUED|Waiting for download to start.|
</colgroup> |2: DOWNLOADING|In the process of downloading.|
<tbody> |3: DOWNLOADED|Waiting for installation to start.|
<tr class="odd"> |4: INSTALLING|Handed off for installation.|
<td><p>0: CONFIRM</p></td> |5: INSTALLED|Successfully installed|
<td><p>Waiting for confirmation from user.</p></td> |6: FAILED|Application was rejected (not signed properly, bad XAP format, not enrolled properly, etc.)|
</tr> |7:DOWNLOAD_FAILED|Unable to connect to server, file doesn't exist, etc.|
<tr class="even">
<td><p>1: QUEUED</p></td>
<td><p>Waiting for download to start.</p></td>
</tr>
<tr class="odd">
<td><p>2: DOWNLOADING</p></td>
<td><p>In the process of downloading.</p></td>
</tr>
<tr class="even">
<td><p>3: DOWNLOADED</p></td>
<td><p>Waiting for installation to start.</p></td>
</tr>
<tr class="odd">
<td><p>4: INSTALLING</p></td>
<td><p>Handed off for installation.</p></td>
</tr>
<tr class="even">
<td><p>5: INSTALLED</p></td>
<td><p>Successfully installed</p></td>
</tr>
<tr class="odd">
<td><p>6: FAILED</p></td>
<td><p>Application was rejected (not signed properly, bad XAP format, not enrolled properly, etc.)</p></td>
</tr>
<tr class="even">
<td><p>7:DOWNLOAD_FAILED</p></td>
<td><p>Unable to connect to server, file doesn&#39;t exist, etc.</p></td>
</tr>
</tbody>
</table>
Scope is dynamic. Supported operations are Get, Add, and Replace. Scope is dynamic. Supported operations are Get, Add, and Replace.