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 b1e8b42c40..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) @@ -54,1067 +53,262 @@ Here's the list of data structures used in the Microsoft Store for Business REST Specifies the properties of the alternate identifier. -
Name | -Type | -Description | -
---|---|---|
type |
-string |
-LegacyWindowStoreProductId, LegacyWindowsPhoneProductId, RedirectToThresholdProductId |
-
value |
-string |
-- |
Name | -Type | -
---|---|
seatDetails |
-collection of SeatDetails |
-
failedSeatOperations |
-collection of FailedSeatRequest |
-
Name | -Type | -
---|---|
failureReason |
-string |
-
productKey |
-- |
userName |
-string |
-
Name | -Type | -Description | -
---|---|---|
packageId |
-string |
-- |
contentId |
-string |
-Identifies a specific application. |
-
location |
-- | - |
packageFullName |
-string |
-- |
packageIdentityName |
-string |
-- |
architectures |
-collection of ProductArchitectures |
-- |
packageFormat |
-- | - |
platforms |
-collection of ProductPlatform |
-- |
fileSize |
-integer-64 |
-Size of the file. |
-
packageRank |
-integer-32 |
-Optional |
-
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 |
-
Name | -Type | -Description | -
---|---|---|
productKey |
-- | Identifier used on subsequent requests to get additional 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. |
-
licenseType |
-- | Indicates whether the set of seats for a given application supports online or offline licensing. |
-
distributionPolicy |
-- | - |
status |
-- | - |
Name | -Type | -Description | -
---|---|---|
continuationToken |
-string |
-Only available if there is a next page. |
-
inventoryEntries |
-collection of InventoryEntryDetails |
-- |
Name | -Description | -
---|---|
active |
-Entry is available in the organization’s inventory. |
-
removed |
-Entry has been removed from the organization’s inventory. |
-
Name | -Description | -
---|---|
online |
-Online license application. |
-
offline |
-Offline license application. |
-
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 |
-Artwork and icon associated with the application. |
-
publisher |
-- | Publisher of the application. |
-
Name | -Type | -Description | -
---|---|---|
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. |
-
Name | -Type | -
---|---|
productPlatforms |
-collection of ProductPlatform |
-
packageFormat |
-string |
-
Name | -Type | -Description | -
---|---|---|
url |
-URI |
-CDN location of the packages. URL expiration is based on the estimated time to download the package. |
-
Name | -
---|
neutral |
-
arm |
-
x86 |
-
x64 |
-
Name | -Type | -Description | -
---|---|---|
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 |
-The identifiers that can be used to instantiate the installation of on online application. |
-
packageFamilyName |
-string |
-- |
supportedPlatforms |
-collection of ProductPlatform |
-- |
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" |
-
fileSize |
-integer-64 |
-Size of the file. |
-
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. |
-
Name | -Type | -Description | -
---|---|---|
frameworkDependencyPackages |
-collection of FrameworkPackageDetails |
-- |
packageId |
-string |
-- |
contentId |
-string |
-Identifies a specific application. |
-
location |
-- | - |
packageFullName |
-string |
-example, Microsoft.BingTranslator_1.1.10917.2059_x86__8wekyb3d8bbwe |
-
packageIdentityName |
-string |
-example, Microsoft.BingTranslator |
-
architectures |
-collection of ProductArchitectures |
-Values {x86, x64, arm, neutral} |
-
packageFormat |
-- | Extension of the package file. |
-
platforms |
-collection of ProductPlatform |
-- |
fileSize |
-integer-64 |
-Size of the file. |
-
packageRank |
-integer-32 |
-Optional |
-
Name | -
---|
appx |
-
appxBundle |
-
xap |
-
Name | -Type | -Description | -
---|---|---|
packageSetId |
-string |
-An identifier for the particular combination of application packages. |
-
productPackages |
-collection of ProductPackageDetails |
-A collection of application packages. |
-
Name | -Type | -
---|---|
platformName |
-string |
-
minVersion |
-- |
maxTestedVersion |
-- |
Name | -Type | -Description | -
---|---|---|
publisherName |
-string |
-Name of the publisher. |
-
publisherWebsite |
-string |
-Website of the publisher. |
-
Name | -
---|
assign |
-
reclaim |
-
Name | -Type | -Description | -
---|---|---|
assignedTo |
-string |
-Format = UPN (user@domain) |
-
dateAssigned |
-datetime |
-- |
state |
-- | - |
productKey |
-- | - |
Name | -Type | -
---|---|
seats |
-collection of SeatDetails |
-
continuationToken |
-string |
-
Name | -
---|
active |
-
revoked |
-
Name | -Type | -
---|---|
platformName |
-string |
-
minVersion |
-- |
maxTestedVersion |
-- |
architectures |
-collection of ProductArchitectures |
-
Name | -Type | -
---|---|
major |
-integer-32 |
-
minor |
-integer-32 |
-
build |
-integer-32 |
-
revision |
-integer-32 |
-
Update category | -Maximum deferral | -Deferral increment | -Update type/notes | -
---|---|---|---|
OS upgrade |
-8 months |
-1 month |
-Upgrade - 3689BDC8-B205-4AF4-8D4A-A63924C5E9D5 |
-
Update |
-1 month |
-1 week |
-
-Note
-If a machine has Microsoft Update enabled, any Microsoft Updates in these categories will also observe Defer / Pause logic.
-
-
|
-
Other/cannot defer |
-No deferral |
-No deferral |
-Any update category not enumerated above falls into this category. -Definition Update - E0789628-CE08-4437-BE74-2495B842F43B |
-
GPO key | -Type | -Value | -
---|---|---|
BranchReadinessLevel |
-REG_DWORD |
-16: systems take Feature Updates on the Current Branch (CB) train -32: systems take Feature Updates on the Current Branch for Business -Other value or absent: receive all applicable updates (CB) |
-
DeferQualityUpdates |
-REG_DWORD |
-1: defer quality updates -Other value or absent: don’t defer quality updates |
-
DeferQualityUpdatesPeriodInDays |
-REG_DWORD |
-0-30: days to defer quality updates |
-
PauseQualityUpdates |
-REG_DWORD |
-1: pause quality updates -Other value or absent: don’t pause quality updates |
-
DeferFeatureUpdates |
-REG_DWORD |
-1: defer feature updates -Other value or absent: don’t defer feature updates |
-
DeferFeatureUpdatesPeriodInDays |
-REG_DWORD |
-0-180: days to defer feature updates |
-
PauseFeatureUpdates |
-REG_DWORD |
-1: pause feature updates -Other value or absent: don’t pause feature updates |
-
ExcludeWUDriversInQualityUpdate |
-REG_DWORD |
-1: exclude WU drivers -Other value or absent: offer WU drivers |
-
Schedule name | -Schedule set by the server | -Actual value queried on device | -
---|---|---|
IntervalForFirstSetOfRetries |
-15 |
-15 |
-
NumberOfFirstRetries |
-5 |
-5 |
-
IntervalForSecondSetOfRetries |
-60 |
-60 |
-
NumberOfSecondRetries |
-10 |
-10 |
-
IntervalForRemainingScheduledRetries |
-1440 |
-1440 |
-
NumberOfRemainingScheduledRetries |
-0 |
-0 |
-
Schedule name | -Schedule set by the server | -Actual value queried on device | -
---|---|---|
IntervalForFirstSetOfRetries |
-15 |
-15 |
-
NumberOfFirstRetries |
-5 |
-5 |
-
IntervalForSecondSetOfRetries |
-60 |
-60 |
-
NumberOfSecondRetries |
-10 |
-10 |
-
IntervalForRemainingScheduledRetries |
-0 |
-0 |
-
NumberOfRemainingScheduledRetries |
-0 |
-0 |
-
Schedule name | -Schedule set by the server | -Actual value queried on device | -
---|---|---|
IntervalForFirstSetOfRetries |
-0 |
-0 |
-
NumberOfFirstRetries |
-0 |
-0 |
-
IntervalForSecondSetOfRetries |
-0 |
-0 |
-
NumberOfSecondRetries |
-0 |
-0 |
-
IntervalForRemainingScheduledRetries |
-0 |
-0 |
-
NumberOfRemainingScheduledRetries |
-0 |
-0 |
-
Schedule name | -Schedule set by server | -Actual schedule set on device | -Actual experience | -
---|---|---|---|
IntervalForFirstSetOfRetries |
-15 |
-15 |
-Device polls |
-
NumberOfFirstRetries |
-5 |
-5 |
-Device polls |
-
IntervalForSecondSetOfRetries |
-1440 |
-1440 |
-Device polls the server once in 24 hours |
-
NumberOfSecondRetries |
-0 |
-0 |
-Device polls the server once in 24 hours |
-
IntervalForRemainingScheduledRetries |
-1440 |
-0 |
-Third schedule is disabled |
-
NumberOfRemainingScheduledRetries |
-0 |
-0 |
-Third schedule is disabled |
-
Status | -Description | -
---|---|
0 |
-Success |
-
1 |
-Failure: invalid PFN |
-
2 |
-Failure: invalid or expired device authentication with MSA |
-
3 |
-Failure: WNS client registration failed due to an invalid or revoked PFN |
-
4 |
-Failure: no Channel URI assigned |
-
5 |
-Failure: Channel URI has expired |
-
6 |
-Failure: Channel URI failed to be revoked |
-
7 |
-Failure: push notification received, but unable to establish an OMA-DM session due to power or connectivity limitations. |
-
8 |
-Unknown error |
-
Return code | -Description | -
---|---|
CONFIG_E_OBJECTBUSY |
-Another instance of the configuration management service is currently running. |
-
CONFIG_E_ENTRYNOTFOUND |
-No metabase entry was found. |
-
CONFIG_E_CSPEXCEPTION |
-An exception occurred in one of the configuration service providers. |
-
CONFIG_E_TRANSACTIONINGFAILURE |
-A configuration service provider failed to roll back properly. The affected settings might be in an unknown state. |
-
CONFIG_E_BAD_XML |
-The XML input is invalid or malformed. |
-
Minimum supported client |
-None supported |
-
Minimum supported server |
-None supported |
-
Minimum supported phone |
-Windows Phone 8.1 |
-
Header |
-Dmprocessxmlfiltered.h |
-
Library |
-Dmprocessxmlfiltered.lib |
-
DLL |
-Dmprocessxmlfiltered.dll |
-
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 |
-Lime |
-
1 |
-Green |
-
2 |
-Emerald |
-
3 |
-Teal (Viridian) |
-
4 |
-Cyan (Blue) |
-
5 |
-Cobalt |
-
6 |
-Indigo |
-
7 |
-Violet (Purple) |
-
8 |
-Pink |
-
9 |
-Magenta |
-
10 |
-Crimson |
-
11 |
-Red |
-
12 |
-Orange (Mango) |
-
13 |
-Amber |
-
14 |
-Yellow |
-
15 |
-Brown |
-
16 |
-Olive |
-
17 |
-Steel |
-
18 |
-Mauve |
-
19 |
-Sienna |
-
101 through 104 |
-Optional colors, as defined by the OEM |
-
151 |
-Custom accent color for Enterprise |
-
Value | -Time zone | -
---|---|
0 |
-UTC-12 International Date Line West |
-
100 |
-UTC+13 Samoa |
-
110 |
-UTC-11 Coordinated Universal Time-11 |
-
200 |
-UTC-10 Hawaii |
-
300 |
-UTC-09 Alaska |
-
400 |
-UTC-08 Pacific Time (US & Canada) |
-
410 |
-UTC-08 Baja California |
-
500 |
-UTC-07 Mountain Time (US & Canada) |
-
510 |
-UTC-07 Chihuahua, La Paz, Mazatlan |
-
520 |
-UTC-07 Arizona |
-
600 |
-UTC-06 Saskatchewan |
-
610 |
-UTC-06 Central America |
-
620 |
-UTC-06 Central Time (US & Canada) |
-
630 |
-UTC-06 Guadalajara, Mexico City, Monterrey |
-
700 |
-UTC-05 Eastern Time (US & Canada) |
-
710 |
-UTC-05 Bogota, Lima, Quito |
-
720 |
-UTC-05 Indiana (East) |
-
800 |
-UTC-04 Atlantic Time (Canada) |
-
810 |
-UTC-04 Cuiaba |
-
820 |
-UTC-04 Santiago |
-
830 |
-UTC-04 Georgetown, La Paz, Manaus, San Juan |
-
840 |
-UTC-04 Caracas |
-
850 |
-UTC-04 Asuncion |
-
900 |
-UTC-03:30 Newfoundland |
-
910 |
-UTC-03 Brasilia |
-
920 |
-UTC-03 Greenland |
-
930 |
-UTC-03 Montevideo |
-
940 |
-UTC-03 Cayenne, Fortaleza |
-
950 |
-UTC-03 Buenos Aires |
-
960 |
-UTC-03 Salvador |
-
1000 |
-UTC-02 Mid-Atlantic |
-
1010 |
-UTC-02 Coordinated Universal Time-02 |
-
1100 |
-UTC-01 Azores |
-
1110 |
-UTC-01 Cabo Verde |
-
1200 |
-UTC Dublin, Edinburgh, Lisbon, London |
-
1210 |
-UTC Monrovia, Reykjavik |
-
1220 |
-UTC Casablanca |
-
1230 |
-UTC Coordinated Universal Time |
-
1300 |
-UTC+01 Belgrade, Bratislava, Budapest, Ljubljana, Prague |
-
1310 |
-UTC+01 Sarajevo, Skopje, Warsaw, Zagreb |
-
1320 |
-UTC+01 Brussels, Copenhagen, Madrid, Paris |
-
1330 |
-UTC+01 West Central Africa |
-
1340 |
-UTC+01 Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna |
-
1350 |
-UTC+01 Windhoek |
-
1360 |
-UTC+01 Tripoli |
-
1400 |
-UTC+02 E. Europe |
-
1410 |
-UTC+02 Cairo |
-
1420 |
-UTC+02 Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius |
-
1430 |
-UTC+02 Athens, Bucharest |
-
1440 |
-UTC+02 Jerusalem |
-
1450 |
-UTC+02 Amman |
-
1460 |
-UTC+02 Beirut |
-
1470 |
-UTC+02 Harare, Pretoria |
-
1480 |
-UTC+02 Damascus |
-
1490 |
-UTC+02 Istanbul |
-
1500 |
-UTC+03 Kuwait, Riyadh |
-
1510 |
-UTC+03 Baghdad |
-
1520 |
-UTC+03 Nairobi |
-
1530 |
-UTC+03 Kaliningrad, Minsk |
-
1540 |
-UTC+04 Moscow, St. Petersburg, Volgograd |
-
1550 |
-UTC+03 Tehran |
-
1600 |
-UTC+04 Abu Dhabi, Muscat |
-
1610 |
-UTC+04 Baku |
-
1620 |
-UTC+04 Yerevan |
-
1630 |
-UTC+04 Kabul |
-
1640 |
-UTC+04 Tbilisi |
-
1650 |
-UTC+04 Port Louis |
-
1700 |
-UTC+06 Ekaterinburg |
-
1710 |
-UTC+05 Tashkent |
-
1720 |
-UTC+05 Chennai, Kolkata, Mumbai, New Delhi |
-
1730 |
-UTC+05 Sri Jayawardenepura |
-
1740 |
-UTC+05 Kathmandu |
-
1750 |
-UTC+05 Islamabad, Karachi |
-
1800 |
-UTC+06 Astana |
-
1810 |
-UTC+07 Novosibirsk |
-
1820 |
-UTC+06 Yangon (Rangoon) |
-
1830 |
-UTC+06 Dhaka |
-
1900 |
-UTC+08 Krasnoyarsk |
-
1910 |
-UTC+07 Bangkok, Hanoi, Jakarta |
-
1900 |
-UTC+08 Krasnoyarsk |
-
2000 |
-UTC+08 Beijing, Chongqing, Hong Kong SAR, Urumqi |
-
2010 |
-UTC+09 Irkutsk |
-
2020 |
-UTC+08 Kuala Lumpur, Singapore |
-
2030 |
-UTC+08 Taipei |
-
2040 |
-UTC+08 Perth |
-
2050 |
-UTC+08 Ulaanbaatar |
-
2100 |
-UTC+09 Seoul |
-
2110 |
-UTC+09 Osaka, Sapporo, Tokyo |
-
2120 |
-UTC+10 Yakutsk |
-
2130 |
-UTC+09 Darwin |
-
2140 |
-UTC+09 Adelaide |
-
2200 |
-UTC+10 Canberra, Melbourne, Sydney |
-
2210 |
-UTC+10 Brisbane |
-
2220 |
-UTC+10 Hobart |
-
2230 |
-UTC+11 Vladivostok |
-
2240 |
-UTC+10 Guam, Port Moresby |
-
2300 |
-UTC+11 Solomon Is., New Caledonia |
-
2310 |
-UTC+12 Magadan |
-
2400 |
-UTC+12 Fiji |
-
2410 |
-UTC+12 Auckland, Wellington |
-
2420 |
-UTC+12 Petropavlovsk-Kamchatsky |
-
2430 |
-UTC+12 Coordinated Universal Time +12 |
-
2500 |
-UTC+13 Nuku'alofa |
-
App | -Product ID | -AUMID | -
---|---|---|
Alarms and clock | -44F7D2B4-553D-4BEC-A8B7-634CE897ED5F | -Microsoft.WindowsAlarms_8wekyb3d8bbwe!App | -
Calculator | -B58171C6-C70C-4266-A2E8-8F9C994F4456 | -Microsoft.WindowsCalculator_8wekyb3d8bbwe!App | -
Camera | -F0D8FEFD-31CD-43A1-A45A-D0276DB069F1 | -Microsoft.WindowsCamera_8wekyb3d8bbwe!App | -
Contact Support | -0DB5FCFF-4544-458A-B320-E352DFD9CA2B | -Windows.ContactSupport_cw5n1h2txyewy!App | -
Cortana | -FD68DCF4-166F-4C55-A4CA-348020F71B94 | -Microsoft.Windows.Cortana_cw5n1h2txyewy!CortanaUI | -
Excel | -EAD3E7C0-FAE6-4603-8699-6A448138F4DC | -Microsoft.Office.Excel_8wekyb3d8bbwe!microsoft.excel | -
82A23635-5BD9-DF11-A844-00237DE2DB9E | -Microsoft.MSFacebook_8wekyb3d8bbwe!x82a236355bd9df11a84400237de2db9e | -|
File Explorer | -C5E2524A-EA46-4F67-841F-6A9465D9D515 | -c5e2524a-ea46-4f67-841f-6a9465d9d515_cw5n1h2txyewy!App | -
FM Radio | -F725010E-455D-4C09-AC48-BCDEF0D4B626 | -N/A | -
Get Started | -B3726308-3D74-4A14-A84C-867C8C735C3C | -Microsoft.Getstarted_8wekyb3d8bbwe!App | -
Groove Music | -D2B6A184-DA39-4C9A-9E0A-8B589B03DEC0 | -Microsoft.ZuneMusic_8wekyb3d8bbwe!Microsoft.ZuneMusic | -
Maps | -ED27A07E-AF57-416B-BC0C-2596B622EF7D | -Microsoft.WindowsMaps_8wekyb3d8bbwe!App | -
Messaging | -27E26F40-E031-48A6-B130-D1F20388991A | -Microsoft.Messaging_8wekyb3d8bbwe!x27e26f40ye031y48a6yb130yd1f20388991ax | -
Microsoft Edge | -395589FB-5884-4709-B9DF-F7D558663FFD | -Microsoft.MicrosoftEdge_8wekyb3d8bbwe!MicrosoftEdge | -
Money | -1E0440F1-7ABF-4B9A-863D-177970EEFB5E | -Microsoft.BingFinance_8wekyb3d8bbwe!AppexFinance | -
Movies and TV | -6AFFE59E-0467-4701-851F-7AC026E21665 | -Microsoft.ZuneVideo_8wekyb3d8bbwe!Microsoft.ZuneVideo | -
News | -9C3E8CAD-6702-4842-8F61-B8B33CC9CAF1 | -Microsoft.BingNews_8wekyb3d8bbwe!AppexNews | -
OneDrive | -AD543082-80EC-45BB-AA02-FFE7F4182BA8 | -Microsoft.MicrosoftSkydrive_8wekyb3d8bbwe!App | -
OneNote | -CA05B3AB-F157-450C-8C49-A1F127F5E71D | -Microsoft.Office.OneNote_8wekyb3d8bbwe!microsoft.onenoteim | -
Outlook Calendar | -A558FEBA-85D7-4665-B5D8-A2FF9C19799B |
-Microsoft.WindowsCommunicationsApps_8wekyb3d8bbwe!Microsoft.WindowsLive.Calendar |
-
Outlook Mail | -A558FEBA-85D7-4665-B5D8-A2FF9C19799B |
-Microsoft.WindowsCommunicationsApps_8wekyb3d8bbwe!Microsoft.WindowsLive.Mail |
-
People | -60BE1FB8-3291-4B21-BD39-2221AB166481 | -Microsoft.People_8wekyb3d8bbwe!xb94d6231y84ddy49a8yace3ybc955e769e85x | -
Phone (dialer) | -F41B5D0E-EE94-4F47-9CFE-3D3934C5A2C7 | -Microsoft.CommsPhone_8wekyb3d8bbwe!App | -
Photos | -FCA55E1B-B9A4-4289-882F-084EF4145005 | -Microsoft.Windows.Photos_8wekyb3d8bbwe!App | -
Podcasts | -C3215724-B279-4206-8C3E-61D1A9D63ED3 | -Microsoft.MSPodcast_8wekyb3d8bbwe!xc3215724yb279y4206y8c3ey61d1a9d63ed3x | -
PowerPoint | -B50483C4-8046-4E1B-81BA-590B24935798 | -Microsoft.Office.PowerPoint_8wekyb3d8bbwe!microsoft.pptim | -
Settings | -2A4E62D8-8809-4787-89F8-69D0F01654FB | -2a4e62d8-8809-4787-89f8-69d0f01654fb_8wekyb3d8bbwe!App | -
Skype | -C3F8E570-68B3-4D6A-BDBB-C0A3F4360A51 | -Microsoft.SkypeApp_kzf8qxf38zg5c!Skype.AppId | -
Skype Video | -27E26F40-E031-48A6-B130-D1F20388991A | -Microsoft.Messaging_8wekyb3d8bbwe!App | -
Sports | -0F4C8C7E-7114-4E1E-A84C-50664DB13B17 | -Microsoft.BingSports_8wekyb3d8bbwe!AppexSports | -
Storage | -5B04B775-356B-4AA0-AAF8-6491FFEA564D | -N/A | -
Store | -7D47D89A-7900-47C5-93F2-46EB6D94C159 | -Microsoft.WindowsStore_8wekyb3d8bbwe!App | -
Voice recorder | -7311B9C5-A4E9-4C74-BC3C-55B06BA95AD0 | -Microsoft.WindowsSoundRecorder_8wekyb3d8bbwe!App | -
Wallet | -587A4577-7868-4745-A29E-F996203F1462 | -Microsoft.MicrosoftWallet_8wekyb3d8bbwe!App | -
Weather | -63C2A117-8604-44E7-8CEF-DF10BE3A57C8 | -Microsoft.BingWeather_8wekyb3d8bbwe!App | -
Windows Feedback | -7604089D-D13F-4A2D-9998-33FC02B63CE3 | -Microsoft.WindowsFeedback_8wekyb3d8bbwe!App | -
Word | -258F115C-48F4-4ADB-9A68-1387E634459B | -Microsoft.Office.Word_8wekyb3d8bbwe!microsoft.word | -
Xbox | -B806836F-EEBE-41C9-8669-19E243B81B83 | -Microsoft.XboxApp_8wekyb3d8bbwe!Microsoft.XboxApp | -
Reserved for future use |
-WIP mandatory settings -Set = 1 -Not set = 0 |
-Reserved for future use |
-AppLocker configured -Yes = 1 -No = 0 |
-WIP on = 1 -WIP off = 0 |
-
4 |
-3 |
-2 |
-1 |
-0 |
-
Name | -Description | -
---|---|
Add | -This is required to precede the Exec command.
-
|
-
Exec | -The Exec node includes the parameters and properties requires to locate, download, validate and perform product installation.
-
|
-
Element | -Description | -
---|---|
MsiInstallJob | -root element
- "Attribute: "id - the application identifier of the application being installed |
-
Product | -child element of MsiInstallJob
- Attribute: “Version” – string representation of application version |
-
Download | -child element of Product. Container for download configuration information. | -
ContentURLList | -child element of Download. Contains list of 1 or more content download URL locators in the form of ContentURL elements. | -
ContentURL | -Location content should be downloaded from. Must be a property formatted URL that points to the .MSI file. | -
Validation | -Contains information used to validate contend authenticity. • FileHash – SHA256 hash value of file content | -
FileHash | -SHA256 hash value of file content | -
Enforcement | -installation properties to be used when installing this MSI | -
CommandLine | -Command-line options to be used when calling MSIEXEC.exe | -
TimeOut | -Amount of time, in minutes that the installation process can run before the installer considers the installation may have failed and no longer monitors the installation operation. | -
RetryCount | -The number of times the download and installation operation will be retried before the installation will be marked as failed. | -
RetryInterval | -Amount of time, in minutes between retry operations. | -
Target | -Per-user MSI | -Per-machine MSI | -Dual mode MSI | -
---|---|---|---|
User | -Install the MSI per-user
- LocURI contains a User prefix, such as ./User |
-Install the MSI per-device
- LocURI contains a Device prefix, such as ./Device |
-Install the MSI per-user
- LocURI contains a User prefix, such as ./User |
-
System | -Install the MSI per-user
- LocURI contains a User prefix, such as ./User |
-Install the MSI per-device
- LocURI contains a Device prefix, such as ./Device |
-Install the MSI per-user
- LocURI contains a User prefix, such as ./User |
-
Target | -Per-user MSI | -Per-machine MSI | -Dual mode MSI | -
---|---|---|---|
User | -Install the MSI per-user
- LocURI contains a User prefix, such as ./User |
-Install the MSI per-device
- LocURI contains a Device prefix, such as ./Device |
-Install the MSI per-user
- LocURI contains a User prefix, such as ./User |
-
System | -Install the MSI per-user
- LocURI contains a User prefix, such as ./User |
-Install the MSI per-device
- LocURI contains a Device prefix, such as ./Device |
-Install the MSI per- system context
- LocURI contains a Device prefix, such as ./Device |
-
Method | -Request URI | -
---|---|
GET |
-https://bspmts.mp.microsoft.com/V1/Inventory?continuationToken={ContinuationToken}&modifiedSince={ModifiedSince}&licenseTypes={LicenseType}&maxResults={MaxResults} |
-
Parameter | -Type | -Default value | -Description | -
---|---|---|---|
continuationToken |
-string |
-Null |
-- |
modifiedSince |
-datetime |
-Null |
-Optional. Used to determine changes since a specific date. |
-
licenseTypes |
-collection of LicenseType |
-{online,offline} |
-Optional. A collection of license types |
-
maxResults |
-integer-32 |
-25 |
-Optional. Specifies the maximum number of applications returned in a single query. |
-
Query type | -Example query | -
---|---|
Online and offline |
-https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=online&licenseTypes=offline&maxResults=25 |
-
Online only |
-https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=online&maxResults=25 |
-
Offline only |
-https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=offline&maxResults=25 |
-
Both license types and a time filter |
-https://bspmts.mp.microsoft.com/V1/Inventory?modifiedSince=2015-07-13T14%3a02%3a25.6863382-07%3a00&licenseTypes=online&licenseTypes=offline&maxResults=25 |
-
Error code | -Description | -Retry | -Data field | -
---|---|---|---|
400 |
-Invalid parameters |
-No |
-Parameter name -Invalid modified date, license, or continuationToken -Details: String |
-
Method | -Request URI | -
---|---|
GET |
-https://bspmts.mp.microsoft.com/V1/Products/{ProductId}/{SkuId}/LocalizedDetails/{language} |
-
Parameter | -Type | -Description | -
---|---|---|
productId |
-string |
-Required. Product identifier for an application that is used by the Store for Business. |
-
skuId |
-string |
-Required. Product identifier that specifies a specific SKU of an application. |
-
language |
-string |
-Required. Language in ISO format, such as en-us, en-ca. |
-
Error code | -Description | -Retry | -Data field | -
---|---|---|---|
400 |
-Invalid parameters |
-No |
-Parameter name -Reason: Missing parameter or invalid parameter -Details: String |
-
404 |
-Not found |
-- | Item type: productId, skuId, language |
-
Method | -Request URI | -
---|---|
POST |
-https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId}/OfflineLicense/{contentId} |
-
Parameter | -Type | -Description | -
---|---|---|
productId |
-string |
-Required. Identifies a specific product that has been acquired. |
-
skuId |
-string |
-Required. The SKU identifier. |
-
contentId |
-string |
-Required. Identifies a specific application. |
-
Error code | -Description | -Retry | -Data field | -
---|---|---|---|
400 |
-Invalid parameters |
-No |
-Parameter name -Reason: Missing parameter or invalid parameter -Details: String |
-
404 |
-Not found |
-- | - |
409 |
-Conflict |
-- | Reason: Not owned, Not offline |
-
Method | -Request URI | -
---|---|
GET |
-https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId} |
-
Parameter | -Type | -Description | -
---|---|---|
productId |
-string |
-Required. Product identifier for an application that is used by the Store for Business. |
-
skuId |
-string |
-Required. Product identifier that specifies a specific SKU of an application. |
-
Error code | -Description | -Retry | -Data field | -
---|---|---|---|
400 |
-Invalid parameters |
-No |
-Parameter name -Reason: Missing parameter or invalid parameter -Details: String |
-
404 |
-Not found |
-- | - |
Method | -Request URI | -
---|---|
GET |
-https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId}/Packages/{packageId} |
-
Parameter | -Type | -Description | -
---|---|---|
productId |
-string |
-Required. Product identifier for an application that is used by the Store for Business. |
-
skuId |
-string |
-Required. Product identifier that specifies a specific SKU of an application. |
-
packageId |
-string |
-Required. |
-
Error code | -Description | -Retry | -Data field | -Details | -
---|---|---|---|---|
400 |
-Invalid parameters |
-No |
-Parameter name -Reason: Invalid parameter -Details: String |
-Can be productId, skuId, or packageId |
-
404 |
-Not found |
-- | - | Item type: Product/SKU |
-
409 |
-Conflict |
-- | Reason: Not owned |
-- |
Method | -Request URI | -
---|---|
GET |
-https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId}/Packages |
-
Parameter | -Type | -Description | -
---|---|---|
productId |
-string |
-Required. Product identifier for an application that is used by the Store for Business. |
-
skuId |
-string |
-Required. Product identifier that specifies a specific SKU of an application. |
-
Error code | -Description | -Retry | -Data field | -
---|---|---|---|
400 |
-Invalid parameters |
-No |
-Parameter name -Reason: Missing parameter or invalid parameter -Details: String |
-
404 |
-Not found |
-- | - |
409 |
-Conflict |
-- | Reason: Not owned |
-
Method | -Request URI | -
---|---|
GET |
-https://bspmts.mp.microsoft.com/V1/Inventory/{productId}/{skuId}/Seats/{username} |
-
Parameter | -Type | -Description | -
---|---|---|
productId |
-string |
-Required. Product identifier for an application that is used by the Store for Business. |
-
skuId |
-string |
-Required. Product identifier that specifies a specific SKU of an application. |
-
username |
-string |
-Requires UserPrincipalName (UPN). User name of the target user account. |
-
Error code | -Description | -Retry | -Data field | -Details | -
---|---|---|---|---|
400 |
-Invalid parameters |
-No |
-Parameter name -Reason: Missing parameter or invalid parameter -Details: String |
-Invalid can include productId, skuId or username |
-
404 |
-Not found |
-- | - | ItemType: Inventory, User, Seat -Values: ProductId/SkuId, UserName, ProductId/SkuId/Username |
-
409 |
-Conflict |
-- | Reason: Not online |
-- |
Method | -Request URI | -
---|---|
GET |
-https://bspmts.mp.microsoft.com/V1/Users/{username}/Seats?continuationToken={ContinuationToken}&maxResults={MaxResults} |
-
Parameter | -Type | -Description | -
---|---|---|
useName |
-string |
-Requires UserPrincipalName (UPN). User name of the target user account. |
-
continuationToken |
-string |
-Optional. |
-
maxResults |
-inteter-32 |
-Optional. Default = 25, Maximum = 100 |
-
Error code | -Description | -Retry | -Data field | -
---|---|---|---|
400 |
-Invalid parameters |
-No |
-Parameter name -Reason: Invalid parameter -Details: String |
-
404 |
-Not found |
-- | Item type: User -Values: UserName |
-