diff --git a/windows/client-management/mdm/data-structures-windows-store-for-business.md b/windows/client-management/mdm/data-structures-windows-store-for-business.md index 46fda3c4d4..b20c4ce200 100644 --- a/windows/client-management/mdm/data-structures-windows-store-for-business.md +++ b/windows/client-management/mdm/data-structures-windows-store-for-business.md @@ -6,7 +6,7 @@ MS-HAID: ms.assetid: ABE44EC8-CBE5-4775-BA8A-4564CB73531B ms.reviewer: manager: dansimp -description: +description: Learn about data structures for Microsoft Store for Business. ms.author: dansimp ms.topic: article ms.prod: w10 @@ -17,7 +17,6 @@ ms.date: 09/18/2017 # Data structures for Microsoft Store for Business - Here's the list of data structures used in the Microsoft Store for Business REST APIs: - [AlternateIdentifier](#alternateidentifier) @@ -56,36 +55,36 @@ Specifies the properties of the alternate identifier. |Name|Type|Description| |--- |--- |--- | -|type|string|LegacyWindowStoreProductId, LegacyWindowsPhoneProductId, RedirectToThresholdProductId| -|value|string|| +|Type|String|LegacyWindowStoreProductId, LegacyWindowsPhoneProductId, RedirectToThresholdProductId| +|Value|String|| ## BulkSeatOperationResultSet |Name|Type| |--- |--- | -|seatDetails|collection of [SeatDetails](#seatdetails)| -|failedSeatOperations|collection of [FailedSeatRequest](#failedseatrequest)| +|seatDetails|Collection of [SeatDetails](#seatdetails)| +|failedSeatOperations|Collection of [FailedSeatRequest](#failedseatrequest)| ## FailedSeatRequest |Name|Type| |--- |--- | -|failureReason|string| +|failureReason|String| |productKey|[ProductKey](#productkey)| -|userName|string| +|userName|String| ## FrameworkPackageDetails |Name|Type|Description| |--- |--- |--- | -|packageId|string|| -|contentId|string|Identifies a specific application.| -|location|[PackageLocation](#packagelocation)|| -|packageFullName|string|| -|packageIdentityName|string|| -|architectures|collection of [ProductArchitectures](#productarchitectures)|| +|packageId|String|| +|contentId|String|Identifies a specific application.| +|Location|[PackageLocation](#packagelocation)|| +|packageFullName|String|| +|packageIdentityName|String|| +|Architectures|Collection of [ProductArchitectures](#productarchitectures)|| |packageFormat|[ProductPackageFormat](#productpackageformat)|| -|platforms|collection of [ProductPlatform](#productplatform)|| +|Platforms|Collection of [ProductPlatform](#productplatform)|| |fileSize|integer-64|Size of the file.| |packageRank|integer-32|Optional| @@ -93,42 +92,42 @@ Specifies the properties of the alternate identifier. |Name|Description| |--- |--- | -|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| +|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| ## InventoryEntryDetails |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.| |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.| |distributionPolicy|[InventoryDistributionPolicy](#inventorydistributionpolicy)|| -|status|[InventoryStatus](#inventorystatus)|| +|Status|[InventoryStatus](#inventorystatus)|| ## InventoryResultSet |Name|Type|Description| |--- |--- |--- | -|continuationToken|string|Only available if there is a next page.| -|inventoryEntries|collection of [InventoryEntryDetails](#inventoryentrydetails)|| +|continuationToken|String|Only available if there is a next page.| +|inventoryEntries|Collection of [InventoryEntryDetails](#inventoryentrydetails)|| ## InventoryStatus |Name|Description| |--- |--- | -|active|Entry is available in the organization’s inventory.| -|removed|Entry has been removed from the organization’s inventory.| +|Active|Entry is available in the organization’s inventory.| +|Removed|Entry has been removed from the organization’s inventory.| ## LicenseType |Name|Description| |--- |--- | -|online|Online license application.| -|offline|Offline license application.| +|Online|Online license application.| +|Offline|Offline license application.| ## LocalizedProductDetail @@ -137,11 +136,11 @@ Specifies the properties of the localized product. |Name|Type|Description| |--- |--- |--- | -|language|string|Language or fallback language if the specified language is not available.| -|displayName|string|Display name of the application.| -|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.| -|publisher|[PublisherDetails](#publisherdetails)|Publisher of the application.| +|Language|String|Language or fallback language if the specified language is not available.| +|displayName|String|Display name of the application.| +|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.| +|Publisher|[PublisherDetails](#publisherdetails)|Publisher of the application.| ## OfflineLicense @@ -149,33 +148,33 @@ Specifies the properties of the localized product. |Name|Type|Description| |--- |--- |--- | |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.| -|licenseInstanceId|string|Version of the license.| -|requestorId|string|Organization requesting the license.| -|contentId|string|Identifies the specific license required by an application.| +|licenseBlob|String|Base-64 encoded offline license that can be installed via a CSP.| +|licenseInstanceId|String|Version of the license.| +|requestorId|String|Organization requesting the license.| +|contentId|String|Identifies the specific license required by an application.| ## PackageContentInfo |Name|Type| |--- |--- | -|productPlatforms|collection of ProductPlatform| -|packageFormat|string| +|productPlatforms|Collection of ProductPlatform| +|packageFormat|String| ## PackageLocation |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 |Name| |--- | -|neutral| -|arm| +|Neutral| +|Arm| |x86| |x64| @@ -183,14 +182,14 @@ Specifies the properties of the localized product. |Name|Type|Description| |--- |--- |--- | -|productKey|[ProductKey](#productkey)|Identifier used on subsequent requests to get additional content including product descriptions, offline license, and download URLs.| -|productType|string|Type of product.| -|supportedLanguages|collection of string|The set of localized languages for an application.| -|publisherId|string|Publisher identifier.| -|category|string|Application category.| -|alternateIds|collection of [AlternateIdentifier](#alternateidentifier)|The identifiers that can be used to instantiate the installation of on online application.| -|packageFamilyName|string|| -|supportedPlatforms|collection of [ProductPlatform](#productplatform)|| +|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.| +|supportedLanguages|Collection of string|The set of localized languages for an application.| +|publisherId|String|Publisher identifier.| +|Category|String|Application category.| +|alternateIds|Collection of [AlternateIdentifier](#alternateidentifier)|The identifiers that can be used to instantiate the installation of on online application.| +|packageFamilyName|String|| +|supportedPlatforms|Collection of [ProductPlatform](#productplatform)|| ## ProductImage @@ -199,13 +198,13 @@ Specifies the properties of the product image. |Name|Type|Description| |--- |--- |--- | -|location|URI|Location of the download image.| -|purpose|string|Tag for the purpose of the image, e.g. "screenshot" or "logo".| -|height|string|Height of the image in pixels.| -|width|string|Width of the image in pixels.| -|caption|string|Unlimited length.| -|backgroundColor|string|Format "#RRGGBB"| -|foregroundColor|string|Format "#RRGGBB"| +|Location|URI|Location of the download image.| +|Purpose|String|Tag for the purpose of the image, for example "screenshot" or "logo".| +|Height|String|Height of the image in pixels.| +|Width|String|Width of the image in pixels.| +|Caption|String|Unlimited length.| +|backgroundColor|String|Format "#RRGGBB"| +|foregroundColor|String|Format "#RRGGBB"| |fileSize|integer-64|Size of the file.| ## ProductKey @@ -214,22 +213,22 @@ Specifies the properties of the product key. |Name|Type|Description| |--- |--- |--- | -|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.| +|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.| ## ProductPackageDetails |Name|Type|Description| |--- |--- |--- | -|frameworkDependencyPackages|collection of [FrameworkPackageDetails](#frameworkpackagedetails)|| -|packageId|string|| -|contentId|string|Identifies a specific application.| -|location|[PackageLocation](#packagelocation)|| -|packageFullName|string|example,Microsoft.BingTranslator_1.1.10917.2059_x86__8wekyb3d8bbwe| -|packageIdentityName|string|example, Microsoft.BingTranslator| -|architectures|collection of [ProductArchitectures](#productarchitectures)|Values {x86, x64, arm, neutral}| +|frameworkDependencyPackages|Collection of [FrameworkPackageDetails](#frameworkpackagedetails)|| +|packageId|String|| +|contentId|String|Identifies a specific application.| +|Location|[PackageLocation](#packagelocation)|| +|packageFullName|String|Example, Microsoft.BingTranslator_1.1.10917.2059_x86__8wekyb3d8bbwe| +|packageIdentityName|String|Example, Microsoft.BingTranslator| +|Architectures|Collection of [ProductArchitectures](#productarchitectures)|Values {x86, x64, arm, neutral}| |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.| |packageRank|integer-32|Optional| @@ -237,22 +236,22 @@ Specifies the properties of the product key. |Name| |--- | -|appx| +|Appx| |appxBundle| -|xap| +|Xap| ## ProductPackageSet |Name|Type|Description| |--- |--- |--- | -|packageSetId|string|An identifier for the particular combination of application packages.| -|productPackages|collection of [ProductPackageDetails](#productpackagedetails)|A collection of application packages.| +|packageSetId|String|An identifier for the particular combination of application packages.| +|productPackages|Collection of [ProductPackageDetails](#productpackagedetails)|A collection of application packages.| ## ProductPlatform |Name|Type| |--- |--- | -|platformName|string| +|platformName|String| |minVersion|[VersionInfo](#versioninfo)| |maxTestedVersion|[VersionInfo](#versioninfo)| @@ -262,54 +261,54 @@ Specifies the properties of the publisher details. |Name|Type|Description| |--- |--- |--- | -|publisherName|string|Name of the publisher.| -|publisherWebsite|string|Website of the publisher.| +|publisherName|String|Name of the publisher.| +|publisherWebsite|String|Website of the publisher.| ## SeatAction |Name| |--- | -|assign| -|reclaim| +|Assign| +|Reclaim| ## SeatDetails |Name|Type|Description| |--- |--- |--- | -|assignedTo|string|Format = UPN (user@domain)| -|dateAssigned|datetime|| -|state|[SeatState](#seatstate)|| +|assignedTo|String|Format = UPN (user@domain)| +|dateAssigned|Datetime|| +|State|[SeatState](#seatstate)|| |productKey|[ProductKey](#productkey)|| ## SeatDetailsResultSet |Name|Type| |--- |--- | -|seats|collection of [SeatDetails](#seatdetails)| -|continuationToken|string| +|Seats|Collection of [SeatDetails](#seatdetails)| +|continuationToken|String| ## SeatState |Name| |--- | -|active| -|revoked| +|Active| +|Revoked| ## SupportedProductPlatform |Name|Type| |--- |--- | -|platformName|string| +|platformName|String| |minVersion|[VersionInfo](#versioninfo)| |maxTestedVersion|[VersionInfo](#versioninfo)| -|architectures|collection of [ProductArchitectures](#productarchitectures)| +|Architectures|Collection of [ProductArchitectures](#productarchitectures)| ## VersionInfo |Name|Type| |--- |--- | -|major|integer-32| -|minor|integer-32| -|build|integer-32| -|revision|integer-32| +|Major|integer-32| +|Minor|integer-32| +|Build|integer-32| +|Revision|integer-32| diff --git a/windows/client-management/mdm/enterpriseappmanagement-csp.md b/windows/client-management/mdm/enterpriseappmanagement-csp.md index f5132cb038..fd9d3891b3 100644 --- a/windows/client-management/mdm/enterpriseappmanagement-csp.md +++ b/windows/client-management/mdm/enterpriseappmanagement-csp.md @@ -158,48 +158,16 @@ Supported operations are Get, Add, and Replace. **/Download/*ProductID*/Status** Required. The integer value that indicates the status of the current download process. The following table shows the possible values. - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

0: CONFIRM

Waiting for confirmation from user.

1: QUEUED

Waiting for download to start.

2: DOWNLOADING

In the process of downloading.

3: DOWNLOADED

Waiting for installation to start.

4: INSTALLING

Handed off for installation.

5: INSTALLED

Successfully installed

6: FAILED

Application was rejected (not signed properly, bad XAP format, not enrolled properly, etc.)

7:DOWNLOAD_FAILED

Unable to connect to server, file doesn't exist, etc.

- - +|Value|Description| +|--- |--- | +|0: CONFIRM|Waiting for confirmation from user.| +|1: QUEUED|Waiting for download to start.| +|2: DOWNLOADING|In the process of downloading.| +|3: DOWNLOADED|Waiting for installation to start.| +|4: INSTALLING|Handed off for installation.| +|5: INSTALLED|Successfully installed| +|6: FAILED|Application was rejected (not signed properly, bad XAP format, not enrolled properly, etc.)| +|7:DOWNLOAD_FAILED|Unable to connect to server, file doesn't exist, etc.| Scope is dynamic. Supported operations are Get, Add, and Replace.