My VMware Air Watch REST API Guide 9 1

User Manual: Pdf

Open the PDF directly: View PDF .
Page Count: 1240 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Chapter 1: Overview
Chapter 2: Security and the API
Chapter 3: Admin User Management
Chapter 4: Application Management
Chapter 5: Content Management
Chapter 6: Device Management
Chapter 7: Enrollment User Management
Chapter 8: Mobile Email Management
- Overview
- Search
Chapter 9: Organization Group Management
Chapter 10: Profile Management Version 1 and Version 2
Chapter 11: Product Management Version 1 and Version 2
Chapter 12: Smart Group Management
Chapter 13: Tag Management
Chapter 14: User Group Management
Chapter 15: Event Notification
Chapter 16: Custom Attribute Management
Chapter 17: List of System and Device Parameters
Finding Additional Documentation

VMware AirWatch REST API Guide

Configuring and Using REST APIs

AirWatch v9.1

Have documentation feedback? Submit a Documentation Feedback support ticket using the Support Wizard on

support.air-watch.com.

international treaties. VMware products are covered by one or more patents listed at http://www.vmware.com/go/patents.

VMware is a registered trademark or trademark of VMware, Inc. in the United States and other jurisdictions. All other marks and names mentioned herein may be trademarks of their

respective companies.

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Revision Table

The following table displays revisions to this guide since the release of AirWatch v9.1.

Date Reason

April 2017 Initial upload. Document posted for AirWatch v9.1 GA.

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Table of Contents

Chapter 1: Overview 16

What's New 17

Introduction 20

Versioning in APIs 21

Refactored APIs 23

Setting Up an API 26

API Authentication 32

Configuring API Access 36

Chapter 2: Security and the API 38

Overview 39

Generating Client Certificates 39

Important API Considerations (Basic Concepts) 42

Chapter 3: Admin User Management 55

Overview 56

Create Console Admin User (Basic) 56

Create Console Admin User (Directory) 61

Retrieve Admin User Details 63

Search Admin User 66

Update Admin User 70

Add Console Admin User Role 73

Remove Console Admin User Role 74

Change Console Admin User Password 75

Delete Console Admin User 76

Chapter 4: Application Management 77

Overview 81

Internal Application Install : Upload Application Chunks (iOS and Android) 81

Upload Blob 85

Download Blob 86

Internal Application Save 87

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Insert Public Application (iOS and Android) 102

Update Public Application (*Refactored) 108

Search Applications 111

Search Play Store for Applications (*Refactored) 124

Search Windows App Store for Applications (*Refactored) 126

Search Apple App Store for Applications (*Refactored) 128

Activate Internal Application 130

Update Internal Application 131

Activate Public Application 141

Deactivate Internal Application 142

Deactivate Public Application 142

Retire Internal Application 143

Unretire Internal Application 143

Assign Smart Group to an Internal Application (*Refactored) 144

Assign Smart Group to a Public Application (*Refactored) 144

Assign Smart Group to BSP Application (Version 2) 144

Remove Smart Group Assignment From an Internal Application (*Refactored) 146

Remove Smart Group Assignment From a Public Application (*Refactored) 146

Install Internal Application on Device 147

Install Public Application on Device 148

Install Purchased Application on the Device 149

Uninstall Internal Application From the Device 150

Uninstall Public Application From the Device 151

Uninstall Purchased Application From the Device 152

View Internal Application Status on the Device 153

View Public Application Status on the Device 154

View Purchased Application Status on Device 155

Retrieve Application Details 156

Get Application Management Status (*Refactored) 159

Retrieve Assigned Devices (Internal Application) (*Refactored) 160

Retrieve Assigned Devices (Public Application) (*Refactored) 162

Retrieve Assigned Devices With Purchased Application (*Refactored) 164

Retrieve Installed Devices (Internal Application) (*Refactored) 166

Retrieve Installed Devices (Public Application) (*Refactored) 168

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Installed Devices With Purchased Application (*Refactored) 170

Retrieve Devices with Internal Application Installed or Assigned 172

Retrieve Devices with Public Application Installed or Assigned 174

Retrieve Devices with Purchased Application Installed or Assigned 176

Delete Internal Application 178

Delete Public Application 178

Add Assignments to Internal Application 179

Edit Assignment of Internal Application 181

Delete Application Assignment From Smart Group 183

Retrieve Internal Application Details 184

Create Application Group (*Refactored) 198

Retrieve Application Group Details 203

Search Application Group (*Refactored) 206

Search SDK Analytics 210

Update Application Group (*Refactored) 213

Delete Application Group (*Refactored) 216

Add Application to an Application Group (*Refactored) 218

Delete Application from the Application Group (*Refactored) 219

Create VPP Application Allocation (*Refactored) 220

Delete VPP Application 222

Delete VPP Application Smart Group Assignment (*Refactored) 222

Search VPP Application (*Refactored) 223

Get VPP Allocation Details 227

Update VPP Licensed Application Assignment (*Refactored) 230

Queues Sync Assets for VPP Applications 233

Resets the Client Context 234

Get VPP Sync Assets Status 235

Enable Device Based Assignment For VPP Applications 236

Update Application on Devices Having Device Based Licenses 236

Auto Update Flag for Device based VPP App 236

Get VPP Invite Status (*Refactored) 238

Send Bulk VPP Invite (*Refactored) 239

Retrieve Windows App Dependency 241

Retrieve List of Windows App Dependency Files 249

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Windows Dependency Application 251

Search and Retrieve Removal Logs for Internal Applications 252

Update Removal Logs 254

Chapter 5: Content Management 256

Overview 258

Personal Content Overview 258

Retrieve List of Files and Folders 259

Move Files to Target Folder 263

Delete a File 267

Retrieve File Metadata 268

Share Content 271

Download File 273

Remove File Sharing 274

Get File Sharing Information 275

Update File Metadata Information 277

Upload Content/Files 282

Explicit Upload Initialize 286

Explicit Upload Finalize 288

Retrieve Folder Information 291

Create Folder 294

Update Folder 298

Move Folder 302

Delete Folder 306

Return Sharing Metadata 307

Retrieve Collaborator List 309

Remove Sharing 311

Share Folder with Users or UserGroups 312

Update Collaborator 316

Remove Sharing on Collaborator Folder 320

Update Collaborator of Shared Folder 322

Retrieve Admin Storage Information 326

Managed Content Overview 327

Retrieve All Categories 328

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Create New Category 330

Delete Category 332

Update Category 333

Upload AirWatch Managed Content 335

Download AirWatch Managed Content 340

Delete AirWatch Managed Content 341

Retrieve AirWatch Managed Content 342

Update AirWatch Managed Content 347

Retrieve List of AirWatch Managed Content 354

Chapter 6: Device Management 358

Overview 361

Retrieve Application Details From the Device 361

Retrieve Admin Application Details 364

Retrieve Device Bulk Settings 366

Retrieve Certificate Details From the Device 368

Retrieve Compliance Details of the Device 370

Retrieve Compliance Attributes 372

Save Compliance Attributes for a List of Devices 374

Retrieve Content Details of the Device 377

Retrieve Device Information 379

Retrieve Bulk Device Information 383

Retrieve Device Application Status 388

Retrieve Event Logs From the Device 390

Retrieve GPS Co-ordinates of the Device 393

Retrieve Bulk GPS Co-ordinates From the Device 395

Execute Bulk GPS Coordinates 398

Retrieve Network Information of the Device 400

Retrieve Profile Details of the Device 404

Retrieve Enrollment User Details of the Device 407

Retrieve Enrolled Device Count 409

Retrieve Smart Group details 411

Retrieve Device Associated Smart Groups 415

Retrieve Security Information 417

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Change Device Passcode (*Refactored) 419

Clear Passcode on the Device (*Refactored) 420

Enterprise Wipe a Device (*Refactored) 421

Enterprise Wipe in Bulk (*Refactored) 422

Find Device (*Refactored) 424

Lock Device (*Refactored) 426

Lock Devices in Bulk (*Refactored) 427

Query Device (*Refactored) 430

Device Wipe (*Refactored) 431

Delete Device 432

Delete Devices in Bulk (*Refactored) 433

Sync Device (*Refactored) 436

Send Email to the Device Enrollment User (*Refactored) 437

Send Email in Bulk (*Refactored) 439

Send SMS to the Device (*Refactored) 441

Send SMS in Bulk (*Refactored) 443

Send Push Message to the Device (*Refactored) 445

Bulk Push Message to the Devices (*Refactored) 447

Push Notification (*Refactored) 449

Execute Device Commands 451

Execute Bulk Device Commands 452

Schedule OS Update Command 454

Bulk Schedule OS Update Command 455

Start Airplay 458

Send Remote Control Action Command (*Refactored) 460

Add Note to the Device (*Refactored) 461

Delete Note From the Device 463

Retrieve Notes From the Device 464

Retrieve a Specific Note From the Device 466

Update Note onto the Device (*Refactored) 468

Search Device Details 470

Search Compliance Policy 477

Device Extensive Search 480

Search Security Information 484

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Network Information 486

Device Extensive Search (Lite) 488

Custom Attribute Search 491

Search Changes Made To Custom Attribute 493

Update Device Custom Attribute (*Refactored) 495

Delete Custom Attribute (*Refactored) 498

Edit Device Details 501

Managed Settings 503

Change Device Organization Group 504

Create Offline Device Record 505

Create Relay Server 506

Create Relay Servers in Bulk 510

Delete Relay Server 516

Retrieve Relay Server Details 517

Update Relay Server 521

Create Staging Bundle 525

Delete Staging Bundle 528

Retrieve Staging Bundle 529

Update Staging Bundle 532

Retrieve Printer Details Using Identifier 534

Retrieve Printer Details Using Location Group 536

Chapter 7: Enrollment User Management 543

Overview 545

Add Enrollment User (Basic) 545

Add Enrollment User (Directory) 550

Retrieve Enrollment User's Details 553

Update Enrollment User's Details 556

Delete List of Enrollment Users 558

Delete Specified Enrollment User 560

Bulk Delete Enrollment Users 561

Search Enrollment Users 563

Search Enrolled Device 566

Search Device Enrollment Token 570

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Registered Device 578

Delete Registered Devices 581

Change Organization Group of an Enrollment User 584

Activate an Enrollment User 585

Bulk Activate Enrollment Users 586

Deactivate an Enrollment User 588

Bulk Deactivate Enrollment Users 589

Upload S/MIME Certificates to an Enrollment User 591

Create Custom Attribute 593

Update Custom Attribute 596

Delete Custom Attribute 599

Retrieve Authenticated Enrollment User Information 602

Retrieve AirWatch Version and API URLs 605

Chapter 8: Mobile Email Management 607

Overview 608

Search 608

Chapter 9: Organization Group Management 610

Create Organization Group (*Refactored) 612

Update Organization Group Details (*Refactored) 619

Fetch Organization Group's Details 622

Fetch Child Organization Group's Details (*Refactored) 624

Search Organization Group 626

Delete Organization Group (*Refactored) 629

Fetch Admin User Details in an Organization Group (*Refactored) 631

Fetch Enrollment Users in an Organization Group (*Refactored) 634

Fetch Admin User Roles From an Organization Group 637

Add Device Tag to an Organization Group (*Refactored) 639

Update Device Tag Details (*Refactored) 642

Retrieve Details of All Tags 645

Retrieve Specific Device Tag Details 646

Delete Device Tag From an Organization Group 647

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Device Count 648

Storage: Retrieve Storage Values (Application and Content) 651

Sampling Rates: Retrieve Sampling Rates (*Refactored) 653

Get Custom Attribute 656

Create APNs Cert Request 658

Retrieve Status of APNs Configuration 660

Update APNs Configuration 662

Save APNs Configuration 663

Create Express Licenses 665

Query for Pinned Host By HostGuid 667

Update Pinned Host 668

Pin Certificate to a Pinned Host 669

Unpin Certificate from a Pinned Host 670

Enable SSL Pinning 671

Disable SSL Pinning 671

Synchronize Pin with Auto Discovery 672

Enable Pin Relation 673

Disable Pin Relation 673

Chapter 10: Profile Management Version 1 and Version 2 674

Overview 676

General Profile (Common for all Device Platforms) 677

Retrieve Payload Keys for Creating a Profile 685

Update Apple Device Profile 687

Update Android Device Profile 691

Create Apple Passcode Profile 695

Create Apple Restrictions Profile 702

Create Apple Wi-Fi Profile 722

Create Apple VPN Profile 734

Create Apple Email Profile 744

Create Apple EAS Profiles 752

Upload Certificates 785

Create Apple SCEP Profile 787

Create Apple Credentials Profile 793

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Create Apple Custom Settings Profile 799

Create Android Passcode Profile 803

Create Android Restrictions Profile 811

Create Android Wi-Fi Profile 836

Create Android VPN Profile 843

Create Android Email Profile 849

Create Android EAS Profile 858

Create Android Credentials Profile 884

Create Android For Work Profile 894

Create Android Container Profile 939

Create AppleOsX Device Profile 951

Update AppleOsX Device Profile 980

Create QNX Device Profile 1008

Update QNX Device Profile 1010

Create Windows PC Device Profile 1012

Update Windows PC Device Profile 1020

Get Device Profile Details 1028

Activate Device Profile 1030

Deactivate Device Profile 1032

Install Device Profile 1034

Remove Device Profile 1037

Search Device Profile 1040

Delete Device Profile 1046

Get Resource 1048

Get Resource Keys and Advanced Settings 1050

Create Resource of Requested Type 1051

Delete Resource 1052

Update Requested Resource 1053

Edit Smart Group Assignment for Resource 1054

Chapter 11: Product Management Version 1 and Version 2 1056

Overview 1058

Activate Product 1058

Deactivate Product 1059

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Product Conditions Functionality 1060

Copy Product 1063

Create Product 1065

Delete Product 1068

Get Provisioning Assigned Devices 1069

Get Product Compliant Devices 1072

Get Provisioning Failed Devices 1076

Get Provisioning In-Progress Devices 1078

Get Product ID 1080

Get Files/Action 1084

Get Product Profiles 1088

Get Product Time Condition 1099

Insert Device 1102

Search Product Condition 1103

Product Health Check 1105

Extensive Product Search 1108

Search Files/Actions 1112

Product Download and Install Statistics 1116

Search Product 1119

Search Product Time Condition 1123

Search File Condition 1125

Add Smart Group to Product 1127

Remove Smart Group from Product 1128

Update Product 1129

Get Product Details 1131

Reprocess Product 1132

Retrieve Job status Change 1134

Activate Productset 1138

Add Product in Productset 1138

Create Product in Productset 1143

Deactivate Productset 1147

Delete Product From Productsets 1148

Push Productset to Policy Engine 1149

Rank All Products in a Productset 1150

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Productset 1152

Chapter 12: Smart Group Management 1153

Overview 1154

Create Smart Group (*Refactored) 1154

Get Smart Group details 1158

Get Device Details in the Smart Group 1162

Search Smart Groups 1164

Update Smart Group (*Refactored) 1167

Delete Smart Group (*Refactored) 1172

Get List of Apps Assigned to Smart Group 1173

Chapter 13: Tag Management 1175

Overview 1176

Create Tag 1176

Retrieve Devices with Specific Tag 1178

Search Tag 1180

Update Tag 1182

Add Devices to the Tag 1183

Remove Devices from Tag 1185

Delete Tag 1187

Chapter 14: User Group Management 1188

Overview 1189

Create Custom User Group 1189

Add Enrollment User To a Custom User Group 1191

Remove an Enrollment User From the Custom User Group 1192

Get User group 1193

Search User Group 1195

Delete User Group 1197

Retrieve List of Notifications 1198

Retrieve Notifications Count 1200

Chapter 15: Event Notification 1201

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Overview 1202

Create Event Notification 1202

Delete Event Notification 1206

Retrieve Event Notification 1207

Search Event Notification 1210

Update Event Notification 1214

Chapter 16: Custom Attribute Management 1217

Overview 1218

Create Custom Attributes 1218

Search Custom Attribute 1220

Chapter 17: List of System and Device Parameters 1222

Finding Additional Documentation 1239

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Chapter 1:

Overview

What's New 17

Introduction 20

Versioning in APIs 21

Refactored APIs 23

Setting Up an API 26

API Authentication 32

Configuring API Access 36

VMware AirWatch REST API Guide | v.2016.04 | April 2017

What's New

This guide is updated with the latest APIs and their functionalities from the most recent release of AirWatch v9.1. The

tables below list the new APIs and links to the pages on which they appear.

List of Version 1 APIs

Mobile Application Management

API Name API URI

Auto Update Flag for Device

based VPP App

https://host/api/mam/apps/purchased/{appId}

Delete Windows Dependency

Application

https://host/api/mam/apps/internal/windowsappdependency/

{windowsAppDependencyId}

Retrieve List of Windows App

Dependency Files

https://host/api/mam/apps/internal/windowsappdependencies/

{organizationGroupId}

Retrieve Windows App

Dependency

https://host/api/mam/apps/internal/windowsappdependency/

{windowsAppDependencyId}

Search and Retrieve Removal

Logs for Internal Applications

https://host/api/mam/apps/removallogs?organizationgroupid=

{organizationgroupid}&bundleid={bundleid}&status={status}&page=

{page}&pagesize={pagesize}&orderby={orderby}

Update Application on Devices

Having Device Based Licenses

https://host/api/mam/apps/purchased/{appId}

Update Internal Application https://host/api/mam/apps/internal/{applicationId}

Update Removal Logs https://host/api/mam/apps/removallogs?organizationgroupid=

{organizationgroupid}

Mobile Device Management

API Name API URI

Create Relay

Server

https://host/api/mdm/relayservers

Create Relay

Servers in Bulk

https://host/api/mdm/relayservers/bulk

Create Staging

Bundle

https://host/api/mdm/staging

Delete Relay

Server

https://host/api/mdm/relayservers/{serverId}

Delete Staging

Bundle

https://host/api/mdm/staging/{stagingId}

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve
Compliance
Attributes
https://host/api/mdm/complianceattributes/organizationgroupcomplianceattributes?vendorname=
{vendorname}
Retrieve Device
Application
Status
https://host/api/mdm/devices/appstatus?searchby={searchBy}&id={id}&groupid=
{groupid}&bundleId={bundleId}&version={version}&deviceType={deviceType}
Retrieve
Printer Details
Using Identifier
https://host/api/mdm/peripherals/printer/{deviceID}
Retrieve
Printer Details
Using Location
Group
https://host/api/mdm/peripherals/printers/{locationGroupID}
Retrieve Relay
Server Details
https://host/api/mdm/relayservers/{serverId}
Retrieve Device
Associated
Smart Groups
https://host/api/mdm/devices/{id}/smartgroups
Retrieve
Staging Bundle
https://host/api/mdm/staging/{stagingId}
Save
Compliance
Attributes for a
List of Devices
https://host/api/mdm/complianceattributes/devicecomplianceattributes
Update Relay
Server
https://host/api/mdm/relayservers
Update Staging
Bundle
https://host/api/mdm/staging
Organization Group Management
API Name API URI
Create APNs Cert Request https://host/api/system/groups/{id}/apns?force={force}
Create Express Licenses https://host/api/system/expresslicenses
Disable Pin Relation https://host/api/system/disablepin/{hostGuid}/{organizationgroupid}
Disable SSL Pinning https://host/api/system/disable/{organizationgroupid}
Enable Pin Relation https://host/api/system/enablepin/{hostGuid}/{organizationgroupid}
Enable SSL Pinning https://host/api/system/enable/{organizationgroupid}
Pin Certificate to a Pinned Host https://host/api/system/pincertificate
Chapter 1: Overview
18
VMware AirWatch REST API Guide | v.2016.04 | April 2017
Copyright © 2017 VMware, Inc. All rights reserved. Proprietary & Confidential.

Query for Pinned Host By Host

Name

https://host/api/system/pinnedhosts/{hostName}?organizationgroupid=

{organizationgroupid}

Query for Pinned Host By

HostGuid

https://host/api/system/pinnedhost/{hostGuid}

Retrieve Status of APNs

Configuration

https://host/api/system/groups/{id}/apns/details

Save APNs Configuration https://host/api/system/groups/{id}/apns

Synchronize Pin with Auto

Discovery

https://host/api/system/syncwithautodiscovery/{organizationgroupid}

Unpin Certificate from a Pinned

Host

https://host/api/system/unpincertificate

Update APNs Configuration https://host/api/system/groups/{id}/apns

Update Pinned Host https://host/api/system/pinnedhost/{hostGuid}

User Group Management

API Name API URI

Retrieve Notifications Count https://host/api/system/notifications/count

Retrieve List of Notifications https://host/api/system/notifications?startIndex={startIndex}&pageSize=

{pageSize}&active={active}&cultureCode={cultureCode}

List of Version 2 New APIs

Application ManagementVersion 2

API Name API URI

Assign Smart Group to BSP

Application

https://host/api/mam/apps/public/

{applicationid}/bspsmartgroups?offlinesmartgroupid=

{offlinesmartgroupid}?&onlinesmartgroupid={onlinesmartgroupid}&type={type}

Profiles ManagementVersion 2

API Name API URI

Create Windows PC Device

Profile

https://host/api/mdm/profiles/platforms/windowspc/create

Update Windows PC Device

Profile

https://host/api/mdm/profiles/platforms/windowspc/update

Organization Group Management

API Name API URI

Create Organization Group https://host/api/system/groups/{id}

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Introduction

AirWatch provides a collection of RESTful APIs that allow external programs to use the core product functionality by

integrating the APIs with existing IT infrastructures and third-party applications. Leveraging the simplified REST style of

software architecture, AirWatch REST APIs currently include Organization Group Management, Console Administration,

Mobile Application Management, Mobile Device Management, Mobile Email Management, Enrollment User

Management, Profile Management, Smart Group Management, and User Group Management functionalities.

Leveraging REST-based APIs provide several benefits to enterprises, including eliminated cost and time spent developing

applications in-house. AirWatch REST APIs are fully able and ready to integrate with enterprise servers, programs, and

processes. Additionally, AirWatch RESTAPIs are more efficient, can run smoothly and an be easily branded with

enterprises.

This guide is intended for application developers and provides an understanding of the design and architecture of the

Version 1 and Version 2 REST APIs library to facilitate custom development and integration with AirWatch.

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Versioning in APIs

Overview

The introduction of Smart Group assignment to Profiles necessitated the creation of a new APIs (Version 2) in addition to

the existing APIs (Version 1) to maintain backward compatibility. From 7.3 release onwards, you can assign profiles to the

devices from the AirWatch Console using SmartGroups. Thus, AirWatch has introduced Version 2 REST APIs to utilize the

SmartGroup assignment feature and recommends you to use these APIs henceforth.

For example, the V1 and V2 API format to Create Apple Passcode Profile is shown below:

Version 1 API: https://host/api/v1/mdm/profiles/platforms/apple/create

Version 2 API: https://host/api/v2/mdm/profiles/platforms/apple/create

The table below lists down the supported Version 1 and Version 2 API collections:

Version 1 REST APIs Version 2 REST APIs

Console Admin User APIs Profile Management APIs

Mobile Application Management APIs Product Management APIs

Mobile Device Management APIs

Mobile Content Management APIs

Mobile Email Management APIs

Device Enrollment User APIs

Organization Group APIs

Smart Group Management APIs

User Group Management APIs

Profile Management APIs

Product Management APIs

Tag APIs

Custom Attribute APIs

Event Notification APIs

Version Remotion

In 8.3 version, AirWatch has modified the look of the API URIs by removing the version specification from them. For

example: Assign Smart Group to a Public Application.

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Deprecated API URI – https://host/API/v1/mam/apps/public/

{ApplicationId}/addsmartgroup/{SmartgroupId}

New API URI – https://host/api/mam/apps/public/{applicationid}/smartgroup/

{smartgroupid}

However, the V1 and V2 APIs can be fetched by adding the version details in the Accept header. Thus a single API URI

serves the purpose of retrieving both Version 1 and Version 2 APIendpoints based on the Accept header version details.

Below are Accept header format to retrieve V1 and V2 APIs.

lTo retrieve Version 1 APIs, use:

Accept=application/json;version=1

Accept=application/xml;version=1

lTo retrieve Version 2 APIs, use:

Accept=application/json;version=2

Accept=application/xml;version=2

Additional Information

With Version 2 RESTAPIs, there is only one observable change in the work flow process in Profile management. See the

table below to understand the difference between Version 1 and Version 2 profile management work flow:

Version 1 Version 2

Create Profile (Assignment filters provided in

General Payload) > Install Profile on devices.

Create Smart Group > Create Profile (With the Smart Group details

provided in General Payload) > Install Profile on devices.

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Refactored APIs

There are few API endpoints whose URIs have been refactored or modified. This modification does NOT affect any

existing work flows that you are using till date. However, AirWatch recommends you to move to newly Refactored APIs as

soon as possible since the old format will be deprecated in future.

Important Note: At this time, there is no specific date to share when the old formats will be deprecated. When

deprecation is determined, official communication will be sent out.

The table lists the refactored APIs and the links to the pages on which they appear.

APIName APIURI

Mobile Application Management

Update Public Application https://host/api/mam/apps/public/applicationid

Search Play Store for Applications https://host/api/mam/apps/playstore/search

Search Windows App Store for

Applications

https://host/api/mam/apps/windowsstore/search

Search Apple App Store for

Applications

https://host/api/mam/apps/applestore/search

Assign Smart Group to an Internal

Application

https://host/api/mam/apps/internal/{applicationid}/smartgroups/

{smartgroupid}

Assign Smart Group to a Public

Application

https://host/api/mam/apps/public/{applicationid}/smartgroups/

{smartgroupid}

Remove Smart Group Assignment

From an Internal Application

https://host/api/mam/apps/internal/{applicationid}/smartgroups/

{smartgroupid}

Remove Smart Group Assignment

From a Public Application

https://host/api/mam/apps/public/{applicationid}/smartgroups/

{smartgroupid}

Get Application Management Status https://host/api/mam/apps/managementstatus

Retrieve Assigned Devices (Internal

Application)

https://host/api/mam/apps/internal/applicationid/devices

Retrieve Assigned Devices (Public

Application)

https://host/api/mam/apps/public/applicationid/devices

Retrieve Assigned Devices With

Purchased Application

https://host/api/mam/purchased/applicationid/devices

Retrieve Installed Devices (Internal

Application)

https://host/api/mam/apps/internal/applicationid/devices

Retrieve Installed Devices (Public

Application)

https://host/api/mam/apps/public/applicationid/devices

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Installed Devices With
Purchased Application
https://host/api/mam/purchased/applicationid/devices
Create Application Group https://host/api/mam/apps/appgroups
Search Application Group https://host/api/mam/apps/appgroups/search
Update Application Group https://host/api/mam/apps/appgroups/appgroupid
Delete Application Group https://host/api/mam/apps/appgroups
Add Application to an Application
Group
https://host/api/mam/apps/appgroups/appgroupid/applications
Delete Application from the
Application Group
https://host/api/mam/apps/appgroups/appgroupid/applications
Create VPP Application Allocation https://host/api/mam/apps/purchased/applicationid/assignment
Delete VPP Application Smart Group
Assignment
https://host/api/mam/apps/purchased/{applicationid}/smartgroups/
{smartgroupid}
Search VPP Application https://host/api/mam/apps/purchased/search
Update VPP Licensed Application
Assignment
https://host/api/mam/apps/purchased/applicationid
Get VPP Invite Status https://host/api/mam/apps/purchased/applicationid/vppinvitestatus/deviceid
Send Bulk VPP Invite https://host/api/mam/apps/purchased/applicationid/vppinvite
Mobile Device Management
Change Device Passcode https://host/api/mdm/devices/commands/id/changepasscode
Clear Passcode on the Device https://host/api/mdm/devices/{deviceid}/commands
Enterprise Wipe a Device https://host/api/mdm/devices/deviceid/commands
Enterprise Wipe in Bulk https://host/api/mdm/devices/commands/enterprisewipe
Find Device https://host/api/mdm/devices/deviceid/commands/finddevice
Lock Device https://host/api/mdm/devices/deviceid/commands
Lock Devices in Bulk https://host/api/mdm/devices/{deviceid}/commands
Query Device https://host/api/mdm/devices/deviceid/commands
Device Wipe https://host/api/mdm/devices/deviceid/commands
Delete Devices in Bulk https://host/api/mdm/devices/bulk?searchby={searchby}
Sync Device https://host/api/mdm/devices/deviceid/commands
Send Email to the Device Enrollment
User
https://host/api/mdm/devices/{id}/messages/email
Send Email in Bulk https://host/api/mdm/devices/messages/bulkemail?searchby={searchby}
Send SMS to the Device https://host/api/mdm/devices/id/messages/sms
Send SMS in Bulk https://host/api/mdm/devices/messages/bulksms?searchby=deviceid
Chapter 1: Overview
24
VMware AirWatch REST API Guide | v.2016.04 | April 2017
Copyright © 2017 VMware, Inc. All rights reserved. Proprietary & Confidential.

Send Push Message to the Device https://host/api/mdm/devices/messages/commands/id/message

Bulk Push Message to the Devices https://host/api/mdm/devices/messages/bulkpush?searchby={searchby}

Push Notification https://host/api/mdm/devices/messages/{id}/message

Send Remote Control Action

Command

https://host/api/mdm/devices/commands/remotecontrol

Update Note onto the Device https://host/api/mdm/devices/{deviceId}/notes/{noteid}

Update Device Custom Attribute https://host/api/mdm/devices/{id}/customattributes

Delete Custom Attribute https://host/api/mdm/devices/{id}/customattributes

Organization Group Management

Create Organization Group https://host/api/system/groups/id

Update Organization Group Details https://host/api/system/groups/{id}

Fetch Child Organization Group's

Details

https://host/api/system/groups/{id}/children

Delete Organization Group https://host/api/system/groups/{id}

Fetch Admin User Details in an

Organization Group

https://host/api/system/groups/{id}/admins

Fetch Enrollment Users in an

Organization Group

https://host/api/system/groups/{id}/users

Add Device Tag to an Organization

Group

https://host/api/system/groups/{id}/tags

Update Device Tag Details https://host/api/system/groups/{ogid}/tags/{tagid}

Sampling Rates: Retrieve Sampling

Rates

https://host/api/system/groups/{id}/samplerates?platform={platform}

Smart Group Management

Create Smart Group https://host/api/mdm/smartgroups

Update Smart Group https://host/api/mdm/smartgroups/{id}

Delete Smart Group https://host/api/mdm/smartgroups/{id}

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Setting Up an API

APIs require authentication to integrate with AirWatch. For information on authentication methods, refer

Authentication. Prior to authentication, API access must be enabled in the AirWatch Console System Configuration by

selecting the Enable API Access checkbox.

Important Note: AirWatch REST APIs can be enabled only at Customer type organization group, Partner type

organization group, and Global organization group.

Enabling the API access

1. From the AirWatch Console main menu, navigate to Groups &Settings > All Settings > System > Advanced > API >

RESTAPI.

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

2. On the General tab, configure the following settings.

Setting Description

Enable APIAccess Select this check box to automatically generate the APIkey for the Organization Group.

Add Select Add to add/or generate multiple APIkeys.

lService – Enter one or multiple service(s) and generate their own independent API

keys.

lAccount Type – Select the type of the account. To access Personal Content APIs

(MCM APIs), select the Account type as Enrollment User.

lDescription – Enter short description for the service and generated API key.

lWhitelisted Domains – Enter domains that can interact with AirWatch APIs via API

key.

3. On the Authentication tab, configure the following setting.

Setting Description

Authentication Select Authentication as Basic,Certificates or Directory.

For more information, refer to Configuring APIAccess.

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

4. On the Advanced tab, configure the following settings. These settings are only accessible at the Global Organization

level. Enter the default service throttling and daily quota and set the maximum and minimum values for each field as

shown below.

Field Name Default values Validations

Service Throttling 5000 Min 1 calls

Max 25000 calls

0 or empty turns off service throttling

Daily Quota 50000 Min 1

Max 2147485647

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Enabling Personal Content API Access

AirWatch REST APIs enable your end-users to manage their Personal Content with features such as adding, moving,

sharing, and deleting Files and Folders. Follow the below steps to make the most of this functionality:

1. From the AirWatch Console main menu, navigate to Groups &Settings > All Settings > System > Advanced > API >

RESTAPI.

2. On the General tab, configure the following settings.

Setting Description

Enable

APIAccess

Select this check box to automatically generate the APIkey for the Organization Group.

Add Select Add to add/or generate multiple APIkeys.

lService – Enter one or multiple service(s) and generate their own independent API keys.

lAccount Type – Select the type of the account. Select Account type as Enrollment User to

access Personal Content APIs or Admin to access Managed Content APIs.

lDescription – Enter short description for the service and generated API key.

lWhitelisted Domains – Enter domains that can interact with AirWatch APIs via API key.

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

3. Navigate to Groups and Settings > All Settings > Content > Personal Content. Set Personal Content to Enabled to

enable Personal Content at your organization group.

4. Enable applicable Shared Links settings to use sharing file link functionality.

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

5. Enable applicable Shared Folder settings to use sharing folders functionality.

For more information on Enabling and Configuring Personal Content, refer Mobile Content Management Guide in the

AirWatch Resource.

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

API Authentication

API requires authentication to integrate with AirWatch. AirWatch offers the following types of authentication methods to

the specific users.

Authentication Methods

APIs support the following methods of authentication to the users:

lBasic Authentication – Basic Authentication can be utilized by any AirWatch architecture, but offers no integration to

existing corporate user accounts.

lDirectory Authentication – Directory Authentication utilizes Directory Services to integrate user and admin accounts

of AirWatch with existing corporate accounts.

lCertificate Authentication – Certificate based authentication provides API access using a self-signed certificate

generated for Admin users of the AirWatch Console.

Types of Authentication Users

APIs support the following users to integrate with AirWatch:

lConsole Admin Users or Core Users – Uses Basic , Directory, or Certificate Authentication methods.

lDevice Enrollment Users – Uses Basic and Directory Authentication methods. This method of authentication used by

Enrollment users is called Enrollment User Authentication. From 8.3 version, this is available only for Personal

Content users.

Authorization Header for Basic Authentication

The only difference in using Basic authentication method by Console Admin User and Device Enrollment user is the

information passed in the authorization header. The authorization header should hold the value in the following example

format:

For Console Admin User

GET https://host/api/mdm/devices/bulksettings HTTP/1.1

User-Agent: Fiddler

aw-tenant-code: 1FC5H4JAAAG5A4SQAMQA

Host – host.com

Authorization – Basic bW9oYW46bW9oYW4=

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

For Device Enrollment User

GET https://host/api/mcm/contents/folders HTTP/1.1

User-Agent: Fiddler

aw-tenant-code: 1FC5H4JAAAG5A4SQAMQA

Host – host.com

Authorization – Basic bW9oYW46bW9oYW4=

aw-groupid – xyz

accept – application/json

Authorization Header for Certificate Authentication

A method of authenticating the APIs using the incoming requests with the detached signatures (Message signing;

Detached Signature Format). Message signing also works with SSL offloading, wherein you can verify the sender's

authentication using the message headers. The detached signature should be present under the HTTP header

authorization. The authorization header should hold the value in the following format:

If the part <AUTHENTICATIONSCHEME>`<VERSION> is not present on the header, the default scheme becomes

verification of client certificate based CMS (Cryptographic Message Syntax) signing. For more information on CMS, see

the below Authentication Schemes section.

Authentication Schemes

Currently, AirWatch supports two types of authentication schemes in the detached signature authentication: CMS and

CMSURL. Each requires its own process for defining the version of authentication/signing scheme used.

CMS

CMS scheme expects the signature against the message content. In this case the format of the authorization header is as

follows:

lAuthorization:CMS’<Version> <CREDENTIALS>

o< Version > information.

o< CREDENTIALS > is the Base64 Encoded data of “message content” signed with client certificate using PKCS9

signing.

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

CMSURL

CMSURL expects the signature against the application path in the URL. In this case the format of the authorization header

is as follows:

lAuthorization:CMSURL’<Version> <CREDENTIALS>

o< Version > information.

o< CREDENTIALS > is the Base64 Encoded data of “canonical URI resource encoded using UTF-8 format” signed

with client certificate using PKCS9 signing.

Sample code for calling the APIs with CMSURL authorization is shown below.

using System.Security.Cryptography.X509Certificates;

using System.Text;

namespace CMSURLSample

{

class Program

{

static void Main(string[] args)

{

string cmsMethod = "CMSURL";

string url = @"https://host/api/system/groups/1232";

var uri = new Uri(url);

string clientCertificatePath = @"C:\certificates\cert.p12";

string clientCertificatePassword = "test";

//Create X509Certificate from the client certificate provided

var certificate = new X509Certificate2(clientCertificatePath,

clientCertificatePassword, X509KeyStorageFlags.PersistKeySet);

Byte[] signingData;

signingData = Encoding.UTF8.GetBytes(uri.AbsolutePath);// Use the

absolute path of the URL for signing

// Create a detached digital signature for the message data.

var signedCms = new SignedCms(new ContentInfo(signingData),

detached: true);

var signer = new CmsSigner(certificate) { IncludeOption =

X509IncludeOption.EndCertOnly };

signer.SignedAttributes.Add(new Pkcs9SigningTime());

signedCms.ComputeSignature(signer); // Compute the signature

Byte[] signature = signedCms.Encode();

string cmsHeader = cmsMethod + "`1" + " " +

Convert.ToBase64String(signature); // cmsHeader need to be copied

to the Authorization HTTP Header for authentication

}

Note: Schemes (cms and cmsurl) are not case sensitive.

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Canonical URL

CanonicalURL resource is computed as follows:

lIf URL is https://host/api/mdm/devices/4/send-message?to=4043671422%25text=hello, canonical URL should be

computed as /api/mdm/devices/4/send-message

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Configuring API Access

Now that the API authentication is enabled, the next step is to configure an administrator account for authentication

against the API end points. Typically, this should be a separate service accounts that is only used for API authentication

rather than a current administrator's account. The available options for authentication are Basic, Directory, and

Certificates. The API Authentication is available only when API access is enabled.

Once the administrator's API authentication type is configured, provision Roles to the administrator with specific API

privileges. You can directly control the administrator’s access by creating a new role or editing an existing role.

Use the following steps to create or edit service account administrator roles:

1. Navigate to Accounts > Administrators > Roles.

2. Select any role displayed to edit it or click Add Role to create a new one.

3. Select Save. The new updated role is available to assign to administrators.

RESTAPIMDM – Devices

REST API Devices Read Enables access to all READ only APIs in Devices collection

REST API Devices Write Enables access to all write and update APIs in Devices collection

REST API Devices Execute Enables access to all Execute APIs in Devices collection

REST API Devices Delete Enables access to all Delete APIs in Devices collection

REST API Devices Advanced Enables access to all Advanced APIs in Devices collection. This role is required for device

wipe and enterprise wipe.

RESTAPIMAM – Apps

REST API MAM Read Enables access to all READ only APIs in Apps collection

REST API MAM Write Enables access to all write and update APIs in Apps collection

REST API MAM Execute Enables access to all execute APIs in Apps collection

REST API MAM Delete Enables access to all Delete APIs in Apps collection

RESTAPISystem – Groups

REST API System Groups Read Enables access to all READ only APIs in Organization Group collection

REST API System Groups

Write Enables access to all write and update APIs in Organization Group collection

REST API System Groups

Execute Enables access to all execute APIs in Organization Group collection

REST API System Groups

Delete Enables access to all Delete APIs in Organization Group collection

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

RESTAPISystem – Admins

REST API System Admins Read Enables access to all READ only APIs in Admin users collection

REST API System Admins Write Enables access to all write and update APIs in Admin users collection

REST API System Admins

Execute Enables access to all execute APIs in Admin users collection

REST API System Admins Delete Enables access to all Delete APIs in Admin users collection

RESTAPISystem – Users

REST API Users Read Enables access to all READ only APIs in Enrollment users collection

REST API Users Write Enables access to all write and update APIs in Enrollment users collection

REST API Users Execute Enables access to all execute APIs in Enrollment users collection

REST API Users Delete Enables access to all Delete APIs in Enrollment users collection

REST API User Token Read Enables access to view user enrollment token returned as part of response in APIs

RESTAPIProfile

REST API Profile Read Enables access to all READ only APIs in profiles collection

REST API Profile Write Enables access to all write and update APIs in profiles collection

REST API Profile Execute Enables access to all execute APIs in profiles collection

REST API Profile Delete Enables access to all Delete APIs in profiles collection

Chapter 1: Overview

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Chapter 2:

Security and the API

Overview 39

Generating Client Certificates 39

Important API Considerations (Basic Concepts) 42

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Overview

APIs provide an easy interface to establish a secure communication between AirWatch servers and third-party

applications. The REST API calls take place over HTTPS by default with a certificate signed by a trusted third-party

Certificate Authority (CA). It consists of the public key, information about the owner, and a signature. Other certificates

can be self-signed in which case the clients must install and trust the certificate with no guarantee the claimed owner

identity is genuine. This is called a “root” certificate.

In order to provide certificate-based authentication for admin users access to API’s, user level certificates must be

generated from the AirWatch Console. The certificate used is a self-signed AirWatch certificate generated from AirWatch

Admin Root cert.

Important: All clients must validate the certificate before interacting with the AirWatch server.

Generating Client Certificates

1. Navigate to Accounts > Administrators > List View.

2. Click Add> Add Admin.

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

3. Enter user information in all the required fields on the Basic tab.

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

4. On the API tab, select Certificates from the Authentication drop-down menu and enter the Certificate Password. The

Certificate Password should be the same password entered on the Basic tab.

5. On the Roles tab, click Add Role.

6. Select the admin's Organization Group in the search bar followed by the Role you want to assign to the new admin.

Add as many roles as you want to assign to the admin in the same manner.

7. Select Save to create the new Admin Account with every assigned role and client certificate.

When finished, return to the API tab and select Certificates from the Authentication drop-down menu. You can see the

Client Certificate generated. To export client certificate, enter the certificate password and select Export Client

Certificate.

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Important API Considerations (Basic Concepts)

SSL Only

AirWatch requires all requests to be made over SSL.

Device Identifier Formats

AirWatch supports five types of device identifiers, including:

lUDID

lMAC address

lDevice ID

lSerial number

lEAS ID

Media Types

Request or response bodies and resource representations are encoded as either XML or JSON. Each type of resource has

its own media type, or MIME type, which matches the pattern application/http://host/{resourcetype}+{format} where

{resourcetype} represents a unique representation of a resource, (i.e., a device and {format} is either xml or json).

Important: The API MUST provide a representation of all resource available as either XML or JSON. The API MUST

allow client applications to use application/xml or application/json as a synonym for the default representation at a

given resource URL.

Request Headers

Requests made to an AirWatch Platform API can specify the following HTTP headers.

Header Name Values Description Required

Authorization See Authentication for

details

Identifies who is making a request Always

Accept Comma separated list of

media types

Informs the API what media types

the client can process

Recommended for requests that

yield a response body. If not

specified, application/xml is

assumed

aw- tenant-code Value is available in system

settings when REST API

access is enabled

A unique code entered by the

client. To be recognized by

AirWatch, it needs to be

appended in the URL

Always

Content-Length Length of the request body

in bytes

Specifies the size of the message

body

Required for requests that

include a message body

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Content-Type Media type describing the

request message body

Describes what representation the

API must use to interpret the

message body

Required for requests that

include a message body

Host Specifies the Internet host

and port number of the

origin host receiving the

message

Allows support for multiple origin

servers using the same IP address

Always

Date Date/time in HTTP date

format

The date and time at which the

message was originated

Always

Response Headers

Header Name Values Description Required

Content-Length Length of the response

body in bytes

Specifies the size of the message

body

Required on responses that

include a message body

Content-Type Media type describing the

request message body

Describes the representation of the

response message body

Required on responses that

include a message body

Location The URL of newly created

resources

Returns a URL that can be used to

request the newly created resource

Required on responses to

requests that create new

resources

Date Date/time in HTTP date

format

The date and time at which the

response message was originated

Always

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

HTTP Status Code Update

AirWatch Platform API clients MUST be ready to accept HTTP status codes as defined in the following list:

CATEGORY DESCRIPTION

1xx: Informational Communicates transfer protocol-level information

2xx: Success Client request was accepted successfully

3xx: Redirection Indicates that the client must take additional action to complete their request

4xx: Client Error This category of error status displays when a client seems to have erred

5xx: Server Error The server takes responsibility for these error status codes

From 8.3 version onwards, AirWatch APIs will follow standard HTTP status code to maintain consistency across all APIs.

Only default message will be returned in response for an API call. The custom message will be part of response body but

not HTTP message code.

Example: Calling the Get Admins in Organization Group with no Admins in the group:

API URI – https://host/api/system/groups/{groupid}/admins

Response obtained in 8.2 Response obtained in 8.3

204 No admins found for this search request 204 No content

Refer the below table to understand the status codes and their descriptions:

CODE STATUS DESCRIPTION

100 Continue This indicates that the client can continue with its request.

101 Switching

Protocols

This indicates that the protocol version or protocol is being changed.

200 OK This is used to indicate nonspecific success. In most cases, 200 is the code the client hopes

to see. It indicates that the AirWatch Platform API successfully carried out whatever action

the client requested, and that no more specific code in the 2xx series is appropriate. Unlike

the 204 status code, a 200 response should include a response body. 200 (“OK”) is not

used to communicate errors in the response body.AirWatch Platform API must not be

compromised in an effort to accommodate less sophisticated HTTP clients.

201 Created This is used to indicate successful resource creation. An AirWatch Platform API responds

with the 201 status code whenever a collection creates a new resource at the client’s

request. There may also be times when a new resource is created as a result of some

controller action, in which case 201 would also be an appropriate response.

202 Accepted This is used to indicate successful start of an asynchronous action. A 202 response

indicates that the client’s request will be handled asynchronously. This response status

code tells the client that the request appears valid, but it still may have problems once it’s

finally processed. A 202 response is typically used for actions that take a long while to

process. Controller resources may send 202 responses, but other resource types should

not.

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

203 Non

Authoritative

Information

This indicates that the returned meta information is from a cached copy instead of the

origin server and therefore may be incorrect.

204 No Content This is when the response body is intentionally empty. The 204 status code is usually sent

out in response to a PUT, POST or DELETE request, when the AirWatch Platform API

declines to send back any status message or representation in the response message’s

body. An API may also send 204 in conjunction with a GET request to indicate that the

requested resource exists, but has no state representation to include in the body.

205 Reset Content This indicates that the client should reset (not reload) the current resource.

206 Partial Content This indicates that the response is a partial response as requested by a GET request that

includes a byte range.

300 Multiple

Choices

This indicates that the requested information has multiple representations. The default

action is to treat this status as a redirect and follow the contents of the Location header

associated with this response.

300 Ambiguous This indicates that the requested information has multiple representations. The default

action is to treat this status as a redirect and follow the contents of the Location header

associated with this response.

301 Moved

Permanently

This is used to relocate resources. The 301 status code indicates that the AirWatch

Platform API’s resource model has been significantly redesigned and a new permanent

URI has been assigned to the client’s requested resource. The AirWatch Platform API

should specify the new URI in the response’s Location header.

301 Moved This indicates that the requested information has been moved to the URI specified in the

Location header. The default action when this status is received is to follow the Location

header associated with the response. When the original request method was POST, the

redirected request will use the GET method.

302 Found This indicates that the requested information is located at the URI specified in the

Location header. The default action when this status is received is to follow the Location

header associated with the response. When the original request method was POST, the

redirected request will use the GET method.

302 Redirect This indicates that the requested information is located at the URI specified in the

Location header. The default action when this status is received is to follow the Location

header associated with the response. When the original request method was POST, the

redirected request will use the GET method.

303 See Other This is used to refer the client to a different URI. A 303 response indicates that a controller

resource has finished its work, but instead of sending a potentially unwanted response

body, it sends the client the URI of a response resource. This can be the URI of a

temporary status message, or the URI to some already existing, more permanent,

resource. The 303 status code allows an AirWatch Platform API to send a reference to a

resource without forcing the client to download its state. Instead, the client may send a

GET request to the value of the Location header.

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

303 Redirect

Method

This automatically redirects the client to the URI specified in the Location header as the

result of a POST. The request to the resource specified by the Location header will be

made with a GET.

304 Not Modified This is used to preserve bandwidth. This status code is similar to 204 (“No Content”) in

that the response body must be empty. The key distinction is that 204 is used when there

is nothing to send in the body, whereas 304 is used when there is state information

associated with a resource but the client already has the most recent version of the

representation. This status code is used in conjunction with conditional HTTP requests.

Example: If-Modified header.

305 Use Proxy This indicates that the request should use the proxy server at the URI specified in the

Location header.

306 Unused This is a proposed extension to the HTTP/1.1 specification that is not fully specified.

307 Temporary

Redirect

This is used to tell clients to resubmit the request to another URI. HTTP/1.1 introduced

the 307 status code to reiterate the originally intended semantics of the 302 (“Found”)

status code. A 307 response indicates that the AirWatch Platform API is not going to

process the client’s request. Instead, the client should resubmit the request to the URI

specified by the response message’s Location header. An AirWatch Platform API can use

this status code to assign a temporary URI to the client’s requested resource. For

example, a 307 response can be used to shift a client request over to another host.

307 Redirect Keep

Verb

This indicates that the request information is located at the URI specified in the Location

header. The default action when this status is received is to follow the Location header

associated with the response. When the original request method was POST, the

redirected request will also use the POST method.

400 Bad Request This may be used to indicate nonspecific failure. 400 is the generic client-side error status,

used when no other 4xx error code is appropriate.

Important: For errors in the 4xx category, the response body may contain a document

describing the client’s error (unless the request method was “HEAD”). See Error

representation for error response body design.

401 Unauthorized This is used when there is a problem with the client’s credentials. A 401 error response

indicates that the client tried to operate on a protected resource without providing the

proper authorization. It may have provided the wrong credentials or none at all.

402 Payment

Required

PaymentRequired is reserved for future use

403 Forbidden This is used to forbid access regardless of authorization state. A 403 error response

indicates that the client’s request is formed correctly, but the AirWatch Platform API

refuses to honor it. A 403 response is not a case of insufficient client credentials; that

would be 401 (“Unauthorized”). AirWatch Platform APIs use 403 to enforce application-

level permissions. For example, a client may be authorized to interact with some, but not

all of AirWatch Platform APIs resources. If the client attempts a resource interaction that is

outside of its permitted scope, the AirWatch Platform API should respond with 403.

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

404 Not Found This is used when a client’s URI cannot be mapped to a resource. The 404 error status

code indicates that the AirWatch Platform API could not map the client’s URI to a

resource.

405 Method Not

Allowed

This is used when the HTTP method is not supported. The API responds with a 405 error

to indicate that the client tried to use an HTTP method that the resource does not allow.

For instance, a read-only resource could support only GET and HEAD, while a controller

resource might allow GET and POST, but not PUT or DELETE. A 405 response must include

the Allow header, which lists the HTTP methods that the resource supports. For example:

Allow: GET, POST, HEAD, etc…

406 Not Acceptable This is used when the requested media type cannot be served. The 406 error response

indicates that the API is not able to generate any of the client’s preferred media types, as

indicated by the Accept request header. For example, a client request for data formatted

as txt/csv will receive a 406 response if the API is only willing to format data as

application/json.

407 Proxy

Authentication

Required

This indicates that the requested proxy requires authentication. The Proxy-authenticate

header contains the details of how to perform the authentication.

408 Request

Timeout

This indicates that the client did not send a request within the time the server was

expecting the request.

409 Conflict This is used to indicate a violation of resource state. The 409 error response tells the client

that they tried to put the AirWatch Platform APIs resources into an impossible or

inconsistent state. For example, an AirWatch Platform API may return this response code

when a client tries to delete a non-empty store resource.

410 Gone This indicates that the requested resource is no longer available.

411 Length

Required

This indicates that the required Content-length header is missing.

412 Precondition

Failed

This should be used to support conditional operations. The 412 error response indicates

that the client specified one or more preconditions in its request headers, effectively

telling the AirWatch Platform API to carry out its request only if certain conditions were

met. A 412 response indicates that those conditions were not met, so instead of carrying

out the request, the API sends this status code.

413 Request Entity

Too Large

This indicates that the request is too large for the server to process.

414 Request Uri

Too Long

This indicates that the URI is too long.

415 Unsupported

Media Type

This is used when the media type of a request’s payload cannot be processed. The 415

error response indicates that the API is not able to process the client’s supplied media

type, as indicated by the Content-Type request header. For example, a client request

including data formatted as txt/html will receive a 415 response if the API is only willing to

process data formatted as application/json.

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

416 Requested

Range Not

Satisfiable

This indicates that the range of data requested from the resource cannot be returned,

either because the beginning of the range is before the beginning of the resource, or the

end of the range is after the end of the resource.

417 Expectation

Failed

This indicates that an expectation given in an Expect header could not be met by the

server.

426 Upgrade

Required

This indicates that the client should switch to a different protocol such as TLS/1.0

500 Internal Server

Error

This is used to indicate API malfunction. 500 is the generic AirWatch Platform API error

response. Most web frameworks automatically respond with this response status code

whenever they execute some request handler code that raises an exception. A 500 error is

never the client’s fault and therefore it is reasonable for the client to retry the exact same

request that triggered this response, and hope to get a different response.

501 Not

Implemented

This is used to indicate the service that does not currently support the requested

functionality.

502 Bad Gateway This indicates that an intermediate proxy server received a bad response from another

proxy or the origin server.

503 Service

Unavailable

This is used to indicate that the server is unable to handle the request due to temporary

overload or maintenance of the service.

504 Gateway

Timeout

This indicates that an intermediate proxy server timed out while waiting for a response

from another proxy or the origin server.

505 Http Version

Not Supported

This indicates that the requested HTTP version is not supported by the server.

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Error Codes

CATEGORY DESCRIPTION

3xxx MCM Error Codes

5xxx MDM Error Codes

6xxx System Error Codes

7xxx MAM Error Codes

CODE DESCRIPTION

3000 Personal content is disabled

3001 Unauthorized to access resource

3002 Invalid request

3003 Content-Length not provided

3004 Multipart/form-data only supported

3005 Proper content dispositions aren't found in the request

3006 Unsupported media type

3007 File size is greater than the allowed max file size

3008 User storage quota exceeded, Please contact the admin

3009 Invalid file name

3010 Folder Sharing is not allowed

3011 Folder Not Found

3012 Folder cannot be shared to yourself

3013 Folder name is empty

3014 Folder with same name already exists

3015 Folder id is empty

3016 Rfs is configured

3017 Rfs is not configured

3018 Invalid external file id

3019 Invalid external file hash

3020 Upload the physical file first on Rfs before you finalize your upload operation

3021 Internal server error

3022 Invalid Rfs download url

3023 Folder id is empty or invalid

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

3024 Folder not found or not enough permissions

3025 Using wrong API

3026 File Sharing is disabled

3027 File not found

3028 User Id expected not Email

3029 Needed list of collaborators

3030 Invalid MIME multipart message or is not complete

3031 Invalid folder id

3032 Invalid search criteria

3033 Password is required

3034 Invalid input model

3035 Invalid maximum download count

3036 Invalid password

3037 Invalid collaborator

5000 Invalid activation code

5001 Gateway Configuration Not Found

5002 Device Not Found

5003 Invalid SearchBy Parameter

5004 Cache configuration not found

5005 Invalid Input

5006 Action not enabled

5007 Invalid Device UId; DeviceUid not found

5007 Invalid Platform Type; Request cannot be processed for the given platform type

6000 Admin User Not Found

6001 Admin User Cannot Be Deleted

6002 Passwords Cannot be changed

6003 Password Cannot be null or empty

6004 Password Doesnot meet complexity requerements

6005 Duplicate Role Association is found

6006 Role Association not found

6007 Role Cannot be removed

6008 Application Not Found

6009 Invalid Argument

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

6010 At least one custom attribute value should be present

6011 No Issuer found

6012 Unable to create Basic OCSP response

6013 Unable to load certificate

6014 Invalid OCSP request

7000 Application is not found.

7001 Application Id (BundleId/ExternalId) is empty.

7002 Invalid Argument

7100 No stoken found at passed organization group

7101 Client context is not valid for the environment and must be reset.

7102 Sync on requested item is already in progress.

7103 Device assignment is already enabled for the app.

7104 App is not eligible for device based assignment

7105 Not a valid vpp application

Framework Errors

Error Error Description

UnknownError Unknown data access error

ConstraintError Command violated database constraint

TenantAccessSecurityError Resource access that does not come under current location group

context

DeviceUnenrolledError Device Actions not allowed due to device is in unenrolled state

BulkActionOutOfRange No of devices for bulk action is put of range

ChildLocationGroupExists When child location groups exists, LG delete is not allowed

InvalidInput When input passed is not valid or mandatory inputs are missing

UserExists User already exists, not allowed to add user with same username

NotFound Not found

EnrolledDevicesExistCantDelete User has enrolled devices, can not be deleted

EnrolledDevicesExists User has enrolled devices, can not change the location group of user

Forbidden Forbidden

UserNotFound Enrollment User not found

AlreadyExists Resource already exists, user can't add the same Resource again

AdminCantBeDeleted Admin cannot be deleted

ParentLgIsOfTypeCustomer Lg cannot be created, because its parent LG is of type Customer

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

UserGroupAlreadyExists User group cannot be created, because a user group with the same

name already exists

UserGroupNotFound User group not found

CustomerGroupNotFound Location group of type customer does not exist

SmartGroupNotFound Smart group not found in AirWatch

GeneralServerError General Application error in AirWatch

DeviceTypeNotSupported Functionality not supported for the device-type

FunctionalityNotImplemented Functionality not Implemented in AirWatch API

TagNameAlreadyExists Tag cannot be added, tag with the same name already exists.

SaveDeviceError Device creation failed in AirWatch

InvalidUser User provided in invalid

HmacTokenError Failed to create Hmac token for the device on AirWatch

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Root Service Document

The root service document is found at the root path of the API application and describes which resources are available to

the caller. Resources in the AirWatch Platform API are organized into workspaces. To start an operation, client

applications can request a service document located at the entry point of the API application (e.g.,

https://host/api/system/info). Dereferencing this URL yields a Root Service Document describing each available

workspace (e.g., Mobile Device Management). Similarly, each workspace describes the resources, representations and

child workspaces using a service document.

Client applications MUST NOT make any assumptions about resource URI layouts, structure or hierarchy as this are

server controlled and can change over time.

API key must be included in every request header.

aw- tenant-code – Value is available in system settings when REST API access is enabled.

Example as shown in a REST Client– aw-tenant-code in the header.

Note: This is the initial call a third party would make with no tenant information.

Example:

Resource URL: https://host/api/system/info

Resource Type: Document

Media Type: application/http://servicemodel/ServiceDocument

Method: GET

GET https://host/api/system/info HTTP/1.1

Authorization: [Credentials]

Accept: application/xml

This yields a response with a Service Document representing a Workspace, including the Root Workspace similar to:

HTTP/1.1 200 OK

Content-Type: application/http://host/servicemodel/servicedocument+xml

Content-Length: N

<ProductName>Host Platform Services</ProductName>

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Workspace href="http://host/api/mdm">Mobile Device

Management</Workspace>

<Workspace href="http://host/api/mcm">Mobile Content

Management</Workspace>

<Workspace href="http://host/api/mam">Mobile Application

Management</Workspace>

<Workspace href="http://host/api/mem">Mobile Email

Management</Workspace>

<Workspace href="http://host/api/eis">Enterprise Integration

Services</Workspace>

<Workspace href="http://host/api/admin">System

Administration</Workspace>

...

</Resources>

</ServiceDocument>

Important: In the AirWatch API Help portal, review the entire list of available APIs. Basic User and Directory

Authentication is required to access the API help page.

Chapter 2: Security and the API

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Chapter 3:

Admin User Management

Overview 56

Create Console Admin User (Basic) 56

Create Console Admin User (Directory) 61

Retrieve Admin User Details 63

Search Admin User 66

Update Admin User 70

Add Console Admin User Role 73

Remove Console Admin User Role 74

Change Console Admin User Password 75

Delete Console Admin User 76

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Overview

The AirWatch REST APIs allows you to manage all the core functionalities around console administration. Admin User's

details can be viewed in the following path on the AirWatch Console:

lAdmin User Details – Accounts > Administrators > List View.

lAdmin Role Details – Accounts > Administrators > Roles.

Create Console Admin User (Basic)

Functionality – Creates a console admin user of security type Basic in the desired organization group.

HTTP Method – POST

API URI – https://host/api/system/admins/addadminuser

Request Payloads

XML

<UserName>String</UserName>

<Password>String</Password>

<FirstName>String </FirstName>

<LastName>String </LastName>

<Email>String</Email>

<LocationGroupId>Numeric</LocationGroupId>

<TimeZone>String</TimeZone>

<Locale>String</Locale>

<InitialLandingPage>String</InitialLandingPage>

<Roles>

<Role>

<Id>Numeric</Id>

<LocationGroupId>Numeric</LocationGroupId>

</Role>

<Role>

<Id>Numeric</Id>

<LocationGroupId>Numeric</LocationGroupId>

</Role>

</Roles>

<IsActiveDirectoryUser>Boolean</IsActiveDirectoryUser>

<RequiresPasswordChange>Boolean</RequiresPasswordChange>

</AdminUser>

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"UserName": "String ",

"Password": "String ",

"FirstName": "String ",

"LastName": "String ",

"Email": "String ",

"LocationGroupId": "Numeric",

"TimeZone": "String",

"Locale": "String",

"Roles": [

{

"Id": "Numeric",

"LocationGroupId": "Numeric"

{

"Id": "Numeric",

"LocationGroupId": "Numeric"

}

"IsActiveDirectoryUser":Boolean,

"RequiresPasswordChange":Boolean

}

Request Tag Details

Tag Type Mandatory Description

UserName String Yes Desired unique user name of the Console user

Password String Yes Desired password for the Console user

FirstName String Yes Desired first name of the Console user

LastName String Yes Desired last name of the Console user

Email String Yes Desired email in the format xxx@yyy.com

IsActiveDirectoryUser Boolean Yes Specifies if the user is an Active Directory user. "False" for

a Basic User (the value is case-sensitive)

TimeZone String No Time zone code of the user. Refer Tables for the allowed

time zone code values

LocationGroupId Numeric No ID of the organization group where the user is created.

When this tag is not provided defaults to the Root OG of

the Authenticated user sending the API request

Locale String No Desired Locale of the user. Refer the Important section

below

InitialLandingPage String No Specifies the page to be displayed when the newly

created user logs into the console

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Roles Array Yes (1 role) Array of roles assigned to the admin user. At least 1 role

is mandatory for an admin user

Id(Role) Numeric Yes ID of the desired user role

LocationGroupId(Role) Numeric Yes ID of the organization group where the user role will be

applicable

RequiresPasswordChange Boolean No Specifies whether a password change is required during

the next login

Important

lThe newly created user can be seen in the following path in the console: Accounts >Administrator > List View.

lThe value of the Initial Landing page can be copied from the console. For example, Device/Dashboard

lThe Location Group ID can be obtained using the Search Organization Group API.

lThe Role IDs available in an Organization Group can be obtained using the Get Admin Roles API.

Response Payload

XML

<long>Numeric</long>

JSON

{

"Value": Numeric

}

Response Tag Details

Tag Description

Long/Value Unique ID of the newly created admin user

C# Sample Code

using System;

using System.IO;

using System.Net;

using System.Text;

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

using System.Xml.Serialization;

namespace AirwatchApiClient

{

class Program

{

#region Constants

private const string USER_NAME = "UserName1";

private const string PASSWORD = "Password1";

private const string API_TENANT_CODE = "API-Key";

private const string HOST = "https://host";

private const string MIME_TYPE = "application/xml";

#endregion

public static void InitializeRequest(HttpWebRequest request)

{

request.Headers.Add("aw-tenant-code", API_TENANT_CODE);

request.Credentials = new NetworkCredential(USER_NAME, PASSWORD);

request.KeepAlive = false;

request.AddRange(1024);

request.Timeout = 10000;

}

public static void CreateAdminUser()

{

try

{

var adminUser = new AdminUser();

adminUser.UserName = "UserName";

adminUser.Password = "1234";

adminUser.FirstName = "FirstName";

adminUser.LastName = "Last Name";

adminUser.Email = "user@domain.com";

adminUser.IsActiveDirectoryUser = false;

adminUser.LocationGroupId = "661";

var roles = new Role[1];

var role = new Role();

role.Id = 3;

role.LocationGroupId = "661";

roles[0] = role;

adminUser.Roles = roles;

var request =

WebRequest.Create(HOST + "/api/system/admins/addadminuser") as

HttpWebRequest;

request.Method = "POST";

InitializeRequest(request);

request.ContentType = MIME_TYPE;

var xmlSerializer = new XmlSerializer(typeof(AdminUser));

string inputString;

using (var writer = new StringWriter())

{

var xmlNamespace = new XmlSerializerNamespaces();

xmlNamespace.Add(string.Empty, Metadata.RESOURCE_NAMESPACE);

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

xmlSerializer.Serialize(writer, adminUser, xmlNamespace);

inputString = writer.ToString();

}

byte[] requestBytes = Encoding.UTF8.GetBytes(inputString);

request.ContentLength = inputString.Length;

Stream requestStream = request.GetRequestStream();

requestStream.Write(requestBytes, 0, requestBytes.Length);

requestStream.Close();

var response = (HttpWebResponse)request.GetResponse();

Console.WriteLine(new StreamReader(response.GetResponseStream

()).ReadToEnd());

response.Close();

}

catch (WebException e)

{

if (e.Response != null)

{

var errorMessageStream = e.Response.GetResponseStream();

string message = new StreamReader

(errorMessageStream).ReadToEnd();

Console.WriteLine(message);

}

else

{

Console.WriteLine(e.Message);

}

catch (Exception e)

{

Console.WriteLine(e.Message);

}

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Create Console Admin User (Directory)

Functionality – Creates an admin user with directory credentials in the desired organization group.

HTTP Method – POST

API URI – https://host/api/system/admins/addadminuser

Request Payloads

XML

<UserName>String</UserName>

<LocationGroupId>String</LocationGroupId>

<TimeZone>String</TimeZone>

<Locale>String</Locale>

<InitialLandingPage>String</InitialLandingPage>

<Roles>

<Role>

<Id>Numeric</Id>

<LocationGroupId>String</LocationGroupId>

</Role>

<Role>

<Id>Numeric</Id>

<LocationGroupId>String</LocationGroupId>

</Role>

</Roles>

<RequiresPasswordChange>Boolean</RequiresPasswordChange>

</AdminUser>

JSON

{

"UserName":"String",

"LocationGroupId":"String",

"TimeZone":"String",

"Locale":"String",

"InitialLandingPage":"String",

"Roles":[{"Id":"Numeric","LocationGroupId":"String"},

{"Id":"Numeric","LocationGroupId":"String"}],

"IsActiveDirectoryUser":Boolean,

"RequiresPasswordChange":Boolean

}

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

UserName Yes Desired unique user name of the Console user

LocationGroupId No ID of the organization group where the user is created. When this tag

is not provided, defaults to the Root Organization Group of the

authenticated user sending the API request

TimeZone No Desired time zone for the console Console user

Locale No Desired Locale of the user. Refer the Important section below

InitialLandingPage No Specifies the page to be displayed when the newly created user logs

into the console

Roles Yes (1 role) Array of roles. At least 1 Role is mandatory for the user

Id(Role) Yes ID of the desired user role

LocationGroupId(Role) Yes ID of the Organization Group where the user role will be applicable

IsActiveDirectoryUser Yes "true" for a directory user

RequiresPasswordChange No Specifies whether a password change is required during the next login

Important: The first name, Last name, Email ID, and Password can be picked from the Configured Directory.

Response Payloads

XML

<long>Numeric</long>

JSON

{

"Value":Numeric

}

Response Tag Details

Tag Type Description

Long/Value Numeric Unique user ID of the newly created Console user

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Admin User Details

Functionality – Retrieves console admin user details identified by the admin user ID.

HTTP Method – GET

API URI – https://host/api/system/admins/{id}

URI Parameters

Tag Description

id The admin user ID

Request Body – NA

Response Payload

XML

<Id>Numeric</Id>

<UserName>String</UserName>

<FirstName>String</FirstName>

<LastName>String</LastName>

<Email>String</Email>

<LocationGroup>String</LocationGroup>

<LocationGroupId>String</LocationGroupId>

<TimeZone>String</TimeZone>

<Locale>String</Locale>

<InitialLandingPage>String</InitialLandingPage>

<LastLoginTimeStamp>Datetime</LastLoginTimeStamp>

<Roles>

<Role>

<Id>Numeric</Id>

<Name>String</Name>

<LocationGroup>String</LocationGroup>

<LocationGroupId>String</LocationGroupId>

</Role>

<Role>

<Id>String</Id>

<Name>String</Name>

<LocationGroup>String</LocationGroup>

<LocationGroupId>String</LocationGroupId>

</Role>

</Roles>

<IsActiveDirectoryUser>Boolean</IsActiveDirectoryUser>

<RequiresPasswordChange>Boolean</RequiresPasswordChange>

</AdminUser>

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

"UserName": "String",

"FirstName": "String",

"LastName": "String",

"Email": "String",

"LocationGroup": "String",

"LocationGroupId": "string",

"RequiresPasswordChange":Boolean,

"TimeZone": "String",

"Locale": "String",

"InitialLandingPage": "String",

"LastLoginTimeStamp": "Datetime",

"Roles": [{

"Id": Numeric,

"Name": "String",

"LocationGroup": "String",

"LocationGroupId": "String"

}],

"IsActiveDirectoryUser": "Boolean",

"Id": {"Value": Numeric}

Response Tag Details

Tag Type Description

UserName String User name of the admin user

FirstName String First name of the admin user

LastName String Last name of the admin user

Email String Email address of the admin user

LocationGroup String Name of the organization group to which the admin user belongs

LocationGroupId String Organization group ID of the admin user

TimeZone String Time zone of the admin user

Locale String Locale of the admin user

InitialLandingPage String Initial Landing page to be displayed on the console when the admin

user logs in

LastLoginTimeStamp Datetime Time Stamp of the last login into the console by the admin user

Roles String Array of roles

Roles Id Numeric Unique identification of the role

Name String Name of the role

LocationGroup String Organization group where the role is assigned

LocationGroupId Numeric Organization group ID where the role is assigned

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

RequiresPasswordChange Boolean True/False if the password change is required

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Admin User

Functionality – Searches for admin users using the query information provided.

HTTP Method – GET

API URI – https://host/api/system/admins/search?firstname={firstname}&lastname={lastname}&email=

{emailaddress}&organizationgroupid={organizationgroupid}&role={role}&username={username}&orderby=

{orderby}&page={page}&pagesize={pagesize}&sortorder={sortorder}

lExact Match Parameter – sortorder

lPattern (Contains) Match Parameter – firstname, lastname, email, organizationgroupid, role, username, orderby,

page, pagesize

Request Body – NA

URI Parameters

Tag Type Description

firstname String The First name to search for the admin user

lastname String The Last Name to search for the admin user

emailaddress String The email address to search for the admin user

organizationgroupid Numeric The Organization group ID to search for the admin user

role String Role name to search for the admin user

username String Username to search for the admin user

orderby String Order the results by attribute

page Numeric The specific page number to be retrieved

pagesize Numeric Maximum records per page to be displayed

sortorder Numeric Sorting order. Allowed values are ASC or DESC. Defaults to DESC if this

attribute is not specified

Response Payload

XML

<Page>Numeric</Page>

<PageSize>Numeric</PageSize>

<Total>Numeric</Total>

<Id xmlns="">Numeric</Id>

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<UserName>String</UserName>

<FirstName>String</FirstName>

<LastName>String</LastName>

<Email>String</Email>

<LocationGroup>String</LocationGroup>

<LocationGroupId>String</LocationGroupId>

<TimeZone>String</TimeZone>

<Locale>String</Locale>

<InitialLandingPage>Numeric</InitialLandingPage>

<LastLoginTimeStamp>Datetime</LastLoginTimeStamp>

<Roles>

<Role>

<Id>Numeric</Id>

<Name>String</Name>

<Description>String</Description>

<LocationGroup>String</LocationGroup>

<LocationGroupId>String</LocationGroupId>

</Role>

<Role>

<Id>Numeric</Id>

<Name>String</Name>

<Description>String</Description>

<LocationGroup>String</LocationGroup>

<LocationGroupId>String</LocationGroupId>

</Role>

</Roles>

<IsActiveDirectoryUser>Boolean</IsActiveDirectoryUser>

<RequiresPasswordChange>Boolean</RequiresPasswordChange>

</AdminUser>

</Admins>

</AdminSearchResult>

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"Admins":[{

"Id":Numeric,

"UserName":"String",

"FirstName":"String",

"LastName":"String",

"Email":"String",

"LocationGroup":"String",

"LocationGroupId":"String",

"TimeZone":"String",

"Locale":"String",

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"InitialLandingPage":Numeric,

"LastLoginTimeStamp":Numeric,

"Roles":[{

"Id":Numeric,

"Name":"String",

"Description":"String",

"LocationGroup":"String",

"LocationGroupId":"String"

}],

"IsActiveDirectoryUser":Boolean,

"RequiresPasswordChange":Boolean

}]

}

Response Tag Details

Tag Type Description

Page Numeric Current page number of the result

PageSize Numeric Page size in terms of the number of users in a page

Total Numeric Total number of users present in the search result

Id Numeric Unique ID of the admin user

UserName String Unique user name of the admin user

FirstName String First Name of the admin user

LastName String Last Name of the admin user

Email String Email address of the admin user

LocationGroup String Name of the organization group where the admin user will be created

LocationGroupId String Numeric ID of the organization group where the admin user will be

created

TimeZone String Time zone code of the admin user

Locale String Desired Locale of the admin user

InitialLandingPage String Landing page when the newly created user logs into the console

LastLoginTimeStamp Datetime Time stamp of the last login into the console by the admin user

Roles Array Array of roles. At least 1 role is mandatory for an admin user

Id Numeric Unique numeric ID of the role

Name String Unique name of the admin role

Description String Description of the admin role

LocationGroup String Organization group where the role is assigned

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

LocationGroupId String Organization Group ID where the role is assigned

IsActiveDirectoryUser Boolean Is the user an Active Directory user? "false" for a Basic User (the value

is case-sensitive)

RequiresPasswordChange Boolean Specifies whether a password change is required during the next login

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Admin User

Functionality – Updates the specified admin user.

HTTP Method – POST

API URI – https://host/api/system/admins/{id}/update

URI Parameters

Tag Description

id The admin user ID

Response Body – NA

Request Payload

XML

<UserName>String</UserName>

<Password>String</Password>

<FirstName>String</FirstName>

<LastName>String</LastName>

<Email>String</Email>

<LocationGroupId>Numeric</LocationGroupId>

<TimeZone>String</TimeZone>

<Locale>String</Locale>

<InitialLandingPage>String</InitialLandingPage>

<Roles>

<Role>

<Id>Numeric</Id>

<LocationGroupId>Numeric</LocationGroupId>

</Role>

<Role>

<Id>Numeric</Id>

<LocationGroupId>Numeric</LocationGroupId>

</Role>

</Roles>

<IsActiveDirectoryUser>Boolean</IsActiveDirectoryUser>

<RequiresPasswordChange>Boolean</RequiresPasswordChange>

</AdminUser>

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"UserName":"String",

"Password":"String",

"FirstName":"String",

"LastName":"String",

"Email":"String",

"LocationGroupId":"Numeric",

"TimeZone":"String",

"Locale":"String",

"InitialLandingPage":"String",

"Roles":[{

"Id":Numeric,

"LocationGroupId":"Numeric"

}],

"IsActiveDirectoryUser":Boolean,

"RequiresPasswordChange":Boolean

}

Request Tag Details

Tag Type Mandatory Description

UserName String No Desired unique user name of the admin user

Password String No Desired password for the admin user

FirstName String No Desired first name of the admin user

LastName String No Desired last name of the admin user

Email String No Desired email in the format xxx@yyy.com

LocationGroupId Numeric No ID of the organization group where the user is created.

When this tag is not provided defaults to the Root OG of

the Authenticated user sending the API request

TimeZone String No Time zone code of the user. Refer Tables for the allowed

time zone code values

Locale String No Desired locale of the user

InitialLandingPage String No Initial landing page when the newly created user logs into

the console

Roles Array No Array of roles. At least 1 role is mandatory for an admin

user

Id(Role) Numeric No ID of the desired user role

LocationGroupId(Role) Numeric No ID of the organization group where the user role will be

applicable

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

IsActiveDirectoryUser Boolean No Is the user an Active Directory user? "false" for a Basic

User (the value is case-sensitive)

RequiresPasswordChange Boolean No Specifies whether a password change is required during

the next login

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Add Console Admin User Role

Functionality – Adds a desired admin role to a console admin user.

HTTP Method – POST

API URI – https://host/api/system/admins/{coreuserid}/addrole

Response Obtained – NA

Request Payloads

XML

<Id>String</Id>

<LocationGroupId>string</LocationGroupId>

</Role>

JSON

{

"Id":"String",

"LocationGroupId":"String"

}

Request Tag Details

Tag Mandatory Description

Id Yes Unique numeric ID of the role

LocationGroupId Yes Unique numeric ID of the organization group where the role needs to

be assigned

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Remove Console Admin User Role

Functionality – Removes a role from an specified admin user.

HTTP Method – POST

API URI – https://host/api/system/admins/{coreuserid}/removerole

Response Payload – NA

Request Payload

XML

<Id>Numeric</Id>

<LocationGroupId>Numeric</LocationGroupId>

</Role>

JSON

{

"Id":Numeric,

"LocationGroupId":Numeric

}

Request Tag Details

Tag Mandatory Description

Id Yes Unique numeric ID of the role

LocationGroupId Yes Unique numeric ID of the organization group where the role is applied

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Change Console Admin User Password

Functionality – Changes the password of the console admin user.

HTTP Method – POST

API URI – https://host/api/system/admins/{AdminUserID}/changepassword

Response Obtained – NA

Request Payloads

XML

<Password>String</Password>

<RequiresPasswordChange>Boolean</RequiresPasswordChange>

</AdminUser>

JSON

{

"Password": "String"

"RequiresPasswordChange":Boolean

}

Request Tag Details

Tag Mandatory Description

Password Yes Desired new password

RequiresPasswordChange No Specifies whether a password change is required during the next login

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Console Admin User

Functionality – Deletes a specified console admin user identified by its user ID of an organization group.

HTTP Method – DELETE

API URI – https://host/api/system/admins/{id}/delete

URI Parameters

Tag Description

id The admin user ID

Response Obtained – NA

Request payload – NA

Chapter 3: Admin User Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Chapter 4:

Application Management

Overview 81

Internal Application Install : Upload Application Chunks (iOS

and Android) 81

Upload Blob 85

Download Blob 86

Internal Application Save 87

Insert Public Application (iOS and Android) 102

Update Public Application (*Refactored) 108

Search Applications 111

Search Play Store for Applications (*Refactored) 124

Search Windows App Store for Applications (*Refactored) 126

Search Apple App Store for Applications (*Refactored) 128

Activate Internal Application 130

Update Internal Application 131

Activate Public Application 141

Deactivate Internal Application 142

Deactivate Public Application 142

Retire Internal Application 143

Unretire Internal Application 143

Assign Smart Group to an Internal Application (*Refactored) 144

Assign Smart Group to a Public Application (*Refactored) 144

Assign Smart Group to BSP Application (Version 2) 144

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Remove Smart Group Assignment From an Internal

Application (*Refactored) 146

Remove Smart Group Assignment From a Public Application

(*Refactored) 146

Install Internal Application on Device 147

Install Public Application on Device 148

Install Purchased Application on the Device 149

Uninstall Internal Application From the Device 150

Uninstall Public Application From the Device 151

Uninstall Purchased Application From the Device 152

View Internal Application Status on the Device 153

View Public Application Status on the Device 154

View Purchased Application Status on Device 155

Retrieve Application Details 156

Get Application Management Status (*Refactored) 159

Retrieve Assigned Devices (Internal Application)

(*Refactored) 160

Retrieve Assigned Devices (Public Application)

(*Refactored) 162

Retrieve Assigned Devices With Purchased Application

(*Refactored) 164

Retrieve Installed Devices (Internal Application)

(*Refactored) 166

Retrieve Installed Devices (Public Application) (*Refactored)168

Retrieve Installed Devices With Purchased Application

(*Refactored) 170

Retrieve Devices with Internal Application Installed or

Assigned 172

Retrieve Devices with Public Application Installed or

Assigned 174

Retrieve Devices with Purchased Application Installed or

Assigned 176

Delete Internal Application 178

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Public Application 178

Add Assignments to Internal Application 179

Edit Assignment of Internal Application 181

Delete Application Assignment From Smart Group 183

Retrieve Internal Application Details 184

Create Application Group (*Refactored) 198

Retrieve Application Group Details 203

Search Application Group (*Refactored) 206

Search SDK Analytics 210

Update Application Group (*Refactored) 213

Delete Application Group (*Refactored) 216

Add Application to an Application Group (*Refactored) 218

Delete Application from the Application Group

(*Refactored) 219

Create VPP Application Allocation (*Refactored) 220

Delete VPP Application 222

Delete VPP Application Smart Group Assignment

(*Refactored) 222

Search VPP Application (*Refactored) 223

Get VPP Allocation Details 227

Update VPP Licensed Application Assignment (*Refactored) 230

Queues Sync Assets for VPP Applications 233

Resets the Client Context 234

Get VPP Sync Assets Status 235

Enable Device Based Assignment For VPP Applications 236

Update Application on Devices Having Device Based

Licenses 236

Auto Update Flag for Device based VPP App 236

Get VPP Invite Status (*Refactored) 238

Send Bulk VPP Invite (*Refactored) 239

Retrieve Windows App Dependency 241

Retrieve List of Windows App Dependency Files 249

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Windows Dependency Application 251

Search and Retrieve Removal Logs for Internal Applications 252

Update Removal Logs 254

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Overview

AirWatch REST APIs allows you to manage the end-to-end functionalities of Mobile Application Management (MAM)

features. Using these APIs, you can upload internal and public applications, assign, and manage applications on the

devices. Application details can be viewed in the following path on the AirWatch Console:

lPublic and Internal Application Details – Apps&Books > Applications > List View.

lSmart Group Details – Groups & Settings > Groups > Smart Groups.

Internal Application Install : Upload Application Chunks (iOS and Android)

Functionality – Uploads application chunks into the database for internal application install. This API must be used prior

to the 'Begin Install API' for uploading an internal application.

HTTP Method – POST

API URI – https://host/api/mam/apps/internal/uploadchunk

Request Payloads

XML

<TransactionId>String</TransactionId>

<ChunkData>String</ChunkData>

<ChunkSequenceNumber>Numeric</ChunkSequenceNumber>

<TotalApplicationSize>Numeric</TotalApplicationSize>

<ChunkSize>Numeric</ChunkSize>

</InternalAppChunk>

JSON

{

"TransactionId":"String",

"ChunkData":[String],

"ChunkSequenceNumber":Numeric,

"TotalApplicationSize":Numeric,

"ChunkSize":Numeric

}

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

TransactionId Yes Unique Identifier to identify an application. This string is generated by

the server and sent as a response for the first chunk sent. This

transaction ID should be sent for all the chunks that are subsequently

sent.

ChunkData Yes Base-64 Encoded String of the application chunk

ChunkSequenceNumber Yes Sequence number of the chunk. First chunk will have sequence

number of 1

TotalApplicationSize Yes Total application size

ChunkSize Yes Chunk size. Recommended chunk size is 1 MB.

Response Payload

XML

<TransactionId>String</TransactionId>

<ChunkSequenceNumber>Numeric</ChunkSequenceNumber>

<UploadSuccess>Boolean</UploadSuccess>

</InternalAppChunk>

JSON

{

"TransactionId":Numeric,

"ChunkSequenceNumber":"String",

"UploadSuccess" : "Boolean"

}

Response Tag Details

Tag Type Description

TransactionId String Unique Identifier to identify an application. This string is generated by

the server and sent as a response for the first chunk sent. This

transaction ID should be sent for all the chunks that are subsequently

sent.

ChunkSequenceNumber Numeric Sequence number of the Chunk. First Chunk will have sequence

number of 1

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

UploadSuccess Boolean "True" indicates a successful chunk upload, "False" indicates an failed

chunk upload

C# Sample Code

using System;

using System.IO;

using System.Net;

using System.Text;

using System.Xml.Serialization;

namespace AirwatchApiClient

{

class Program

{

#region Constants

private const string USER_NAME = "UserName1";

private const string PASSWORD = "Password1";

private const string API_TENANT_CODE = "API-Key";

private const string HOST = "https://host";

private const string MIME_TYPE = "application/xml";

#endregion

public static void InitializeRequest(HttpWebRequest request)

{

request.Headers.Add("aw-tenant-code", API_TENANT_CODE);

request.Credentials = new NetworkCredential(USER_NAME, PASSWORD);

request.KeepAlive = false;

request.AddRange(1024);

request.Timeout = 10000;

}

public static void UploadChunk()

{

try

{

var chunkEntity = new InternalAppChunk();

chunkEntity.ChunkData = new byte[] { 81, 109, 70, 122, 90, 83,

65, 50, 78, 67, 66, 84, 100, 72, 74, 108, 89, 87, 48, 61 };

chunkEntity.ChunkSequenceNumber = 1;

chunkEntity.ChunkSize = chunkEntity.ChunkData.Length;

chunkEntity.TotalApplicationSize =

chunkEntity.ChunkData.Length;

var request =

WebRequest.Create(HOST + "/api/mam/apps/internal/uploadchunk")

HttpWebRequest;

request.Method = "POST";

InitializeRequest(request);

request.ContentType = MIME_TYPE;

var xmlSerializer = new XmlSerializer(typeof

(InternalAppChunk));

string inputString;

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

using (var writer = new StringWriter())

{

var xmlNamespace = new XmlSerializerNamespaces();

xmlNamespace.Add(string.Empty, Metadata.RESOURCE_NAMESPACE);

xmlSerializer.Serialize(writer, chunkEntity, xmlNamespace);

inputString = writer.ToString();

}

byte[] requestBytes = Encoding.UTF8.GetBytes(inputString);

request.ContentLength = inputString.Length;

Stream requestStream = request.GetRequestStream();

requestStream.Write(requestBytes, 0, requestBytes.Length);

requestStream.Close();

var response = (HttpWebResponse)request.GetResponse();

Console.WriteLine(new StreamReader(response.GetResponseStream

()).ReadToEnd());

response.Close();

}

catch (WebException e)

{

if (e.Response != null)

{

var errorMessageStream = e.Response.GetResponseStream();

string message = new StreamReader

(errorMessageStream).ReadToEnd();

Console.WriteLine(message);

}

else

{

Console.WriteLine(e.Message);

}

catch (Exception e)

{

Console.WriteLine(e.Message);

}

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Upload Blob

Functionality – Uploads your enterprise application packages (iOS, Android, and Windows Phone 8) as a single byte

stream. The response for this API is a numeric “Blob ID”, that can be used in the Internal Application Save API to save the

application to the console.

HTTP Method – POST

API URI – https://host/api/mam/blobs/uploadblob?filename={filename}&organizationgroupid=

{organizationgroupid}&moduleType={moduleType}

Request Body – Application file should be sent as binary.

URI Parameters

Tag Type Description

filename String The name of the file along with the file extension.

organizationgroupid Numeric Numeric Identifier of the organization group to upload the blob

moduleType String Module type of file being uploaded. Example: General, Application,

Book etc., Default: General

Response Payload

XML

<long>Numeric</long>

JSON

{

"Value" : Numeric

}

Response Tag Details

Tag Type Description

Long Numeric Unique numeric identifier of the Application blob in repository

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Download Blob

Functionality – Downloads the blob stream from the repository identified by blob id.

HTTP Method – GET

API URI – https://host/api/mam/blobs/downloadblob/{blobid}

Request Body – NA

Response Obtained – Application Data as Byte Stream

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Internal Application Save

Functionality – Use this API to save an application, the blob or chunks of app package that are uploaded using ‘Upload

Blob’ or ‘Upload Chunk’ APIs. This API can also be used to specify the supported models, deployment mode of the

application. Once saved, assignments can be added to the application using ‘/internal/addAssignment’ (validate name)

to begin the installation.

HTTP Method – POST

API URI – https://host/api/mam/apps/internal/begininstall

Request Payload

XML

<InternalAppChunkTransaction xmlns="http://www.air-

watch.com/servicemodel/resources">

<TransactionId>String</TransactionId>

<BlobId>String</BlobId>

<DeviceType>String</DeviceType>

<ApplicationName>String</ApplicationName>

<Model>

<ModelId>Numeric</ModelId>

<ModelName>String</ModelName>

</ApplicationSupportedModel>

</Model>

</SupportedModels>

<PushMode>String</PushMode>

<Description>String</Description>

<SupportEmail>String</SupportEmail>

<SupportPhone>String</SupportPhone>

<Developer>String</Developer>

<DeveloperEmail>String</DeveloperEmail>

<DeveloperPhone>String</DeveloperPhone>

<AutoUpdateVersion>Boolean</AutoUpdateVersion>

<LocationGroupId>Numeric</LocationGroupId>

<EnableProvisioning>Boolean</EnableProvisioning>

<FileName>String</FileName>

<SupportedProcessorArchitecture>String</SupportedProcessorArchitecture>

<CommandLineArguments xmlns="http://www.air-

watch.com/webapi/resources">String</CommandLineArguments>

<InstallTimeoutInMinutes xmlns="http://www.air-

watch.com/webapi/resources">Numeric</InstallTimeoutInMinutes>

<RetryCount xmlns="http://www.air-

watch.com/webapi/resources">Numeric</RetryCount>

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<RetryIntervalInMinutes xmlns="http://www.air-

watch.com/webapi/resources">Numeric</RetryIntervalInMinutes>

</MsiDeploymentParamModel>

<IsDependencyFile>Boolean</IsDependencyFile>

<CriteriaType>String</CriteriaType>

<ApplicationIdentifier>String</ApplicationIdentifier>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

</DataContingencies>

<DiskSpaceRequiredInKb>Numeric</DiskSpaceRequiredInKb>

<DevicePowerRequired>Numeric</DevicePowerRequired>

<RamRequiredInMb>Numeric</RamRequiredInMb>

</WhenToInstall>

<InstallContext>String</InstallContext>

<InstallCommand>String</InstallCommand>

<AdminPrivileges>Boolean</AdminPrivileges>

<DeviceRestart>String</DeviceRestart>

<RetryCount>Numeric</RetryCount>

<RetryIntervalInMinutes>Numeric</RetryIntervalInMinutes>

<InstallTimeoutInMinutes>Numeric</InstallTimeoutInMinutes>

<InstallerRebootExitCode>String</InstallerRebootExitCode>

<InstallerSuccessExitCode>String</InstallerSuccessExitCode>

</HowToInstall>

<WhenToCallInstallComplete xmlns="http://www.air-

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

watch.com/webapi/resources">

<UseAdditionalCriteria>Boolean</UseAdditionalCriteria>

<IdentifyApplicationBy>String</IdentifyApplicationBy>

<CriteriaType>String</CriteriaType>

<ApplicationIdentifier>String</ApplicationIdentifier>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

</CriteriaList>

<ScriptType>String</ScriptType>

<CommandToRunTheScript>String</CommandToRunTheScript>

<CustomScriptFileBlodId>Numeric</CustomScriptFileBlodId>

<SuccessExitCode>Numeric</SuccessExitCode>

</CustomScript>

</WhenToCallInstallComplete>

</DeploymentOptions>

<AppDependenciesList xmlns="http://www.air-

watch.com/webapi/resources">

<Name>String</Name>

<ApplicationDependencyId>Numeric</ApplicationDependencyId>

</ApplicationDependency>

</AppDependenciesList>

<TransformFileName>String</TransformFileName>

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<TransformBlobId>Numeric</TransformBlobId>

</ApplicationTransform>

</AppTransformsList>

<PatchFileName>String</PatchFileName>

<PatchBlobId>Numeric</PatchBlobId>

<PatchType>String</PatchType>

<BuildVersion>String</BuildVersion>

</ApplicationPatch>

</AppPatchesList>

<ApplicationUnInstallProcess xmlns="http://www.air-

watch.com/webapi/resources">

<UseCustomScript>Boolean</UseCustomScript>

<CustomScriptType>String</CustomScriptType>

<UninstallCommand>String</UninstallCommand>

<UninstallScriptBlobId>Numeric</UninstallScriptBlobId>

</CustomScript>

</ApplicationUnInstallProcess>

</FilesOptions>

</InternalAppChunkTranscation>

JSON

{

"ApplicationName" : "String",

"AutoUpdateVersion" : Boolean,

"BlobId" : "String",

"DeploymentOptions" : {

"HowToInstall" : {

"AdminPrivileges" : Boolean,

"DeviceRestart" : "String",

"InstallCommand" : "String",

"InstallContext" : "String",

"InstallTimeoutInMinutes" : Numeric,

"InstallerRebootExitCode" : "String",

"InstallerSuccessExitCode" : "String",

"RetryCount" : Numeric,

"RetryIntervalInMinutes" : Numeric

"WhenToCallInstallComplete" : {

"CriteriaList" : [

{

"AppCriteria" : {

"ApplicationIdentifier" : "String",

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"CriteriaType" : "String",

"FileCriteria" : {

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"ModifiedOn" : "String",

"Path" : "String",

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"LogicalCondition" : "String",

"RegistryCriteria" : {

"KeyName" : "String",

"KeyType" : "String",

"KeyValue" : "String",

"Path" : "String"

}

"CustomScript" : {

"CommandToRunTheScript" : "String",

"CustomScriptFileBlodId" : Numeric,

"ScriptType" : "String",

"SuccessExitCode" : Numeric

"IdentifyApplicationBy" : "String",

"UseAdditionalCriteria" : Boolean

"WhenToInstall" : {

"DataContingencies" : [

{

"AppCriteria" : {

"ApplicationIdentifier" : "String",

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"CriteriaType" : "String",

"FileCriteria" : {

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"ModifiedOn" : "String",

"Path" : "String",

"RevisionNumber" : Numeric,

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"VersionCondition" : "String"

"LogicalCondition" : "String",

"RegistryCriteria" : {

"KeyName" : "String",

"KeyType" : "String",

"KeyValue" : "String",

"Path" : "String"

}

"DevicePowerRequired" : Numeric,

"DiskSpaceRequiredInKb" : Numeric,

"RamRequiredInMb" : Numeric

}

"Description" : "String",

"Developer" : "String",

"DeveloperEmail" : "String",

"DeveloperPhone" : "String",

"DeviceType" : "String",

"EnableProvisioning" : Boolean,

"FileName" : "String",

"FilesOptions" : {

"AppDependenciesList" : [

{

"ApplicationDependencyId" : Numeric

}

"AppPatchesList" : [

{

"PatchBlobId" : Numeric,

"PatchType" : "String"

}

"AppTransformsList" : [

{

"TransformBlobId" : Numeric

}

"ApplicationUnInstallProcess" : {

"CustomScript" : {

"CustomScriptType" : "String",

"UninstallCommand" : "String",

"UninstallScriptBlobId" : Numeric

"UseCustomScript" : Boolean

}

"IsDependencyFile" : Boolean,

"LocationGroupId" : Numeric,

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"MsiDeploymentParamModel" : {

"CommandLineArguments" : "String",

"InstallTimeoutInMinutes" : Numeric,

"RetryCount" : Numeric,

"RetryIntervalInMinutes" : Numeric

"PushMode" : "String",

"SupportEmail" : "String",

"SupportPhone" : "String",

"SupportedModels" : {

"Model" : [

{

"ApplicationId" : Numeric,

"ModelId" : Numeric,

"ModelName" : "String"

}

]

"SupportedProcessorArchitecture" : "String",

"TransactionId" : "String"

}

Request Tag Details

Tag Mandatory Description

ApplicationName Yes Desired Application Name

AutoUpdateVersion Yes Defines if the application can be updated automatically. Supported

values are True and False.

BlobId No Unique identifier obtained from the Upload Blob API response

AdminPrivileges No Whether or not the installation should be initiated with logged-in

user privileges or with stepped up administrative permissions

DeviceRestart No Restart the device after the application is installed

InstallCommand No Install program to meet your deployment criteria

InstallContext No Indicate whether the app should be configured and installed for just

enrolled users or for all users on each of your devices

InstallTimeoutInMinutes No Amount of time, in minutes, that the installation process can run

before the installation is considered as failed

InstallerRebootExitCode No Integer code returned by the installer to indicate that the app has

been successfully installed once the device has been rebooted. This

will be used in conjunction with the 'Device Restart' option specified

above.

InstallerSuccessExitCode No Integer code returned by the installer that marks the success of the

operation

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

RetryCount No Number of retries for installing application before the installation is

marked as failed

RetryIntervalInMinutes No Amount of time, in minutes, between retries for installing

application

ApplicationIdentifier No Unique identifier of the application (Bundle ID or External ID)

BuildNumber No Build version of the application

MajorVersion No Major version of the application

MinorVersion No Minor version of the application

RevisionNumber No Fix version of the application

VersionCondition No Version Conditions

CriteriaType No Unique smart group type configured to the smart group

BuildNumber No Build version of the application

MajorVersion No Major version of the application

MinorVersion No Minor version of the application

ModifiedOn No Date on which the application was last modified

Path No Path of the application

RevisionNumber No Fix version of the application

VersionCondition No Version Conditions

LogicalCondition No Logical condition. Supported values are And, and Or.

KeyType No Type of key to be created in the registry. Supported values are

String, Binary, DWord, QWord, MultiString, and ExpandableString.

KeyValue No Value of the key to be created in the registry

Path No Path of the key in the registry

CommandToRunTheScrip No Command to run the script

CustomScriptFileBlodId No Blob ID of the script file associated. Supported file types are .js, .jse,

.ps1, .ps1xml, .psc1, .psd1, .psm1, .pssc, .cdxml, .vbs, .vbe, .wsf,

and .wsc.

ScriptType No Script Type. Supported script types are JScript, PowerShell, and

VBScript

SuccessExitCode No Success exit code

IdentifyApplicationBy No The way by which an application can be identified. Supported values

are DefiningCriteria,and UsingCustomScript.

UseAdditionalCriteria No Msi apps are detected on the device by product code and version.

Use this option to perform additional actions to ensure your app is

successfully installed on your end users' devices.

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

DevicePowerRequired No The minimum percentage of power required by the device for

installing the application

DiskSpaceRequiredInKb No The amount of disk space required for the successful installation of

the application

RamRequiredInMb No RAM (in MB) required for installing the application

Description No Description of the application on what the application does and

how it can be used

Developer No Desired name of the developer

DeveloperEmail No User defined email address of developer

DeveloperPhone No User defined phone number of developer

DeviceType No Numeric Platform identifier of the Device Application

EnableProvisioning No Provisioning status. Supported value is Boolean/False.

FileName No File name along with the extension

FilesOptions No Application files options

ApplicationDependencyId No Application dependency identifier

PatchBlobId No Blob ID of the uploaded Patch

PatchType No Type of the uploaded patch

TransformBlobId No Blob ID of the uploaded Transform

CustomScript No Custom script

CustomScriptType No Custom script type. Supported values are Input and Upload.

UninstallCommand No Application uninstall command provided

UninstallScriptBlobId No Gets or sets the identifier value of the uninstall script file uploaded

on the console. Supported file types are .js, .jse, .ps1, .ps1, .xml,

.psc1, .psd1, .psm1, .pssc, .cdxml, .vbs, .vbe, .wsf,and .wsc.

UseCustomScript No Value indicating whether custom script is used or not

IsDependencyFile No Indicates whether uploaded file is a dependency file

LocationGroupId No Location group identifier

MsiDeploymentParamModel No Msi deployment Parameter model. This is valid only for MSI files

when Software Distribution is not enabled.

CommandLineArguments No Command-line options to be used when calling MSIEXEC.exe

InstallTimeoutInMinutes No 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. The range is 0

through 60.

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

RetryCount No The number of times the download and installation operation will

be retried before the installation will be marked as failed. With a

limit of 10 attempts.

RetryIntervalInMinutes No Amount of time, in minutes between retry operations. The range is

0 through 10.

PushMode Yes Deployment mode for the applications. Supported values are Auto

and On Demand.

SupportEmail No User defined email address of support

SupportPhone No User defined phone number of support

ApplicationId Yes Application identifier

ModelId No Identifier of the Device Model

ModelName No Name of the Device Model

SupportedProcessorArchitecture No The architecture type of the end user devices that the application

supports

TransactionId No Unique Identifier to identify an application. This string is generated

by the server and sent as a response for the first chunk sent. This

transaction ID should be sent for all the chunks that are

subsequently sent.

*At least one model information should be passed in the request.

Important Note: Unlike API based app upload, if an app is uploaded through AirWatch Console, the deployment

mode (push mode) is selected during smart group assignment process.

Response Payload

XML

<Id xmlns="">Numeric</Id>

<ApplicationName>String</ApplicationName>

<BundleId>String</BundleId>

<AppVersion>String</AppVersion>

<ActualFileVersion>String</ActualFileVersion>

<AppType>String</AppType>

<Status>String</Status>

<Platform>Numeric</Platform>

<Model>

<ModelId>Numeric</ModelId>

<ModelName>String</ModelName>

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</ApplicationSupportedModel>

</Model>

</SupportedModels>

<AssignmentStatus>String</AssignmentStatus>

<ApplicationSize>String</ApplicationSize>

<CategoryId>Numeric</CategoryId>

<Name>String</Name>

</Category>

</CategoryList>

<Comments>String</Comments>

<IsReimbursable>Boolean</IsReimbursable>

<ApplicationUrl>String</ApplicationUrl>

<ApplicationSource>Numeric</ApplicationSource>

<LocationGroupId>Numeric</LocationGroupId>

<ExternalId>String</ExternalId>

<LargeIconUri>String</LargeIconUri>

<MediumIconUri>String</MediumIconUri>

<SmallIconUri>String</SmallIconUri>

<AssignedDeviceCount>Numeric</AssignedDeviceCount>

<InstalledDeviceCount>Numeric</InstalledDeviceCount>

<NotInstalledDeviceCount>Numeric</NotInstalledDeviceCount>

</ApplicationEntity>

JSON

{

"Id" : Numeric,

"ActualFileVersion" : "String",

"AppRank" : Numeric,

"AppType" : "String",

"AppVersion" : "String",

"ApplicationName" : "String",

"ApplicationSize" : "String",

"ApplicationSource" : Numeric,

"ApplicationUrl" : "String",

"AssignedDeviceCount" : Numeric,

"AssignmentStatus" : "String",

"BundleId" : "String",

"CategoryList" : {

"Category" : [

{

"CategoryId" : Numeric,

"Name" : "String"

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

}

]

"Comments" : "String",

"ExternalId" : "String",

"InstalledDeviceCount" : Numeric,

"IsReimbursable" : Boolean,

"LargeIconUri" : "String",

"LocationGroupId" : Numeric,

"MediumIconUri" : "String",

"NotInstalledDeviceCount" : Numeric,

"Platform" : Numeric,

"PushMode" : Numeric,

"SmallIconUri" : "String",

"Status" : "String",

"SupportedModels" : {

"Model" : [

{

"ApplicationId" : Numeric,

"ModelId" : Numeric,

"ModelName" : "String"

}

]

}

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Tag Details

Tag Type Description

Id Numeric Unique identifier for the application

ActualFileVersion String Actual version of the file

AppRank Numeric Rank of the application

AppType String Type of the application

AppVersion String Version of the application

ApplicationName String Name of the application

ApplicationSize String Size of the application

ApplicationSource Numeric Source of the application

ApplicationUrl String URL of the application

AssignedDeviceCount Numeric Number of devices assigned with the application

AssignmentStatus String Status of the application assignment

BundleId String Bundle ID of the application from the Play Store for Android

CategoryId Numeric Unique identifier of the application category

Name String Name of the application category

Comments String Desired comments for the application

ExternalId String Track ID of the application from the App Store for iOS

InstalledDeviceCount Numeric Number of devices with assigned application installed

IsReimbursable Boolean Is the Paid Application Reimbursable

LargeIconUri String URI of the large icon for the application

LocationGroupId Numeric Unique numeric identifier of the Organization Group where the

application is present

MediumIconUri String URI of the medium icon for the application

NotInstalledDeviceCount Numeric Number of devices with no assigned application installed

Platform Numeric Platform identifier of the application. Refer Tables for the List of

Platform identifiers

PushMode Numeric Deployment mode for the applications. The values are 'Auto' and 'On

Demand'

SmallIconUri String URI of the small icon for the application

Status String Current Status of the application. Supported values are Active and

Inactive.

ApplicationId Numeric Unique identifier of the application

Chapter 4: Application Management

VMware AirWatch REST API Guide | v.2016.04 | April 2017

ModelId Numeric Identifier of the Device Model

ModelName String Name of the Device Model

C# Sample Code

using System;

using System.IO;

using System.Net;

using System.Text;

using System.Xml.Serialization;

namespace AirwatchApiClient

{

class Program

{

#region Constants

private const string USER_NAME = "UserName1";

private const string PASSWORD = "Password1";

private const string API_TENANT_CODE = "API-Key";

private const string HOST = "https://host";

private const string MIME_TYPE = "application/xml";

#endregion

public static void InitializeRequest(HttpWebRequest request)

{

request.Headers.Add("aw-tenant-code", API_TENANT_CODE);

request.Credentials = new NetworkCredential(USER_NAME, PASSWORD);

request.KeepAlive = false;

request.AddRange(1024);

request.Timeout = 10000;

}

public static void BeginInstall()

{

try

{

var appChunk = new InternalAppChunkTranscation();

appChunk.TransactionId = "782ae0ef-b6ee-4e4c-929e-

881f30bdef40";

appChunk.ApplicationName = "testapp";

appChunk.LocationGroupId = 661;

appChunk.DeviceType = "Android";

appChunk.PushMode = "Auto";

appChunk.AutoUpdateVersion = Boolean;

var supportedmodels = new SupportedModels();

appChunk.SupportedModels = supportedmodels;

var models = new ApplicationSupportedModel[1];

var model = new ApplicationSupportedModel();

supportedmodels.Model = models;

model.ModelName = "Android";

Chapter 4: Application Management

100

VMware AirWatch REST API Guide | v.2016.04 | April 2017

models[0] = model;

var request =

WebRequest.Create(HOST +

"/api/mam/apps/internal/begininstall") as

HttpWebRequest;

request.Method = "POST";

InitializeRequest(request);

request.ContentType = MIME_TYPE;

var xmlSerializer = new XmlSerializer(typeof

(InternalAppChunkTranscation));

string inputString;

using (var writer = new StringWriter())

{

var xmlNamespace = new XmlSerializerNamespaces();

xmlNamespace.Add(string.Empty, Metadata.RESOURCE_NAMESPACE);

xmlSerializer.Serialize(writer, appChunk, xmlNamespace);

inputString = writer.ToString();

}

byte[] requestBytes = Encoding.UTF8.GetBytes(inputString);

request.ContentLength = inputString.Length;

Stream requestStream = request.GetRequestStream();

requestStream.Write(requestBytes, 0, requestBytes.Length);

requestStream.Close();

var response = (HttpWebResponse)request.GetResponse();

Console.WriteLine(new StreamReader(response.GetResponseStream

()).ReadToEnd());

response.Close();

}

catch (WebException e)

{

if (e.Response != null)

{

var errorMessageStream = e.Response.GetResponseStream();

string message = new StreamReader

(errorMessageStream).ReadToEnd();

Console.WriteLine(message);

}

else

{

Console.WriteLine(e.Message);

}

catch (Exception e)

{

Console.WriteLine(e.Message);

}

Chapter 4: Application Management

101

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Insert Public Application (iOS and Android)

Functionality – Inserts the public application selected by searching for the bundle ID (Android) or external ID (iOS) in the

app market.

HTTP Method – POST

API URI – https://host/api/mam/apps/public

Request Payload

XML

<ApplicationName>String</ApplicationName>

<BundleId>String</BundleId>

<ExternalId>String</ExternalId>

<LocationGroupId>Numeric</LocationGroupId>

<PushMode>String</PushMode>

<Platform>Numeric</Platform>

<AssignmentStatus>String</AssignmentStatus>

<CategoryId>Numeric</CategoryId>

<Name>String</Name>

</Category>

</CategoryList>

<Comments>String</Comments>

<IsReimbursable>Boolean</IsReimbursable>

<ApplicationUrl>String</ApplicationUrl>

</ApplicationEntity>

JSON

{

"ApplicationName":"String",

"ApplicationUrl" : "String",

"AssignmentStatus" : "String",

"BundleId":"String",

"ExternalId":"String",

"Platform":Numeric,

"LocationGroupId":Numeric,

"PushMode":Numeric

"CategoryList":

{

Chapter 4: Application Management

102

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"Category":

[{

"CategoryId":Numeric,

"Name":"String"

}]

"Comments":"String",

"IsReimbursable":Boolean

}

Request Tag Details

Tag Mandatory Description

ApplicationName Yes Desired application name

BundleId Yes Bundle ID of the application from the Play Store for Android

ExternalId Yes Track ID of the application from the App Store for iOS

Platform Yes Desired Platform ID

LocationGroupId Yes Unique ID of the organization group where the application is uploaded

PushMode Yes Mode of application deployment. For example: "Auto", "OnDemand"

CategoryList No Array of applicable categories the application belongs to

CategoryId No Unique numeric ID of the application category

Name No Name of the application category

Comments No Desired comments for the application

IsReimbursable No Denotes if the application is reimbursable

ApplicationUrl Yes* URL of the application

AssignmentStatus No Status of the application assignment

Note*: While passing value for <ApplicationUrl>, if the url has "&", replace it with "&". This prevents from

obtaining de-serialization error.

Response Payload

XML

<Id xmlns="">Numeric</Id>

<ApplicationName>String</ApplicationName>

Chapter 4: Application Management

103

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<BundleId>String</BundleId>

<Platform>Numeric</Platform>

<CategoryId>Numeric</CategoryId>

<Name>String</Name>

</Category>

</CategoryList>

<Comments>String</Comments>

<IsReimbursable>Boolean</IsReimbursable>

<ApplicationUrl>String</ApplicationUrl>

<LocationGroupId>Numeric</LocationGroupId>

<PushMode>Numeric</PushMode>

<AssignedDeviceCount>Numeric</AssignedDeviceCount>

<InstalledDeviceCount>Numeric</InstalledDeviceCount>

<NotInstalledDeviceCount>Numeric</NotInstalledDeviceCount>

</ApplicationEntity>

JSON

{

"Id" : Numeric,

"ApplicationName" : "String",

"ApplicationUrl" : "String",

"AssignedDeviceCount" : Numeric,

"BundleId" : "String",

"CategoryList" : {

"Category" : [

{

"CategoryId" : Numeric,

"Name" : "String"

}

]

"Comments" : "String",

"InstalledDeviceCount" : Numeric,

"IsReimbursable" : Boolean,

"LocationGroupId" : Numeric,

"NotInstalledDeviceCount" : Numeric,

"Platform" : Numeric,

"PushMode" : Numeric

}

Response Tag Details

Tag Type Description

Chapter 4: Application Management

104

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Id Numeric Unique identifier of the application

ApplicationName String Desired application name

ApplicationUrl String URL of the application

AssignedDeviceCount Numeric Number of devices assigned with the application

BundleId String Bundle ID of the application from the Play Store for Android

CategoryId Numeric Unique numeric ID of the application category

Name String Name of the application category

Comments String Desired comments for the application

InstalledDeviceCount Numeric Number of devices with application installed

IsReimbursable Boolean Denotes if the application is reimbursable

LocationGroupId Numeric Unique ID of the organization group where the application is uploaded

NotInstalledDeviceCount Numeric Number of devices with application not installed

Platform Numeric Platform of the device

PushMode Numeric Mode of application deployment. For example: "Auto", "OnDemand"

C# Sample Code

using System;

using System.IO;

using System.Net;

using System.Text;

using System.Xml.Serialization;

namespace AirwatchApiClient

{

class Program

{

#region Constants

private const string USER_NAME = "UserName1";

private const string PASSWORD = "Password1";

private const string API_TENANT_CODE = "API-Key";

private const string HOST = "https://host";

private const string MIME_TYPE = "application/xml";

#endregion

public static void InitializeRequest(HttpWebRequest request)

{

request.Headers.Add("aw-tenant-code", API_TENANT_CODE);

request.Credentials = new NetworkCredential(USER_NAME, PASSWORD);

request.KeepAlive = false;

request.AddRange(1024);

request.Timeout = 10000;

Chapter 4: Application Management

105

VMware AirWatch REST API Guide | v.2016.04 | April 2017

}

public static void InsertPublicApplication()

{

try

{

var appEntity = new ApplicationEntity();

appEntity.ApplicationName = "DesiredApplicationName";

appEntity.ExternalId = "Unique ID of the application on the

Application store";

appEntity.Platform = "Platform ID";

appEntity.CategoryList = new CategoryList();

var categoryList = new CategoryList();

var categories = new Category[1];

var category = new Category();

category.Name = "Games";

categories[0] = category;

categoryList.Category = categories;

appEntity.LocationGroupId = 661;

appEntity.PushMode = PushMode.auto;

var request =

WebRequest.Create(HOST + "/api/mam/apps/public") as

HttpWebRequest;

request.Method = "POST";

InitializeRequest(request);

request.ContentType = MIME_TYPE;

var xmlSerializer = new XmlSerializer(typeof

(ApplicationEntity));

string inputString;

using (var writer = new StringWriter())

{

var xmlNamespace = new XmlSerializerNamespaces();

xmlNamespace.Add(string.Empty, Metadata.RESOURCE_NAMESPACE);

xmlSerializer.Serialize(writer, appEntity, xmlNamespace);

inputString = writer.ToString();

}

byte[] requestBytes = Encoding.UTF8.GetBytes(inputString);

request.ContentLength = inputString.Length;

Stream requestStream = request.GetRequestStream();

requestStream.Write(requestBytes, 0, requestBytes.Length);

requestStream.Close();

var response = (HttpWebResponse)request.GetResponse();

Console.WriteLine(new StreamReader(response.GetResponseStream

()).ReadToEnd());

response.Close();

}

catch (WebException e)

{

if (e.Response != null)

Chapter 4: Application Management

106

VMware AirWatch REST API Guide | v.2016.04 | April 2017

{

var errorMessageStream = e.Response.GetResponseStream();

string message = new StreamReader

(errorMessageStream).ReadToEnd();

Console.WriteLine(message);

}

else

{

Console.WriteLine(e.Message);

}

catch (Exception e)

{

Console.WriteLine(e.Message);

}

Chapter 4: Application Management

107

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Public Application (*Refactored)

Functionality – Updates the public application selected by searching for the bundle ID (Android) or external ID (iOS) in the

app market.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/public/{applicationid}/update. This URI will be deprecated soon.

Start using the *Supported API URI henceforth.

*Supported API URI – https://host/api/mam/apps/public/applicationid (HTTP method Used – PUT)

Response Payload – NA

Request Payloads

XML

<ApplicationName>String</ApplicationName>

<BundleId>String</BundleId>

<AppVersion>String</AppVersion>

<ActualFileVersion>String</ActualFileVersion>

<AppType>String</AppType>

<Status>String</Status>

<Platform>Numeric</Platform>

<AssignmentStatus>String</AssignmentStatus>

<ApplicationSize>String</ApplicationSize>

<CategoryId>Numeric</CategoryId>

<Name>String</Name>

</Category>

<CategoryId>Numeric</CategoryId>

<Name>String</Name>

</Category>

</CategoryList>

<Comments>String</Comments>

<IsReimbursable>Boolean</IsReimbursable>

<ApplicationUrl>String</ApplicationUrl>

<LocationGroupId>Numeric</LocationGroupId>

<ExternalId>String</ExternalId>

<LargeIconUri>String</LargeIconUri>

<MediumIconUri>String</MediumIconUri>

<SmallIconUri>String</SmallIconUri>

<PushMode>Numeric</PushMode>

<AssignedDeviceCount>Numeric</AssignedDeviceCount>

<InstalledDeviceCount>Numeric</InstalledDeviceCount>

Chapter 4: Application Management

108

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<NotInstalledDeviceCount>Numeric</NotInstalledDeviceCount>

</ApplicationEntity>

JSON

{

"ActualFileVersion" : "String",

"AppType" : "String",

"AppVersion" : "String",

"ApplicationName" : "String",

"ApplicationSize" : "String",

"ApplicationUrl" : "String",

"AssignedDeviceCount" : Numeric,

"AssignmentStatus" : "String",

"BundleId" : "String",

"CategoryList" : {

"Category" : [

{

"CategoryId" : Numeric,

"Name" : "String"

}

]

"Comments" : "String",

"ExternalId" : "String",

"InstalledDeviceCount" : Numeric,

"IsReimbursable" : Boolean,

"LargeIconUri" : "String",

"LocationGroupId" : Numeric,

"MediumIconUri" : "String",

"NotInstalledDeviceCount" : Numeric,

"Platform" : Numeric,

"PushMode" : Numeric,

"SmallIconUri" : "String",

"Status" : "String"

}

Request Tag Details

Tag Mandatory Description

ActualFileVersion Yes Actual version of the file

AppType Yes Type of the application

AppVersion Yes Version of the application

ApplicationName Yes Name of the application

Chapter 4: Application Management

109

VMware AirWatch REST API Guide | v.2016.04 | April 2017

ApplicationSize Yes Size of the application

ApplicationUrl Yes URI of the application

AssignedDeviceCount Yes Number of devices assigned with the application

AssignmentStatus No Status of the application assignment

BundleId Yes Bundle ID of the application from the Play Store for Android

CategoryId Yes Unique identifier of the application category

Name No Name of the application category

Comments No Desired comments for the application

ExternalId No Track ID of the application from the App Store for iOS

InstalledDeviceCount No Number of devices with assigned application installed

IsReimbursable No Is the Paid Application Reimbursable

LargeIconUri No URI of the large icon for the application

LocationGroupId Yes Unique Numeric ID of the Organization Group where the application is

present

MediumIconUri No URI of the medium icon for the application

NotInstalledDeviceCount No Number of devices with no assigned application installed

Platform Yes Platform ID of the application. Refer Tables for the List of Platform IDs

PushMode Yes Deployment mode for the applications. The values are 'Auto' and 'On

Demand'

SmallIconUri No URI of the small icon for the application

Status No Current Status of the application. "Active" or "Inactive"

Note*: While passing value for <ApplicationUrl>, if the url has "&", replace it with "&". This prevents from

obtaining de-serialization error.

Chapter 4: Application Management

110

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Applications

Functionality – Searches and retrieves the details for both internal and external applications.

HTTP Method – GET

API URI – https://host//api/mam/apps/search?type={type}&applicationtype={applicationtype}&applicationname=

{applicationname}&category={category}&locationgroupid={locationgroupid}&bundleid={bundleid}&platform=

{platform}&model={model}&status={status}&orderby={orderby}&page={page}&pagesize={pagesize}

lExact Match Parameter – type, applicationtype, platform, model, status

lPattern (Contains) Match Parameter – applicationname, Category, locationgroupid, bundleid, page, pagesize,

orderby

Request Body – NA

URI Parameters

Tag Type Description

type String The product type - app or book

Application Type String Type of the application - internal or public

applicationname String Name of the application. Partial search string is allowed

category String Category of the application. For example: Games

locationgroupid String Unique numeric ID of the organization group where the application is

present

ApplicationType String Indicates if the application is "Internal" or "Public"

bundleid String Bundle ID of the application

platform String Application platform. For example: Android, iOS

model String Application model. For example: iPad

status String Returns the application status. All, Active, Inactive, Retired

orderby String The order of the search result. Any of the column parameters

mentioned above can be sent as a parameter

page Numeric Page number of the retrieved response

pagesize Numeric Page Size of the retrieved response

Chapter 4: Application Management

111

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Payload

XML

<ApplicationSearchResult

xmlns="http://www.air-watch.com/servicemodel/resources"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Page>Numeric</Page>

<PageSize>Numeric</PageSize>

<Total>Numeric</Total>

<Id>Numeric</Id>

<ApplicationName>String</ApplicationName>

<BundleId>Numeric</BundleId>

<AppVersion>String</AppVersion>

<ActualFileVersion>String</ActualFileVersion>

<AppType>String</AppType>

<Status>String</Status>

<Platform>Numeric</Platform>

<Model>

<ModelId>Numeric</ModelId>

<ModelName>String</ModelName>

</ApplicationSupportedModel>

</Model>

</SupportedModels>

<AssignmentStatus>String</AssignmentStatus>

<ApplicationSize>String</ApplicationSize>

<CategoryId>Numeric</CategoryId>

<Name>String</Name>

</Category>

</CategoryList>

<Id>Numeric</Id>

<Name>String</Name>

</SmartGroup>

</SmartGroups>

<Comments>String</Comments>

<IsReimbursable>Boolean</IsReimbursable>

<ApplicationUrl>String</ApplicationUrl>

<ApplicationSource>Numeric</ApplicationSource>

<LocationGroupId>Numeric</LocationGroupId>

<ExternalId>Numeric</ExternalId>

Chapter 4: Application Management

112

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<LargeIconUri>String</LargeIconUri>

<MediumIconUri>String</MediumIconUri>

<SmallIconUri>String</SmallIconUri>

<PushMode>String</PushMode>

<AssignedDeviceCount>Numeric</AssignedDeviceCount>

<InstalledDeviceCount>Numeric</InstalledDeviceCount>

<NotInstalledDeviceCount>Numeric</NotInstalledDeviceCount>

<Description>String</Description>

<SupportEmail>String</SupportEmail>

<SupportPhone>String</SupportPhone>

<Developer>String</Developer>

<DeveloperEmail>String</DeveloperEmail>

<DeveloperPhone>String</DeveloperPhone>

<AutoUpdateVersion>Boolean</AutoUpdateVersion>

<LocationGroupId>Numeric</LocationGroupId>

<EnableProvisioning>Boolean</EnableProvisioning>

<FileName>String</FileName>

<SupportedProcessorArchitecture>String</SupportedProcessorArchite

cture>

<CommandLineArguments xmlns="http://www.air-

watch.com/webapi/resources">String</CommandLineArguments>

<InstallTimeoutInMinutes xmlns="http://www.air-

watch.com/webapi/resources">Numeric</InstallTimeoutInMinutes>

<RetryCount xmlns="http://www.air-

watch.com/webapi/resources">Numeric</RetryCount>

<RetryIntervalInMinutes xmlns="http://www.air-

watch.com/webapi/resources">Numeric</RetryIntervalInMinutes>

</MsiDeploymentParamModel>

<IsDependencyFile>Boolean</IsDependencyFile>

<WhenToInstall xmlns="http://www.air-

watch.com/webapi/resources">

<CriteriaType>String</CriteriaType>

<ApplicationIdentifier>String</ApplicationIdent

ifier>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

Chapter 4: Application Management

113

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

</DataContingencies>

<DiskSpaceRequiredInKb>Numeric</DiskSpaceRequiredInKb>

<DevicePowerRequired>Numeric</DevicePowerRequired>

<RamRequiredInMb>Numeric</RamRequiredInMb>

</WhenToInstall>

<HowToInstall xmlns="http://www.air-

watch.com/webapi/resources">

<InstallContext>String</InstallContext>

<InstallCommand>String</InstallCommand>

<AdminPrivileges>Boolean</AdminPrivileges>

<DeviceRestart>String</DeviceRestart>

<RetryCount>Numeric</RetryCount>

<RetryIntervalInMinutes>Numeric</RetryIntervalInMinutes>

<InstallTimeoutInMinutes>Numeric</InstallTimeoutInMinutes>

<InstallerRebootExitCode>String</InstallerRebootExitCode>

<InstallerSuccessExitCode>String</InstallerSuccessExitCod

</HowToInstall>

<WhenToCallInstallComplete xmlns="http://www.air-

watch.com/webapi/resources">

<UseAdditionalCriteria>Boolean</UseAdditionalCriteria>

<IdentifyApplicationBy>String</IdentifyApplicationBy>

<CriteriaType>String</CriteriaType>

<ApplicationIdentifier>String</ApplicationIdentifie

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

Chapter 4: Application Management

114

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

</CriteriaList>

<ScriptType>String</ScriptType>

<CommandToRunTheScript>String</CommandToRunTheScript>

<CustomScriptFileBlodId>Numeric</CustomScriptFileBlodI

<SuccessExitCode>Numeric</SuccessExitCode>

</CustomScript>

</WhenToCallInstallComplete>

</DeploymentOptions>

<AppDependenciesList xmlns="http://www.air-

watch.com/webapi/resources">

<Name>String</Name>

<ApplicationDependencyId>Numeric</ApplicationDependenc

yId>

</ApplicationDependency>

</AppDependenciesList>

<AppTransformsList xmlns="http://www.air-

watch.com/webapi/resources">

<TransformFileName>String</TransformFileName>

<TransformBlobId>Numeric</TransformBlobId>

</ApplicationTransform>

</AppTransformsList>

<AppPatchesList xmlns="http://www.air-

watch.com/webapi/resources">

<PatchFileName>String</PatchFileName>

<PatchBlobId>Numeric</PatchBlobId>

<PatchType>String</PatchType>

<BuildVersion>String</BuildVersion>

</ApplicationPatch>

</AppPatchesList>

<ApplicationUnInstallProcess xmlns="http://www.air-

watch.com/webapi/resources">

<UseCustomScript>Boolean</UseCustomScript>

<CustomScriptType>String</CustomScriptType>

Chapter 4: Application Management

115

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<UninstallCommand>String</UninstallCommand>

<UninstallScriptBlobId>Numeric</UninstallScriptBlobId>

</CustomScript>

</ApplicationUnInstallProcess>

</FilesOptions>

</InternalAppChunkTranscation>

</ApplicationEntity>

</Application>

</ApplicationSearchResult>

JSON

{

"ApplicationName" : "String",

"BundleId" : "String",

"AppVersion" : "String",

"ActualFileVersion" : "String",

"AppType" : "String",

"Status" : "String",

"Platform" : Numeric,

"SupportedModels" : {

"Model" : [

{

"ApplicationId" : Numeric,

"ModelId" : Numeric,

"ModelName" : "String"

}

]

"AssignmentStatus" : "String",

"ApplicationSize" : "String",

"CategoryList" : {

"Category" : [

{

"CategoryId" : Numeric,

"Name" : "String"

}

]

"SmartGroups" : [

{

"Id" : Numeric,

"Name" : "String"

}

"Comments" : "String",

"IsReimbursable" : Boolean,

"ApplicationUrl" : "String",

Chapter 4: Application Management

116

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"ApplicationSource" : Numeric,

"LocationGroupId" : Numeric,

"ExternalId" : "String",

"LargeIconUri" : "String",

"MediumIconUri" : "String",

"SmallIconUri" : "String",

"PushMode" : Numeric,

"AppRank" : Numeric,

"AssignedDeviceCount" : Numeric,

"InstalledDeviceCount" : Numeric,

"NotInstalledDeviceCount" : Numeric,

"Description" : "String",

"SupportEmail" : "String",

"SupportPhone" : "String",

"Developer" : "String",

"DeveloperEmail" : "String",

"DeveloperPhone" : "String",

"AutoUpdateVersion" : Boolean,

"EnableProvisioning" : Boolean,

"SupportedProcessorArchitecture" : "String",

"MsiDeploymentParamModel" : {

"CommandLineArguments" : "String",

"InstallTimeoutInMinutes" : Numeric,

"RetryCount" : Numeric,

"RetryIntervalInMinutes" : Numeric

"IsDependencyFile" : Boolean,

"DeploymentOptions" : {

"WhenToInstall" : {

"DataContingencies" : [

{

"CriteriaType" : "Unknown",

"AppCriteria" : {

"ApplicationIdentifier" : "String",

"VersionCondition" : "Unknown",

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"BuildNumber" : Numeric

"FileCriteria" : {

"Path" : "String",

"VersionCondition" : "Unknown",

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"BuildNumber" : Numeric,

"ModifiedOn" : "String"

"RegistryCriteria" : {

"Path" : "String",

Chapter 4: Application Management

117

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"KeyName" : "String",

"KeyType" : "Unknown",

"KeyValue" : "String"

"LogicalCondition" : "Unknown"

{

"CriteriaType" : "Unknown",

"AppCriteria" : {

"ApplicationIdentifier" : "String",

"VersionCondition" : "Unknown",

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"BuildNumber" : Numeric

"FileCriteria" : {

"Path" : "String",

"VersionCondition" : "Unknown",

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"BuildNumber" : Numeric,

"ModifiedOn" : "String"

"RegistryCriteria" : {

"Path" : "String",

"KeyName" : "String",

"KeyType" : "Unknown",

"KeyValue" : "String"

"LogicalCondition" : "Unknown"

}

"DiskSpaceRequiredInKb" : Numeric,

"DevicePowerRequired" : Numeric,

"RamRequiredInMb" : Numeric

"HowToInstall" : {

"InstallContext" : "Unknown",

"InstallCommand" : "String",

"AdminPrivileges" : Boolean,

"DeviceRestart" : "Unknown",

"RetryCount" : Numeric,

"RetryIntervalInMinutes" : Numeric,

"InstallTimeoutInMinutes" : Numeric,

"InstallerRebootExitCode" : "String",

"InstallerSuccessExitCode" : "String"

"WhenToCallInstallComplete" : {

"UseAdditionalCriteria" : Boolean,

Chapter 4: Application Management

118

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"IdentifyApplicationBy" : "Unknown",

"CriteriaList" : [

{

"CriteriaType" : "Unknown",

"AppCriteria" : {

"ApplicationIdentifier" : "String",

"VersionCondition" : "Unknown",

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"BuildNumber" : Numeric

"FileCriteria" : {

"Path" : "String",

"VersionCondition" : "Unknown",

"MajorVersion" : Numeric

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"BuildNumber" : Numeric,

"ModifiedOn" : "String"

"RegistryCriteria" : {

"Path" : "String",

"KeyName" : "String",

"KeyType" : "Unknown",

"KeyValue" : "String"

"LogicalCondition" : "Unknown"

}

"CustomScript" : {

"ScriptType" : "Unknown",

"CommandToRunTheScript" : "String",

"CustomScriptFileBlodId" : Numeric

"SuccessExitCode" : Numeric

}

"FilesOptions" : {

"AppDependenciesList" : [

{

"Name" : "String",

"ApplicationDependencyId" : Numeric

}

"AppTransformsList" : [

{

"TransformFileName" : "String",

"TransformBlobId" : Numeric

}

Chapter 4: Application Management

119

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"AppPatchesList" : [

{

"PatchFileName" : "String",

"PatchBlobId" : Numeric,

"PatchType" : "Unknown",

"BuildVersion" : "String"

}

"ApplicationUnInstallProcess" : {

"UseCustomScript" : Boolean,

"CustomScript" : {

"CustomScriptType" : "Unknown",

"UninstallCommand" : "String",

"UninstallScriptBlobId" : Numeric

}

"Id" : {

"Value" : Numeric

}

"Page" : Numeric,

"PageSize" : Numeric,

"Total" : Numeric

}

Response Tag Details

Tag Type Description

ApplicationName String Name of the application

BundleId Numeric Bundle ID of the application

AppVersion String Version of the application

AppType String Type of the application. "Public" or "Internal"

Status String Current Status of the application. "Active" or "Inactive"

Platform Numeric Platform ID of the application. Refer Tables for the List of Platform

IDs

ModelId Numeric ID of the Device Model. Refer Tables for the List of Model IDs

ModelName String Name of the Device Model

AssignmentStatus String Current assignment state of the application. "Assigned" or "Not

Assigned"

ApplicationSize Numeric Size of the application. Bytes, KB, MB, GB

CategoryId Numeric Numeric ID of the Category of the application

Chapter 4: Application Management

120

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Name String Category name of the application

SmartGroups Id Numeric Numeric ID of the smart group

SmartGroups Name String Unique name of the smart group

Comments String The comments associated with the public applications

IsReimbursable Boolean Is the Paid Application Reimbursable. True or False

ApplicationUrl String URL of a Public Application

LocationGroupId Numeric Unique Numeric ID of the Organization Group where the

application is present

ExternalId Numeric Is the track ID of the application from the App Store for iOS

PushMode String Deployment mode for the applications. The values are 'Auto' and

'On Demand'

Page Numeric Page Number

PageSize Numeric Size of the current page

Total Numeric Total Results obtained from the search

LargeIconUri String URL of the large icon for the application

SmallIconUri String URL of the small icon for the application

MediumIconUri String URL of the medium icon for the application

AssignedDeviceCount Numeric Number of devices with application assigned

InstalledDeviceCount Numeric Number of devices with assigned application installed

NotInstalledDeviceCount Numeric Number of devices with no assigned application installed

SupportEmail String User defined email address of support

SupportPhone String User defined phone number of support

Developer String Name of the developer

DeveloperEmail String Email address of the developer

DeveloperPhone Numeric Phone number of the developer

AutoUpdateVersion Boolean Is auto update of devices required. True or False

EnableProvisioning Booelan Provisioning status. Supported value is True or False.

SupportedProcessorArchitecture String The architecture type of the end user devices that the application

supports

CommandLineArguments String Command-line options to be used when calling MSIEXEC.exe

InstallTimeoutInMinutes Numeric 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 Numeric The number of times the download and installation operation will

be retried before the installation will be marked as failed.

Chapter 4: Application Management

121

VMware AirWatch REST API Guide | v.2016.04 | April 2017

RetryIntervalInMinutes Numeric Amount of time, in minutes between retry operations.

CriteriaType String Unique smart group type configured to the smart group

ApplicationIdentifier String Unique identifier of the application (Bundle ID or External ID)

VersionCondition String Version conditions

MajorVersion Numeric Major version of the application

MinorVersion Numeric Minor version of the application

BuildNumber Numeric Build version of the application

RevisionNumber Numeric Fix version of the application

FileCriteria String File criteria

Path String Path of the file

VersionCondition String Version Conditions

MajorVersion Numeric Major version of the file

MinorVersion Numeric Minor version of the file

RevisionNumber Numeric Fix version of the application

BuildNumber Numeric Build version of the application

ModifiedOn String Date on which the file was last modified

RegistryCriteria String Registry criteria

Path String Path of the key in the registry

Keyname String Name of the key to be created in the registry

Keytype String Type of key to be created in the registry

KeyValue String Value of the key to be created in the registry

ScriptType String Script Type. Supported script types are JScript, PowerShell, and

VBScript.

CommandToRunTheScript String Command to run the script

CustomScriptFileBlodId Numeric Blob ID of the script file associated. Supported file types are js,

.jse, .ps1, .ps1xml, .psc1, .psd1, .psm1, .pssc, .cdxml, .vbs, .vbe,

.wsf, and .wsc.

SuccessExitCode Numeric Success exit code

Name String File name

ApplicationDependencyId Numeric Application dependency identifier

TransformFileName String File name of the trasnform

TransformBlobId Numeric Blob ID of the uploaded Transform

PatchFileName String Name of the patch file

PatchBlobId Numeric Blob ID of the uploaded Patch

Chapter 4: Application Management

122

VMware AirWatch REST API Guide | v.2016.04 | April 2017

PatchType String Type of the uploaded patch

BuildVersion String Build version of the application

UseCustomScript Boolean Value indicating whether custom script is used or not

CustomScriptType String Custom script type. Supported values are Input and Upload

UninstallCommand String Application uninstall command provided

UninstallScriptBlobId Numeric

Chapter 4: Application Management

123

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Play Store for Applications (*Refactored)

Functionality – Searches Google Play Store for the applications with the specified search string and returns the details.

The Bundle ID returned can then be used in the "BundleId " parameter in the Insert Public application API.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/playstoresearch?appname={name}. This URI will be deprecated

soon. Start using the *Supported API URI .

lPattern (Contains) Match Parameter – appname

*Supported API URI – https://host/api/mam/apps/playstore/search (HTTP Method Used – GET)

Request Body – NA

URI Parameters

Tag Type Description

name String Application name to be searched in Play Store

Response Payload

XML

<AppStoreSearchResults xmlns="http://www.air-

watch.com/servicemodel/resources">

<BundleID>String</BundleID>

<ApplicationName>String</ApplicationName>

<CurrentVersion>String</CurrentVersion>

</AppStoreApplicationDetails>

</Applications>

</AppStoreSearchResults>

JSON

{

"Applications":[{

"BundleID":"String",

"ApplicationName":"String",

"CurrentVersion":"String"

}]

}

Chapter 4: Application Management

124

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Tag Details

Tag Type Description

BundleID String Package ID of the Android application

ApplicationName String Name of the application

CurrentVersion String Current version of the application

Chapter 4: Application Management

125

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Windows App Store for Applications (*Refactored)

Functionality – Searches Windows Store for the applications with the specified search string and returns the details. The

Bundle ID returned can then be used in the "BundleId " parameter in the Insert Public application API.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/windowsstoresearch?appname={appname}&platform={platform}.

lExact Match Parameter – platform

lPattern (Contains) Match Parameter – appname

This URI will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/windowsstore/search (HTTP Method Used – GET)

Request Body – NA

URI Parameters

Tag Type Description

appname String Name of the application to be searched

platform String Platform of the device

Response Payload

XML

<AppStoreSearchResults xmlns="http://www.air-

watch.com/servicemodel/resources">

<BundleID>String</BundleID>

<ApplicationName>String</ApplicationName>

<CurrentVersion>String</CurrentVersion>

</AppStoreApplicationDetails>

</Applications>

</AppStoreSearchResults>

JSON

{

"Applications":[{

"BundleID":"String",

"ApplicationName":"String",

Chapter 4: Application Management

126

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"CurrentVersion":"String"

}]

}

Response Tag Details

Tag Type Description

BundleID String Bundle ID of the Windows application

ApplicationName String Name of the application

CurrentVersion String Current version of the application

Chapter 4: Application Management

127

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Apple App Store for Applications (*Refactored)

Functionality – Searches Apple Store for the applications with the specified search string and returns the details. The

External ID returned in this APIs response can be used in the "ExternaID" parameter in the Insert Public application API.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/applestoresearch?appname={name}. This URI will be deprecated

soon. Start using the *Supported API URI henceforth.

lPattern (Contains) Match Parameter – appname

*Supported API URI – https://host/api/mam/apps/applestore/search (HTTP Method Used – GET)

Request Body – NA

URI Parameters

Tag Type Description

appname String Name of the application to be searched

Response Payload

XML

<AppStoreSearchResults xmlns="http://www.air-

watch.com/servicemodel/resources">

<BundleID>String</BundleID>

<ApplicationName>String</ApplicationName>

<CurrentVersion>String</CurrentVersion>

<ExternalID>Numeric</ExternalID>

</AppStoreApplicationDetails>

</Applications>

</AppStoreSearchResults>

JSON

{

"Applications":[{

"BundleID":"String",

"ApplicationName":"String",

"CurrentVersion":"String",

"ExternalID":Numeric,

}]

Chapter 4: Application Management

128

VMware AirWatch REST API Guide | v.2016.04 | April 2017

}

Response Tag Details

Tag Type Description

BundleID Numeric Bundle ID of the iOS Application

ApplicationName String Name of the application

CurrentVersion String Current version of the application

ExternalID Numeric Numeric Track ID of the iOS application in the app store.

Chapter 4: Application Management

129

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Activate Internal Application

Functionality – Activates an internal application identified by its application ID.

HTTP Method – POST

API URI – https://host/api/mam/apps/Internal/{Applicationid}/Activate

Request Body – NA

Response Obtained – NA

Chapter 4: Application Management

130

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Internal Application

Functionality – Updates the internal application identified by application ID.

HTTP Method – PUT

API URI – https://host/api/mam/apps/internal/{applicationId}

URI Parameter

Tag Type Description

applicationid Numeric Unique internal application identifier to be updated

Response Obtained – NA

Request Payload

XML

<ApplicationName>String</ApplicationName>

<ApplicationSource>Numeric</ApplicationSource>

<PushMode>String</PushMode>

<Description>String</Description>

<SupportEmail>String</SupportEmail>

<SupportPhone>String</SupportPhone>

<Developer>String</Developer>

<DeveloperEmail>String</DeveloperEmail>

<DeveloperPhone>String</DeveloperPhone>

<AutoUpdateVersion>Boolean</AutoUpdateVersion>

<EnableProvisioning>Boolean</EnableProvisioning>

<SupportedProcessorArchitecture>String</SupportedProcessorArchitecture>

<CommandLineArguments xmlns="http://www.air-

watch.com/webapi/resources">String</CommandLineArguments>

<InstallTimeoutInMinutes xmlns="http://www.air-

watch.com/webapi/resources">Numeric</InstallTimeoutInMinutes>

<RetryCount xmlns="http://www.air-

watch.com/webapi/resources">Numeric</RetryCount>

<RetryIntervalInMinutes xmlns="http://www.air-

watch.com/webapi/resources">Numeric</RetryIntervalInMinutes>

</MsiDeploymentParamModel>

<IsDependencyFile>Boolean</IsDependencyFile>

<CriteriaType>String</CriteriaType>

Chapter 4: Application Management

131

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<ApplicationIdentifier>String</ApplicationIdentifier>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

<CriteriaType>String</CriteriaType>

<ApplicationIdentifier>String</ApplicationIdentifier>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

Chapter 4: Application Management

132

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</DataContingencies>

<DiskSpaceRequiredInKb>Numeric</DiskSpaceRequiredInKb>

<DevicePowerRequired>Numeric</DevicePowerRequired>

<RamRequiredInMb>Numeric</RamRequiredInMb>

</WhenToInstall>

<InstallContext>String</InstallContext>

<InstallCommand>String</InstallCommand>

<AdminPrivileges>Boolean</AdminPrivileges>

<DeviceRestart>String</DeviceRestart>

<RetryCount>Numeric</RetryCount>

<RetryIntervalInMinutes>Numeric</RetryIntervalInMinutes>

<InstallTimeoutInMinutes>Numeric</InstallTimeoutInMinutes>

<InstallerRebootExitCode>String</InstallerRebootExitCode>

<InstallerSuccessExitCode>String</InstallerSuccessExitCode>

</HowToInstall>

<WhenToCallInstallComplete xmlns="http://www.air-

watch.com/webapi/resources">

<UseAdditionalCriteria>Boolean</UseAdditionalCriteria>

<IdentifyApplicationBy>String</IdentifyApplicationBy>

<CriteriaType>String</CriteriaType>

<ApplicationIdentifier>String</ApplicationIdentifier>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

<CriteriaType>String</CriteriaType>

Chapter 4: Application Management

133

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<ApplicationIdentifier>String</ApplicationIdentifier>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

</CriteriaList>

<ScriptType>String</ScriptType>

<CommandToRunTheScript>String</CommandToRunTheScript>

<CustomScriptFileBlodId>Numeric</CustomScriptFileBlodId>

<SuccessExitCode>Numeric</SuccessExitCode>

</CustomScript>

</WhenToCallInstallComplete>

</DeploymentOptions>

<Name>String</Name>

<ApplicationDependencyId>Numeric</ApplicationDependencyId>

</ApplicationDependency>

<Name>String</Name>

<ApplicationDependencyId>Numeric</ApplicationDependencyId>

</ApplicationDependency>

</AppDependenciesList>

<TransformFileName>String</TransformFileName>

<TransformBlobId>Numeric</TransformBlobId>

</ApplicationTransform>

<TransformFileName>String</TransformFileName>

Chapter 4: Application Management

134

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<TransformBlobId>Numeric</TransformBlobId>

</ApplicationTransform>

</AppTransformsList>

<PatchFileName>String</PatchFileName>

<PatchBlobId>Numeric</PatchBlobId>

<PatchType>String</PatchType>

<BuildVersion>String</BuildVersion>

</ApplicationPatch>

<PatchFileName>String</PatchFileName>

<PatchBlobId>Numeric</PatchBlobId>

<PatchType>String</PatchType>

<BuildVersion>String</BuildVersion>

</ApplicationPatch>

</AppPatchesList>

<ApplicationUnInstallProcess xmlns="http://www.air-

watch.com/webapi/resources">

<UseCustomScript>Boolean</UseCustomScript>

<CustomScriptType>String</CustomScriptType>

<UninstallCommand>String</UninstallCommand>

<UninstallScriptBlobId>Numeric</UninstallScriptBlobId>

</CustomScript>

</ApplicationUnInstallProcess>

</FilesOptions>

</ApplicationEntity>

JSON

{

"AppRank" : Numeric,

"ApplicationName" : "String",

"ApplicationSource" : Numeric,

"AutoUpdateVersion" : Boolean,

"DeploymentOptions" : {

"HowToInstall" : {

"AdminPrivileges" : Boolean,

"DeviceRestart" : "String",

"InstallCommand" : "String",

"InstallContext" : "String",

"InstallTimeoutInMinutes" : Numeric,

"InstallerRebootExitCode" : "String",

"InstallerSuccessExitCode" : "String",

"RetryCount" : Numeric,

"RetryIntervalInMinutes" : Numeric

Chapter 4: Application Management

135

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"WhenToInstall" : {

"DataContingencies" : [

{

"AppCriteria" : {

"ApplicationIdentifier" : "String",

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"CriteriaType" : "String",

"FileCriteria" : {

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"ModifiedOn" : "String",

"Path" : "String",

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"LogicalCondition" : "String",

"RegistryCriteria" : {

"KeyName" : "String",

"KeyType" : "String",

"KeyValue" : "String",

"Path" : "String"

}

"DevicePowerRequired" : Numeric,

"DiskSpaceRequiredInKb" : Numeric,

"RamRequiredInMb" : Numeric

}

"Description" : "String",

"Developer" : "String",

"DeveloperEmail" : "String",

"DeveloperPhone" : "String",

"EnableProvisioning" : Boolean,

"FilesOptions" : {

"AppDependenciesList" : [

{

"ApplicationDependencyId" : Numeric

}

"AppPatchesList" : [

{

"PatchBlobId" : Numeric,

"PatchType" : "String"

}

Chapter 4: Application Management

136

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"AppTransformsList" : [

{

"TransformBlobId" : Numeric

}

"ApplicationUnInstallProcess" : {

"CustomScript" : {

"CustomScriptType" : "String",

"UninstallCommand" : "String",

"UninstallScriptBlobId" : Numeric

"UseCustomScript" : Boolean

}

"IsDependencyFile" : Boolean,

"MsiDeploymentParamModel" : {

"CommandLineArguments" : "String",

"InstallTimeoutInMinutes" : Numeric,

"RetryCount" : Numeric,

"RetryIntervalInMinutes" : Numeric

"PushMode" : String,

"SupportEmail" : "String",

"SupportPhone" : "String",

"SupportedProcessorArchitecture" : "String"

}

Request Tag Details

Tag Description

AppRank Application Rank

ApplicationName Desired Application Name

ApplicationSource ApplicationSource

AutoUpdateVersion Defines if the application can be updated automatically. Boolean/False

DeploymentOptions Deployment options for the application

AdminPrivileges Whether or not the installation should be initiated with logged-in user privileges or

with stepped up administrative permissions

DeviceRestart Restart the device after the application is installed

InstallCommand Install program to meet your deployment criteria

InstallContext Indicate whether the app should be configured and installed for just enrolled users

or for all users on each of your devices

InstallTimeoutInMinutes Amount of time, in minutes, that the installation process can run before the

installation is considered as failed

Chapter 4: Application Management

137

VMware AirWatch REST API Guide | v.2016.04 | April 2017

InstallerRebootExitCode Integer code returned by the installer to indicate that the app has been

successfully installed once the device has been rebooted. This will be used in

conjunction with the 'Device Restart' option specified above.

InstallerSuccessExitCode Integer code returned by the installer that marks the success of the operation

RetryCount Number of retries for installing application before the installation is marked as

failed

RetryIntervalInMinutes Amount of time, in minutes, between retries for installing application

AppCriteria Application criteria

ApplicationIdentifier Unique identifier of the application (Bundle ID or External ID)

BuildNumber Build version of the application

MajorVersion Major version of the application

MinorVersion Minor version of the application

RevisionNumber Fix version of the application

VersionCondition Version condition. Supported values are Any, EqualTo, GreaterThan, and

LessThan.

CriteriaType Criteria type. Supported values are AppExists, AppDoesNotExist, FileExists,

FileDoesNotExist, RegistryExists, and RegistryDoesNotExist.

FileCriteria File Criteria

BuildNumber Build version of the file

MajorVersion Major version of the file

MinorVersion Minor version of the file

ModifiedOn Date on which the file was last modified

Path Path of the file

RevisionNumber Fix version of the application

VersionCondition Version condition. Supported values are Any, EqualTo, GreaterThan, and

LessThan.

LogicalCondition Logical condition. Supported values are And and Or.

RegistryCriteria Registry Criteria

KeyType Type of key to be created in the registry. Supported values are String, Binary,

DWord, QWord, MultiString, and ExpandableString.

KeyValue Value of the key to be created in the registry

Path Path of the key in the registry

CommandToRunTheScrip Command to run the script

CustomScriptFileBlodId Blob ID of the script file associated. Supported file types are .js, .jse, .ps1, .ps1xml,

.psc1, .psd1, .psm1, .pssc, .cdxml, .vbs, .vbe, .wsf, and .wsc.

ScriptType Script Type.Supported script types are JScript, PowerShell, and VBScript.

Chapter 4: Application Management

138

VMware AirWatch REST API Guide | v.2016.04 | April 2017

SuccessExitCode Success exit code

IdentifyApplicationBy The way by which an application can be identified. Supported Values are

DefiningCriteria and UsingCustomScript.

UseAdditionalCriteria Msi apps are detected on the device by product code and version. Use this option

to perform additional actions to ensure your app is successfully installed on your

end users' devices.

DataContingencies Define and set one or more conditions when apps should be installed on your end

users’ devices. If multiple conditions exist, they will be executed in priority order

from top to bottom.

DevicePowerRequired The minimum percentage of power required by the device for installing the

application

DiskSpaceRequiredInKb The amount of disk space required for the successful installation of the application

RamRequiredInMb RAM (in MB) required for installing the application

Description Description of the application on what the application does and how it can be used

Developer Name of the developer

DeveloperEmail Email address of the developer

DeveloperPhone Phone number of the developer

DeviceType Numeric Platform identifier of the Device Application

EnableProvisioning Provisioning status. Supported value is Boolean/False.

FileName File name along with the extension

FilesOptions Application files options

AppDependenciesList List of application dependency identifiers

ApplicationDependencyId Application dependency identifier

AppPatchesList List of uploaded patch files

PatchBlobId Blob ID of the uploaded Patch

PatchType Type of the uploaded patch

AppTransformsList List of uploaded transform files

TransformBlobId Blob ID of the uploaded Transform

ApplicationUnInstallProcess Application uninstallation process

CustomScript Custom script

CustomScriptType Custom script type. Supported values: Input, Upload.

UninstallCommand Application uninstall command provided

UninstallScriptBlobId Gets or sets the identifier value of the uninstall script file uploaded on the console.

Supported file types are .js, .jse, .ps1, .ps1, .xml, .psc1, .psd1, .psm1, .pssc, .cdxml,

.vbs, .vbe, .wsf,and .wsc.

UseCustomScript Value indicating whether custom script is used or not

Chapter 4: Application Management

139

VMware AirWatch REST API Guide | v.2016.04 | April 2017

IsDependencyFile Indicates whether uploaded file is a dependency file

LocationGroupId Location group identifier

MsiDeploymentParamModel Msi deployment Parameter model. This is valid only for MSI files when Software

Distribution is not enabled.

CommandLineArguments Command-line options to be used when calling MSIEXEC.exe

InstallTimeoutInMinutes 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. Range : 0-60.

RetryCount The number of times the download and installation operation will be retried before

the installation will be marked as failed. With a limit of ‘10' attempts.

RetryIntervalInMinutes Amount of time, in minutes between retry operations. The range is 0 through 10.

PushMode Deployment mode for the applications. The values are 'auto' and 'ondemand’.

SupportEmail User defined email address of support

SupportPhone User defined phone number of support

SupportedProcessorArchitecture The architecture type of the end user devices that the application supports

Chapter 4: Application Management

140

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Activate Public Application

Functionality – Activates a public application identified by its application ID.

HTTP Method – POST

API URI – https://host/api/mam/apps/Public/{Applicationid}/Activate

Request Body – NA

Response Obtained – NA

Chapter 4: Application Management

141

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Deactivate Internal Application

Functionality – Deactivates an internal application identified by its application ID.

HTTP Method – POST

API URI – https://host/api/mam/apps/Internal/{Applicationid}/Deactivate

Response Obtained – NA

Request payload – NA

Deactivate Public Application

Functionality – Deactivates a public application identified by its application ID.

HTTP Method – POST

API URI – https://host/api/mam/apps/Public/{Applicationid}/Deactivate

Response Obtained – NA

Request payload – NA

Chapter 4: Application Management

142

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retire Internal Application

Functionality – Retires an internal application identified by its application ID.

HTTP Method – POST

API URI – https://host/api/mam/apps/Internal/{Applicationid}/retire

Request Body – NA

Response Obtained – NA

Unretire Internal Application

Functionality – Unretires an internal application identified by its application ID.

HTTP Method – POST

API URI – https://host/api/mam/apps/Internal/{Applicationid}/unretire

Request Body – NA

Response Obtained – NA

Chapter 4: Application Management

143

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Assign Smart Group to an Internal Application (*Refactored)

Functionality – Assigns a smart group to an internal application.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/internal/{ApplicationId}/addsmartgroup/{SmartgroupId}. This URI

will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/internal/{applicationid}/smartgroups/{smartgroupid} (HTTP

Method Used – POST)

Request Body – NA

Response Obtained – NA

URI Parameters

Tag Type Description

ApplicationId Numeric Unique identifier of the application

SmartGroupId Numeric Unique identifier of the Smart Group

Assign Smart Group to a Public Application (*Refactored)

Functionality – Assigns a smart group to a public application.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/public/{ApplicationId}/addsmartgroup/{SmartgroupId}. This URI will

be deprecated soon. Instead, use the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/public/{applicationid}/smartgroups/{smartgroupid} (HTTP Method

Used – POST)

Request Body – NA

Response Obtained – NA

URI Parameters

Tag Type Description

ApplicationId Numeric Unique numeric ID of the application

SmartGroupId Numeric Unique numeric ID of the Smart Group

Assign Smart Group to BSP Application (Version 2)

Functionality – Assigns smart groups to an BSP application.

HTTP Method – POST

API URI – https://host/api/mam/apps/public/{applicationid}/bspsmartgroups?offlinesmartgroupid=

{offlinesmartgroupid}?&onlinesmartgroupid={onlinesmartgroupid}&type={type}

URI Parameters

Chapter 4: Application Management

144

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Tag Type Description

applicationId Numeric Unique identifier of the application

offlinesmartgroupid String Offline smart group Identifier

onlinesmartgroupid String Online smart group Identifier

type String Type is {harmony/airwatch}

Request Payload – NA

Response Obtained – NA

Chapter 4: Application Management

145

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Remove Smart Group Assignment From an Internal Application (*Refactored)

Functionality – Removes a smart group assigned to an internal application.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/internal/{ApplicationId}/deletesmartgroup/{SmartgroupId}. This URI

will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/internal/{applicationid}/smartgroups/{smartgroupid} (HTTP

Method Used – DELETE)

Request Body – NA

Response Obtained – NA

URI Parameters

Tag Type Description

ApplicationId Numeric Unique numeric ID of the application

SmartGroupId Numeric Unique numeric ID of the Smart Group

Remove Smart Group Assignment From a Public Application (*Refactored)

Functionality – Removes a smart group assigned to a public application.

HTTP Methods – POST

Deprecated API URI – https://host/api/mam/apps/public/{ApplicationId}/deletesmartgroup/{SmartgroupId}. This URI

will be deprecated soon. Instead, use the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/public/{applicationid}/smartgroups/{smartgroupid} (HTTP Method

Used – DELETE)

Request Body – NA

Response Obtained – NA

URI Parameters

Tag Type Description

ApplicationId Numeric Unique numeric ID of the application

SmartGroupId Numeric Unique numeric ID of the Smart Group

Chapter 4: Application Management

146

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Install Internal Application on Device

Functionality – Installs an internal application the device.

HTTP Method – POST

API URI – https://host/api/mam/apps/internal/{applicationid}/install

Response Obtained – NA

Request Payload

XML

<DeviceId>Numeric</DeviceId>

<Udid>String</Udid>

<SerialNumber>String</SerialNumber>

<MacAddress>String</MacAddress>

</DeviceInfo>

JSON

{

"DeviceId":Numeric,

"Udid":"String",

"SerialNumber":"String",

"MacAddress":"String"

}

Request Tag Details

Tag Mandatory Description

DeviceId No Unique numeric ID of the device

Udid No UDID of the device

SerialNumber No Serial number of device

MacAddress No MAC address of device

Important: The user needs to pass only one of the above device parameters in the Request Payload.

Chapter 4: Application Management

147

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Install Public Application on Device

Functionality – Installs a public application on a device.

HTTP Method – POST

API URI – https://host/api/mam/apps/public/{applicationid}/install

Response Obtained – NA

Request Payload

XML

<DeviceId>Numeric</DeviceId>

<Udid>String</Udid>

<SerialNumber>String</SerialNumber>

<MacAddress>String</MacAddress>

</DeviceInfo>

JSON

{

"DeviceId":Numeric,

"Udid":"String",

"SerialNumber":"String",

"MacAddress":"String"

}

Request Tag Details

Tag Mandatory Description

DeviceId No Unique numeric ID of the device

Udid No UDID of the device

SerialNumber No Serial number of device

MacAddress No MAC address of device

Important: The user needs to pass only one of the above device parameters in the Request Payload.

Chapter 4: Application Management

148

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Install Purchased Application on the Device

Functionality – Installs the specified purchased application on the device.

HTTP Method – POST

API URI – https://host/api/mam/apps/purchased/{applicationid}/install

Response Obtained – NA

Request Payload

XML

<DeviceId>Numeric</DeviceId>

<Udid>String</Udid>

<SerialNumber>String</SerialNumber>

<MacAddress>String</MacAddress>

</DeviceInfo>

JSON

{

"DeviceId":Numeric,

"Udid":"String",

"SerialNumber":"String",

"MacAddress":"String"

}

Request Tag Details

Tag Mandatory Description

DeviceId No Unique identification number of the device

Udid No Udid of the device

SerialNumber No Serial number of the device

MacAddress No Mac address of the device

Chapter 4: Application Management

149

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Uninstall Internal Application From the Device

Functionality – Removes an internal application from a device.

HTTP Method – POST

API URI – https://host/api/mam/apps/internal/{applicationid}/uninstall

Response Obtained – NA

Request Payload

XML

<DeviceId>Numeric</DeviceId>

<Udid>String</Udid>

<SerialNumber>String</SerialNumber>

<MacAddress>String</MacAddress>

</DeviceInfo>

JSON

{

"DeviceId":Numeric,

"Udid":"String",

"SerialNumber":"String",

"MacAddress":"String"

}

Request Tag Details

Tag Mandatory Description

DeviceId No Unique numeric ID of the device

Udid No UDID of the device

SerialNumber No Serial number of device

MacAddress No MAC address of device

Important: The user needs to pass only one of the above device parameters in the Request Payload.

Chapter 4: Application Management

150

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Uninstall Public Application From the Device

Functionality – Removes a public application from a device.

HTTP Method – POST

API URI – https://host/api/mam/apps/public/{applicationid}/uninstall

Response Obtained – NA

Request Payload

XML

<DeviceId>Numeric</DeviceId>

<Udid>String</Udid>

<SerialNumber>String</SerialNumber>

<MacAddress>String</MacAddress>

</DeviceInfo>

JSON

{

"DeviceId":Numeric,

"Udid":"String",

"SerialNumber":"String",

"MacAddress":"String"

}

Request Tag Details

Tag Mandatory Description

DeviceId No Unique numeric ID of the device

Udid No UDID of the device

SerialNumber No Serial number of the device

MacAddress No MAC address of the device

Important: The user needs to pass only one of the above device parameters in the Request Payload.

Chapter 4: Application Management

151

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Uninstall Purchased Application From the Device

Functionality – Uninstalls the specified purchased application from a device.

HTTP Method – POST

API URI – https://host/api/mam/apps/purchased/{applicationid}/uninstall

Response Obtained – NA

Request Payload

XML

<DeviceId>Numeric</DeviceId>

<Udid>String</Udid>

<SerialNumber>String</SerialNumber>

<MacAddress>String</MacAddress>

</DeviceInfo>

JSON

{

"DeviceId":Numeric,

"Udid":"String",

"SerialNumber":"String",

"MacAddress":"String"

}

Request Tag Details

Tag Mandatory Description

DeviceId No Unique identification number of the device

Udid No Udid of the device

SerialNumber No Serial number of the device

MacAddress No Mac address of the device

Chapter 4: Application Management

152

VMware AirWatch REST API Guide | v.2016.04 | April 2017

View Internal Application Status on the Device

Functionality – Indicates the status of an internal application on a device.

HTTP Method – POST

API URI – https://host/api/mam/apps/Internal/{applicationid}/status?deviceid={deviceid}&macaddress=

{macaddress}&serialnumber={serialnumber}&udid={udid}

lPattern (Contains) Match Parameter – deviceid, macaddress, serialnumber, udid

Request Payload – NA

URI Parameters

Tag Mandatory Description

DeviceId No Unique numeric ID of the device

Udid No UDID of the device

SerialNumber No Serial number of the device

MacAddress No MAC address of the device

Important: The user needs to pass only one of the above device parameters in the URL.

Response Payload

XML

<string>String</string>

JSON

{

"String"

}

Response Tag Details

Tag Type Description

String String Status of the internal application

Chapter 4: Application Management

153

VMware AirWatch REST API Guide | v.2016.04 | April 2017

View Public Application Status on the Device

Functionality – Indicates the status of a public application on a device.

HTTP Method – POST

API URI – https://host/api/mam/apps/public/{applicationid}/status?deviceid={deviceid}&macaddress=

{macaddress}&serialnumber={serialnumber}&udid={udid}

lPattern (Contains) Match Parameter – deviceid, macaddress, serialnumber, udid

Request Payload – NA

URI Parameters

Tag Mandatory Description

DeviceId No Unique numeric ID of the device

Udid No UDID of the device

SerialNumber No Serial number of the device

MacAddress No MAC address of the device

Important: The user needs to pass only one of the above device parameters in the URL.

Response Payload

XML

<string>String</string>

JSON

{

"String"

}

Response Tag Details

Tag Type Description

String String Status of the internal application

Chapter 4: Application Management

154

VMware AirWatch REST API Guide | v.2016.04 | April 2017

View Purchased Application Status on Device

Functionality – Indicates the status of the specified purchased application on a device.

HTTP Method – GET

API URI – https://host/api/mam/apps/purchased/{applicationid}/status?deviceid={deviceid}&macaddress=

{macaddress}&serialnumber={serialnumber}&udid={udid}

lPattern (Contains) Match Parameter – deviceid, macaddress, serialnumber, udid

Request – N/A

URL Parameters

Tag Mandatory Description

DeviceId No Unique numeric ID of the device

Udid No UDID of the device

SerialNumber No Serial number of the device

MacAddress No MAC address of the device

Important: The user needs to pass only one of the above device parameters in the URL.

Response Payload

XML

<string>String</string>

JSON

"String"

Response Tag Details

Tag Type Description

String String The status of the device

Chapter 4: Application Management

155

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Application Details

Functionality – Retrieves the application details.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/{udid}/{appId}/{appType}/{deviceType}/appDetails. Start using the

*Supported API URI.

*Supported API URI – https://host/api/mam/apps/udid/appid/apptype/devicetype

Request Body – NA

URI Parameters

Tag Type Description

udid String Udid of the device

appId Numeric Unique identifier of the application

apptype String Type of the application

deviceType String Device Type

Response Payload

XML

<AppDetailCatalogResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-

instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<Id>Numeric</Id>

<Type>String</Type>

<Name>String</Name>

<InstallState>String</InstallState>

<Description>String</Description>

<string>String</string>

</Screenshots>

<UserId>Numeric</UserId>

<UserRatingId>Numeric</UserRatingId>

<Rating>Numeric</Rating>

<Comments>String</Comments>

<Date>Datetime</Date>

</ApplicationReviewDetailsEntity>

</Reviews>

Chapter 4: Application Management

156

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Email>String</Email>

<Phone>String</Phone>

</Support>

<DetailsLoaded>Boolean</DetailsLoaded>

<Version>String</Version>

<Size>Numeric</Size>

</AppDetails>

<DeveloperMessage xmlns="http://www.air-

watch.com/servicemodel/resources">String</DeveloperMessage>

</AppDetailCatalogResult>

JSON

{

"appDetails": {

"Id":Numeric,

"Type":"String",

"Name":"String",

"InstallState":"String",

"Description":"String",

"Screenshots":[

"String",

"String"

"Reviews":[

{

"UserId":Numeric,

"UserRatingId":Numeric,

"Rating":Numeric,

"Comments":"String",

"Date:"Datetime"

}

"Support": {

"Email":"String",

"Phone":"String"

"DetailsLoaded":Boolean,

"Version":"String",

"Size":Numeric

"developerMessage":"String"

}

Chapter 4: Application Management

157

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Tag Details

Tag Type Description

Id Numeric Unique identifier of the application

Type String Type of the application

Name String Name of the application

InstallState String Status of application installation on the device

Description String Description about the application

Screenshots String Screenshots of the application

UserId Numeric Unique identifier of the user

UserRatingId Numeric Unique identifier of the user rating

Rating Numeric Rating given to the application

Comments String Comments provided to the application

Date Datetime Time stamp when the reviews were given to the application

Email String Email address of the user

Phone String Phone number of the user

DetailsLoaded Boolean Details loaded for the application. True or False

Version String Version of the application

Size Numeric Application size in bytes

developerMessage String Developer message for the application

Chapter 4: Application Management

158

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Get Application Management Status (*Refactored)

Functionality – Retrieves the application management status, i.e. the application with bundle id passed is managed by

AirWatch or not.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/getmanagementstatus?managementid=

{managementid}&bundleid={bundleid}. This URI will be deprecated soon. Start using the *Supported API URI.

lExact Match Parameter – managementid, bundleid

lPattern (Contains) Match Parameter – managementid, bundleid

*Supported API URI – https://host/api/mam/apps/managementstatus

Request – N/A

URI Parameters

Tag Type Description

managementid Numeric Management identifier

bundleid Numeric Application bundle identifier

Response Payloads

XML

<Status>Numeric</Status>

</ManagementStatus>

JSON

{

"Status":Numeric

}

Response Tag Details

Tag Type Description

Status Numeric Status of the application whether it is managed by AirWatch or not

Chapter 4: Application Management

159

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Assigned Devices (Internal Application) (*Refactored)

Functionality – Provides a list of devices that have been assigned the specified internal application.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/internal/{applicationid}/assigneddevices?locationgroupid=

{locationgroupid}&page={page}&pagesize={pagesize}. This URI will be deprecated soon. Start using the *Supported API

URI.

*Supported API URI – https://host/api/mam/apps/internal/applicationid/devices

Request Payload – NA

URI Parameters

Tag Type Description

ApplicationID Numeric Unique numeric ID of an internal application

locationgroupid Numeric Unique numeric ID of the organization group where the application is

present

page Numeric Page number

pagesize Numeric Size of the page to show records

Response Payload

XML

<Page xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Page>

<PageSize xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</PageSize>

<Total xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Total>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

</DeviceList>

JSON

{

"Page":Numeric,

Chapter 4: Application Management

160

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"PageSize":Numeric,

"Total":Numeric,

"DeviceId":Numeric,

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique numeric ID of the device

Page Numeric Page number of the device result

PageSize Numeric Maximum number of records per page

Total Numeric Total Results obtained

Chapter 4: Application Management

161

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Assigned Devices (Public Application) (*Refactored)

Functionality – Retrieves the numeric IDs of devices to which a public application is assigned.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/Public/{applicationid}/assigneddevices?locationgroupid=

{locationgroupid}&page={page}&pagesize={pagesize} . This URI will be deprecated soon. Start using the *Supported API

URI.

*Supported API URI – https://host/api/mam/apps/public/applicationid/devices

Request Payload – NA

URI Parameters

Tag Type Description

ApplicationID Numeric Unique numeric ID of a public application

locationgroupid Numeric Unique numeric ID of the organization group where the application is

present

page Numeric Page number

pagesize Numeric Size of the page to show records

Response Payload

XML

<Page xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Page>

<PageSize xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</PageSize>

<Total xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Total>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

</DeviceList>

JSON

{

"Page":Numeric,

Chapter 4: Application Management

162

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"PageSize":Numeric,

"Total":Numeric,

"DeviceId":Numeric,

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique numeric ID of the device

Page Numeric Page number of the device result

PageSize Numeric Maximum number of records per page

Total Numeric Total Results obtained

Chapter 4: Application Management

163

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Assigned Devices With Purchased Application (*Refactored)

Functionality – Provides a list of devices that have been assigned the specified purchased application.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/purchased/{applicationid}/assigneddevices?locationgroupid=

{locationgroupid}&page={page}&pagesize={pagesize}

This URI will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/purchased/applicationid/devices (HTTP Method Used – GET)

Request – N/A

URI Parameters

Tag Type Description

ApplicationID Numeric Unique numeric ID of a purchased application

locationgroupid Numeric Unique numeric ID of the organization group where the application is

present

page Numeric Page number

pagesize Numeric Size of the page to show records

Response Payload

XML

<Page xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Page>

<PageSize xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</PageSize>

<Total xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Total>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

</DeviceList>

Chapter 4: Application Management

164

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"DeviceId":Numeric,

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique numeric ID of the device

Page Numeric Page number of the device result

PageSize Numeric Maximum number of records per page

Total Numeric Total Results obtained

Chapter 4: Application Management

165

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Installed Devices (Internal Application) (*Refactored)

Functionality – Provides a list of devices that have the specified internal application installed.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/internal/{applicationid}/installeddevices?locationgroupid=

{locationgroupid}&page={page}&pagesize={pagesize}. This URI will be deprecated soon. Start using the *Supported API

URI.

*Supported API URI – https://host/api/mam/apps/internal/applicationid/devices

Request Payload – NA

URI Parameters

Tag Type Description

ApplicationID Numeric Unique numeric ID of an internal application

locationgroupid Numeric Unique numeric ID of the organization group where the application is

present

page Numeric Page number

pagesize Numeric Size of the page to show records

status String status - installed/assigned

Response Payload

XML

<Page xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Page>

<PageSize xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</PageSize>

<Total xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Total>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

</DeviceList>

Chapter 4: Application Management

166

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"DeviceId":Numeric,

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique numeric ID of the device

Page Numeric Page number of the device result

PageSize Numeric Maximum number of records per page

Total Numeric Total Results obtained

Chapter 4: Application Management

167

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Installed Devices (Public Application) (*Refactored)

Functionality – Retrieves the numeric IDs of devices on which a public application is installed.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/public/{applicationid}/installeddevices?locationgroupid=

{locationgroupid}&page={page}&pagesize={pagesize}. This URI will be deprecated soon. Start using the *Supported API

URI.

*Supported API URI – https://host/api/mam/apps/public/applicationid/devices

Request Payload – NA

URI Parameters

Tag Type Description

ApplicationID Numeric Unique numeric ID of a public application

locationgroupid Numeric Unique numeric ID of the organization group where the application is

present

page Numeric Page number

pagesize Numeric Size of the page to show records

Response Payload

XML

<Page xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Page>

<PageSize xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</PageSize>

<Total xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Total>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

</DeviceList>

JSON

{

"Page":Numeric,

Chapter 4: Application Management

168

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"PageSize":Numeric,

"Total":Numeric,

"DeviceId":Numeric,

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique numeric ID of the device

Page Numeric Page number of the device result

PageSize Numeric Maximum number of records per page

Total Numeric Total Results obtained

Chapter 4: Application Management

169

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Installed Devices With Purchased Application (*Refactored)

Functionality – Provides a list of devices that have the specified purchased application installed.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/purchased/{applicationid}/installeddevices?locationgroupid=

{locationgroupid}&page={page}&pagesize={pagesize}

This URI will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/purchased/applicationid/devices (HTTP Method Used – GET)

Request payload – N/A

URI Parameters

Tag Type Description

ApplicationID Numeric Unique numeric ID of a purchased application

locationgroupid Numeric Unique numeric ID of the organization group where the application is

present

page Numeric Page number

pagesize Numeric Size of the page to show records

Response Payload

XML

<Page xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Page>

<PageSize xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</PageSize>

<Total xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Total>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

</DeviceList>

Chapter 4: Application Management

170

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"DeviceId":Numeric,

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique numeric ID of the device

Page Numeric Page number of the device result

PageSize Numeric Maximum number of records per page

Total Numeric Total Results obtained

Chapter 4: Application Management

171

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Devices with Internal Application Installed or Assigned

Functionality – Provides a list of devices that have the specified internal application installed or assigned.

HTTP Method – GET

API URI – https://host/api/mam/apps/internal/{applicationid}/devices?status={status}&locationgroupid=

{locationgroupid}&page={page}&pagesize={pagesize}

lExact Match Parameter – status

lPattern (Contains) Match Parameter – applicationid, locationgroupid, page, pagesize

Request Payload – N/A

URI Parameters

Tag Type Description

status String Status of the internal application; Installed or Assigned

ApplicationID Numeric Unique numeric ID of a internal application

locationgroupid Numeric Unique numeric ID of the organization group where the application is

present

page Numeric Page number

pagesize Numeric Size of the page to show records

Response Payload

XML

<DeviceList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<Page xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Page>

<PageSize xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</PageSize>

<Total xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Total>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

</DeviceList>

Chapter 4: Application Management

172

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"DeviceId" : [

Numeric,

Numeric

"Page" : Numeric,

"PageSize" : Numeric,

"Total" : Numeric

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique numeric ID of the device

Page Numeric Page number of the device result

PageSize Numeric Maximum number of records per page

Total Numeric Total Results obtained

Chapter 4: Application Management

173

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Devices with Public Application Installed or Assigned

Functionality – Provides a list of devices that have the specified public application installed or assigned.

HTTP Method – GET

API URI – https://host/api/mam/apps/public/{applicationid}/devices?status={status}&locationgroupid=

{locationgroupid}&page={page}&pagesize={pagesize}

lExact Match Parameter – status

lPattern (Contains) Match Parameter – applicationid, locationgroupid, page, pagesize

Request Payload – N/A

URI Parameters

Tag Type Description

status String Status of the public application; Installed or Assigned

ApplicationID Numeric Unique numeric ID of a public application

locationgroupid Numeric Unique numeric ID of the organization group where the application is

present

page Numeric Page number

pagesize Numeric Size of the page to show records

Response Payload

XML

<DeviceList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<Page xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Page>

<PageSize xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</PageSize>

<Total xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Total>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

</DeviceList>

Chapter 4: Application Management

174

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"DeviceId" : [

Numeric,

Numeric

"Page" : Numeric,

"PageSize" : Numeric,

"Total" : Numeric

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique numeric ID of the device

Page Numeric Page number of the device result

PageSize Numeric Maximum number of records per page

Total Numeric Total Results obtained

Chapter 4: Application Management

175

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Devices with Purchased Application Installed or Assigned

Functionality – Provides a list of devices that have the specified purchased application installed or assigned.

HTTP Method – GET

API URI – https://host/api/mam/purchased/{applicationid}/devices?status={status}&locationgroupid=

{locationgroupid}&page={page}&pagesize={pagesize}

lExact Match Parameter – status

lPattern (Contains) Match Parameter – applicationid, locationgroupid, page, pagesize

Request Payload – N/A

URI Parameters

Tag Type Description

status String Status of the purchased application; Installed or Assigned

ApplicationID Numeric Unique numeric ID of a purchased application

locationgroupid Numeric Unique numeric ID of the organization group where the application is

present

page Numeric Page number

pagesize Numeric Size of the page to show records

Response Payload

XML

<DeviceList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<Page xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Page>

<PageSize xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</PageSize>

<Total xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</Total>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

<DeviceId xmlns="http://www.air-

watch.com/servicemodel/resources">Numeric</DeviceId>

</DeviceList>

Chapter 4: Application Management

176

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"DeviceId" : [

Numeric,

Numeric

"Page" : Numeric,

"PageSize" : Numeric,

"Total" : Numeric

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique numeric ID of the device

Page Numeric Page number of the device result

PageSize Numeric Maximum number of records per page

Total Numeric Total Results obtained

Chapter 4: Application Management

177

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Internal Application

Functionality – Deletes an internal application identified by its application ID from the console.

HTTP Method – DELETE

API URI – https://host/api/mam/apps/Internal/{Applicationid}

Response Obtained – NA

Request payload – NA

Delete Public Application

Functionality – Deletes a public application identified by its application ID from the console.

HTTP Method – DELETE

API URI – https://host/api/mam/apps/public/{Applicationid}

Response Obtained – NA

Request payload – NA

Chapter 4: Application Management

178

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Add Assignments to Internal Application

Functionality – Adds assignments along with the flexible deployment parameters to an internal application.

HTTP Method – POST

API URI – https://host/api/mam/apps/internal/{applicationid}/assignments

Response Obtained – N/A

URI Parameters

Tag Type Description

applicationId Numeric Unique numeric ID of an internal application

Request Payload

XML

<int>Numeric</int>

</SmartGroupIds>

<PushMode>String</PushMode>

<EffectiveDate>Datetime</EffectiveDate>

<RemoveOnUnEnroll>Boolean</RemoveOnUnEnroll>

<ApplicationBackup>Boolean</ApplicationBackup>

<AutoUpdateDevicesWithPreviousVersion>Boolean</AutoUpdateDevicesWithP

reviousVersion>

<AdaptiveManagement>Boolean</AdaptiveManagement>

<int>Numeric</int>

</ApplicationTransformIds>

</DeploymentParameters>

</AppAssignments>

JSON

{

"DeploymentParameters" : {

"AdaptiveManagement" : Boolean,

"ApplicationBackup" : Boolean,

"ApplicationTransformIds" : [

Numeric

Chapter 4: Application Management

179

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"AutoUpdateDevicesWithPreviousVersion" : Boolean,

"EffectiveDate" : "Datetime",

"PushMode" : "String",

"RemoveOnUnEnroll" : Boolean

"SmartGroupIds" : [

Numeric

]

}

Request Tag Details

Tag Mandatory Description

DeploymentParameters No Internal application deployment parameters

AdaptiveManagement No Management of devices for receiving the application. If

disabled, you can make the application available to end-

users without AirWatch management of devices. Values are

True or False

ApplicationBackup No Is internal application backup is required. True or False

ApplicationTransformIds No Unique internal application transform identifiers

AutoUpdateDevicesWithPreviousVersion No Is auto update of devices with previous version of internal

application required. True or False

EffectiveDate No Time stamp when the application was effective

PushMode Yes Deployment mode of the application. Example: "Auto",

"OnDemand"

RemoveOnUnEnroll No Unenroll the device on removing the application

SmartGroupIds Yes Smart group ids of the app assignment to be added

Chapter 4: Application Management

180

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Edit Assignment of Internal Application

Functionality – Edits assignments along with the flexible deployment parameters associated with an internal application.

HTTP Method – PUT

API URI – https://host/api/mam/apps/internal/{applicationid}/assignments

Response Obtained – N/A

URI Parameters

Tag Type Description

applicationId Numeric Unique numeric ID of an internal application

Request Payload

XML

<int>Numeric</int>

</SmartGroupIds>

<int>Numeric</int>

</SmartGroupIdsForDeletion>

<PushMode>String</PushMode>

<EffectiveDate>Datetime</EffectiveDate>

<RemoveOnUnEnroll>Boolean</RemoveOnUnEnroll>

<ApplicationBackup>Boolean</ApplicationBackup>

<AutoUpdateDevicesWithPreviousVersion>Boolean</AutoUpdateDevicesWithP

reviousVersion>

<AdaptiveManagement>Boolean</AdaptiveManagement>

<int>Numeric</int>

</ApplicationTransformIds>

</DeploymentParameters>

</AppAssignments>

JSON

{

"DeploymentParameters" : {

"AdaptiveManagement" : Boolean,

"ApplicationBackup" : Boolean,

Chapter 4: Application Management

181

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"ApplicationTransformIds" : [

Numeric

"AutoUpdateDevicesWithPreviousVersion" : Boolean,

"EffectiveDate" : "Datetime",

"PushMode" : "String",

"RemoveOnUnEnroll" : Boolean

"SmartGroupIds" : [

Numeric

"SmartGroupIdsForDeletion" : [

Numeric

]

}

Request Tag Details

Tag Mandatory Description

DeploymentParameters No Internal application deployment parameters

AdaptiveManagement No Management of devices for receiving the application. If

disabled, you can make the application available to end-

users without AirWatch management of devices. Values are

True or False

ApplicationBackup No Is internal application backup is required. True or False

AutoUpdateDevicesWithPreviousVersion No Is auto update of devices with previous version of internal

application required. True or False

EffectiveDate No Time stamp when the application was effective

PushMode Yes Deployment mode of the application. Example: "Auto",

"OnDemand"

RemoveOnUnEnroll No Unenroll the device on removing the application

SmartGroupIds Yes Smart group ids of the app assignment to be edited

SmartGroupIdsForDeletion No Number of smart group ids to be deleted

ApplicationTransformIds No

Chapter 4: Application Management

182

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Application Assignment From Smart Group

Functionality – Deletes application assignment from smart group(s).

HTTP Method – DELETE

API URI – https://host/api/mam/apps/internal/{applicationid}/assignments

Response Obtained – N/A

Request Payload

XML

<int>Numeric</int>

</SmartGroupIds>

</ApplicationDeleteAssignmentModel>

JSON

{

"SmartGroupIds" : [

Numeric,

Numeric

]

}

Request Tag Details

Tag Mandatory Description

SmartGroupIds Yes Smart group ids of the app assignment to be deleted

Chapter 4: Application Management

183

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Internal Application Details

Functionality – Retrieves the details of an internal app identified by ID.

HTTP Method – GET

API URI – https://host/api/mam/apps/internal/{applicationid}

Request Payload – N/A

URI Parameters

Tag Type Description

applicationId Numeric Unique numeric ID of an internal application

Response Payload

XML

<Application xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

<ApplicationName>String</ApplicationName>

<AppId>String</AppId>

<ActualFileVersion>String</ActualFileVersion>

<BuildVersion>String</BuildVersion>

<AirwatchAppVersion>String</AirwatchAppVersion>

<Status>String</Status>

<ManagedBy>String</ManagedBy>

<AssumeManagementOfUserInstalledApp>String</AssumeManagementOfUserInstal

ledApp>

<Platform>String</Platform>

<Model>

<Id>Numeric</Id>

<Name>String</Name>

</Model>

</SupportedModels>

<MinimumOperatingSystem>String</MinimumOperatingSystem>

<AppSizeInKB>Numeric</AppSizeInKB>

<Id>Numeric</Id>

<Name>String</Name>

</Category>

</CategoryList>

<Comments>String</Comments>

<ApplicationUrl>String</ApplicationUrl>

Chapter 4: Application Management

184

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Sdk>String</Sdk>

<SdkProfileId>Numeric</SdkProfileId>

<DevicesAssignedCount>Numeric</DevicesAssignedCount>

<DevicesInstalledCount>Numeric</DevicesInstalledCount>

<DevicesNotInstalledCount>Numeric</DevicesNotInstalledCount>

<Rating>Numeric</Rating>

<ChangeLog>String</ChangeLog>

<RenewalDate>Datetime</RenewalDate>

<Id>Numeric</Id>

<SmartGroupId>Numeric</SmartGroupId>

<SmartGroupName>String</SmartGroupName>

<PushMode>String</PushMode>

<EffectiveDate>Datetime</EffectiveDate>

<RemoveOnUnEnroll>String</RemoveOnUnEnroll>

<ApplicationBackup>String</ApplicationBackup>

<AutoUpdateDevicesWithPreviousVersion>String</AutoUpdateDevicesWi

thPreviousVersion>

<PerAppVpn>String</PerAppVpn>

<VpnProfileId>Numeric</VpnProfileId>

<Rank>Numeric</Rank>

<AppConfig>String</AppConfig>

<Id>Numeric</Id>

<Key>String</Key>

<Value>String</Value>

<Type>String</Type>

</AppConfig>

</AppConfigs>

<int>Numeric</int>

</ApplicationTransformIds>

</AppAssignment>

</Assignments>

<CommandLineArguments>String</CommandLineArguments>

<InstallTimeoutInMinutes>Numeric</InstallTimeoutInMinutes>

<RetryCount>Numeric</RetryCount>

<RetryIntervalInMinutes>Numeric</RetryIntervalInMinutes>

</MsiDeploymentParamModel>

<IsDependencyFile>Boolean</IsDependencyFile>

<CriteriaType>String</CriteriaType>

<ApplicationIdentifier>String</ApplicationIdentifier>

<VersionCondition>String</VersionCondition>

Chapter 4: Application Management

185

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

</DataContingencies>

<DiskSpaceRequiredInKb>Numeric</DiskSpaceRequiredInKb>

<DevicePowerRequired>Numeric</DevicePowerRequired>

<RamRequiredInMb>Numeric</RamRequiredInMb>

</WhenToInstall>

<InstallContext>String</InstallContext>

<InstallCommand>String</InstallCommand>

<AdminPrivileges>Boolean</AdminPrivileges>

<DeviceRestart>String</DeviceRestart>

<RetryCount>Numeric</RetryCount>

<RetryIntervalInMinutes>Numeric</RetryIntervalInMinutes>

<InstallTimeoutInMinutes>Numeric</InstallTimeoutInMinutes>

<InstallerRebootExitCode>String</InstallerRebootExitCode>

<InstallerSuccessExitCode>String</InstallerSuccessExitCode>

</HowToInstall>

<WhenToCallInstallComplete xmlns="http://www.air-

watch.com/webapi/resources">

<UseAdditionalCriteria>Boolean</UseAdditionalCriteria>

<IdentifyApplicationBy>String</IdentifyApplicationBy>

<CriteriaType>String</CriteriaType>

<ApplicationIdentifier>String</ApplicationIdentifier>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

Chapter 4: Application Management

186

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

</CriteriaList>

<ScriptType>String</ScriptType>

<CommandToRunTheScript>String</CommandToRunTheScript>

<CustomScriptFileBlodId>Numeric</CustomScriptFileBlodId>

<SuccessExitCode>Numeric</SuccessExitCode>

</CustomScript>

</WhenToCallInstallComplete>

</DeploymentOptions>

<AppDependenciesList xmlns="http://www.air-

watch.com/webapi/resources">

<Name>String</Name>

<ApplicationDependencyId>Numeric</ApplicationDependencyId>

</ApplicationDependency>

</AppDependenciesList>

<TransformId>Numeric</TransformId>

<TransformFileName>String</TransformFileName>

<TransformBlobId>Numeric</TransformBlobId>

</ApplicationTransform>

</AppTransformsList>

<PatchId>Numeric</PatchId>

<PatchFileName>String</PatchFileName>

<PatchBlobId>Numeric</PatchBlobId>

<PatchType>String</PatchType>

</ApplicationPatch>

</AppPatchesList>

Chapter 4: Application Management

187

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<ApplicationUnInstallProcess xmlns="http://www.air-

watch.com/webapi/resources">

<UseCustomScript>Boolean</UseCustomScript>

<CustomScriptType>String</CustomScriptType>

<UninstallCommand>String</UninstallCommand>

<UninstallScriptBlobId>Numeric</UninstallScriptBlobId>

</CustomScript>

</ApplicationUnInstallProcess>

</FilesOptions>

</Application>

JSON

{

"ApplicationName" : "String",

"AppId" : "String",

"ActualFileVersion" : "String",

"BuildVersion" : "String",

"AirwatchAppVersion" : "String",

"Status" : "String",

"ManagedBy" : "String",

"AssumeManagementOfUserInstalledApp" : "String",

"Platform" : "String",

"SupportedModels" : [

{

"Name" : "String",

"id" : Numeric

}

"MinimumOperatingSystem" : "String",

"AppSizeInKB" : Numeric,

"CategoryList" : [

{

"Name" : "String",

"id" : Numeric

}

"Comments" : "String",

"ApplicationUrl" : "String",

"Sdk" : "String",

"SdkProfileId" : Numeric,

"DevicesAssignedCount" : Numeric,

"DevicesInstalledCount" : Numeric,

"DevicesNotInstalledCount" : Numeric,

"Rating" : Numeric,

"ChangeLog" : "String",

"RenewalDate" : "Datetime",

Chapter 4: Application Management

188

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"Assignments" : [

{

"SmartGroupId" : Numeric,

"SmartGroupName" : "String",

"PushMode" : "String",

"EffectiveDate" : "Datetime",

"RemoveOnUnEnroll" : "String",

"ApplicationBackup" : "String",

"AutoUpdateDevicesWithPreviousVersion" : "String",

"PerAppVpn" : "String",

"VpnProfileId" : Numeric,

"Rank" : Numeric,

"AppConfig" : "String",

"AppConfigs" : [

{

"Key" : "String",

"Value" : "String",

"Type" : "String",

"id" : Numeric

}

"ApplicationTransformIds" : [

Numeric

"id" : Numeric

}

"DeploymentOptions" : {

"HowToInstall" : {

"AdminPrivileges" : Boolean,

"DeviceRestart" : "String",

"InstallCommand" : "String",

"InstallContext" : "String",

"InstallTimeoutInMinutes" : Numeric,

"InstallerRebootExitCode" : "String",

"InstallerSuccessExitCode" : "String",

"RetryCount" : Numeric,

"RetryIntervalInMinutes" : Numeric

"WhenToCallInstallComplete" : {

"CriteriaList" : [

{

"AppCriteria" : {

"ApplicationIdentifier" : "String",

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"CriteriaType" : "String",

Chapter 4: Application Management

189

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"FileCriteria" : {

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"ModifiedOn" : "String",

"Path" : "String",

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"LogicalCondition" : "String",

"RegistryCriteria" : {

"KeyName" : "String",

"KeyType" : "String",

"KeyValue" : "String",

"Path" : "String"

}

"CustomScript" : {

"CommandToRunTheScript" : "String",

"CustomScriptFileBlodId" : Numeric,

"ScriptType" : "String",

"SuccessExitCode" : Numeric

"IdentifyApplicationBy" : "String",

"UseAdditionalCriteria" : Boolean

"WhenToInstall" : {

"DataContingencies" : [

{

"AppCriteria" : {

"ApplicationIdentifier" : "String",

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"CriteriaType" : "String",

"FileCriteria" : {

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"ModifiedOn" : "String",

"Path" : "String",

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"LogicalCondition" : "String",

"RegistryCriteria" : {

"KeyName" : "String",

Chapter 4: Application Management

190

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"KeyType" : "String",

"KeyValue" : "String",

"Path" : "String"

}

"DevicePowerRequired" : Numeric,

"DiskSpaceRequiredInKb" : Numeric,

"RamRequiredInMb" : Numeric

}

"Description" : "String",

"Developer" : "String",

"DeveloperEmail" : "String",

"DeveloperPhone" : "String",

"DeviceType" : "String",

"EnableProvisioning" : Boolean,

"FileName" : "String",

"FilesOptions" : {

"AppDependenciesList" : [

{

"Name" : "String",

"ApplicationDependencyId" : Numeric

}

"AppPatchesList" : [

{

"PatchId" : Numeric,

"PatchFileName" : "String",

"PatchBlobId" : Numeric,

"PatchType" : "String"

}

"AppTransformsList" : [

{

"TransformId" : Numeric,

"TransformFileName" : "String",

"TransformBlobId" : Numeric

}

"ApplicationUnInstallProcess" : {

"UseCustomScript" : Boolean,

"CustomScript" : {

"CustomScriptType" : "String",

"UninstallCommand" : "String",

"UninstallScriptBlobId" : Numeric

"UseCustomScript" : Boolean

}

"IsDependencyFile" : Boolean,

Chapter 4: Application Management

191

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"LocationGroupId" : Numeric,

"MsiDeploymentParamModel" : {

"CommandLineArguments" : "String",

"InstallTimeoutInMinutes" : Numeric,

"RetryCount" : Numeric,

"RetryIntervalInMinutes" : Numeric

}

Response Tag Details

Tag Type Description

ApplicationName String Name of the internal application

AppId String Unique identifier of the internal application

ActualFileVersion String Actual file version of the internal application

BuildVersion String Build version of the internal application

AirwatchAppVersion String Version of the AirWatch application

Status String Status of the internal application

ManagedBy String Unique Organization Group that manages the internal

application

AssumeManagementOfUserInstalledApp String Option that takes over management of a user installed iOS

application

Platform String Platform of the device

SupportedModels Name String Name of the supported device model for internal application

SupportedModels id Numeric Unique identifier of the supported devices for internal

application

MinimumOperatingSystem String Minimum operating system of the device for internal

application

AppSizeInKB Numeric Internal application size in KB

CategoryList Name String Name of the category list

CategoryList id Numeric Unique identifier of the category list

Comments String Comments for the internal application

ApplicationUrl String URLof the internal application

Sdk String SDKof the internal application

SdkProfileId Numeric Unique identifier of the SDK profile

DevicesAssignedCount Numeric Number of the assigned devices with the application

Chapter 4: Application Management

192

VMware AirWatch REST API Guide | v.2016.04 | April 2017

DevicesInstalledCount Numeric Number of the devices with the application installed

DevicesNotInstalledCount Numeric Number of the devices with the application not installed

Rating Numeric Rating of the application

ChangeLog String Change log of the application

RenewalDate Datetime Time stamp of the app renewal date

SmartGroupId Numeric Smart group ID of the assignment

SmartGroupName String Name of the smart group

PushMode String Deployment mode for the applications. Supported values are

auto and ondemand.

EffectiveDate Datetime Time stamp when the application was effective

RemoveOnUnEnroll String Unenroll the device on removing the application

ApplicationBackup String Backup of the application

AutoUpdateDevicesWithPreviousVersion String Automatically update the devices with previous version of

the application

PerAppVpn String Per-app VPN that needed to be configured on the device

VpnProfileId Numeric Unique identifier of the VPN profile

Rank Numeric Rank of the assignment

AppConfig Key String Key of the app configuration

AppConfig Value String Value of the app configuration

AppConfig Type String App configuration type

AppConfigid Numeric Unique identifier of the app configuration

ApplicationTransformIds Numeric Identifier of the application transform files

AdminPrivileges Boolean Whether or not the installation should be initiated with

logged-in user privileges or with stepped up administrative

permissions

DeviceRestart String Restart the device after the application is installed

InstallCommand String Install program to meet your deployment criteria

InstallContext String Indicate whether the app should be configured and installed

for just enrolled users or for all users on each of your devices

InstallTimeoutInMinutes Numeric Amount of time, in minutes, that the installation process can

run before the installation is considered as failed

InstallerRebootExitCode String Integer code returned by the installer to indicate that the

app has been successfully installed once the device has been

rebooted. This will be used in conjunction with the 'Device

Restart' option specified above.

Chapter 4: Application Management

193

VMware AirWatch REST API Guide | v.2016.04 | April 2017

InstallerSuccessExitCode String Integer code returned by the installer that marks the success

of the operation

RetryCount Numeric Number of retries for installing application before the

installation is marked as failed

RetryIntervalInMinutes Numeric Amount of time, in minutes, between retries for installing

application

ApplicationIdentifier String Unique identifier of the application (Bundle ID or External ID)

BuildNumber Numeric Build version of the application

MajorVersion Numeric Major version of the application

MinorVersion Numeric Minor version of the application

RevisionNumber Numeric Fix version of the application

VersionCondition String Version conditions

CriteriaType String Unique smart group type configured to the smart group

FileCriteria String File Criteria

BuildNumber Numeric Build version of the application

MajorVersion Numeric Major version of the application

MinorVersion Numeric Minor version of the application

ModifiedOn String Date on which the application was last modified

Path String Path of the application

RevisionNumber Numeric Fix version of the application

VersionCondition String Version Conditions

LogicalCondition String Logical condition. Supported values are 'And' and 'Or'.

KeyName String Name of the key

KeyType String Type of key to be created in the registry. Supported values

are String, Binary, DWord, QWord, MultiString, and

ExpandableString.

KeyValue String Value of the key to be created in the registry

Path String Path of the key in the registry

CommandToRunTheScript String Command to run the script

CustomScriptFileBlodId Numeric Blob ID of the script file associated.

Supported file types are .js, .jse, .ps1, .ps1xml, .psc1, .psd1,

.psm1, .pssc, .cdxml, .vbs, .vbe, .wsf, and .wsc.

ScriptType String Script Type.Support script types are JScript, PowerShell, and

VBScript.

SuccessExitCode Numeric Success exit code

Chapter 4: Application Management

194

VMware AirWatch REST API Guide | v.2016.04 | April 2017

IdentifyApplicationBy String The way by which an application can be identified. Supported

Values are DefiningCriteria and UsingCustomScript.

UseAdditionalCriteria Boolean Msi apps are detected on the device by product code and

version. Use this option to perform additional actions to

ensure your app is successfully installed on your end users'

devices.

ApplicationIdentifier String Unique identifier of the application (Bundle ID or External ID)

BuildNumber Numeric Build version of the application

MajorVersion Numeric Major version of the application

MinorVersion Numeric Minor version of the application

RevisionNumber Numeric Date on which the application was last modified

VersionCondition String Version condition. Supported values are Any, EqualTo,

GreaterThan, and LessThan.

CriteriaType String Criteria type. Supported values are AppExists,

AppDoesNotExist, FileExists, FileDoesNotExist, RegistryExists,

and RegistryDoesNotExist.

BuildNumber Numeric Build version of the file

MajorVersion Numeric Major version of the file

MinorVersion Numeric Minor version of the file

ModifiedOn String Date on which the file was last modified

Path String Path of the file

RevisionNumber Numeric Fix version of the file

VersionCondition String Version condition. Supported values are Any, EqualTo,

GreaterThan, and LessThan.

LogicalCondition String Logical condition. Supported values are And and or.

KeyName String Name of the key

KeyType String Type of key to be created in the registry. Supported values

are String, Binary, DWord, QWord, MultiString,

ExpandableString.

KeyValue String Value of the key to be created in the registry

Path String Path of the key in the registry

DevicePowerRequired Numeric The minimum percentage of power required by the device

for installing the application

DiskSpaceRequiredInKb Numeric Disk space required by the application

RamRequiredInMb Numeric RAM (in MB) required for installing the application

Description String Desired description of the application

Chapter 4: Application Management

195

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Developer String Name of the developer

DeveloperEmail String Email address of the developer

DeveloperPhone String Phone number of the developer

DeviceType String Numeric Platform identifier of the Device application

EnableProvisioning Boolean Provisioning status. Supported value is Boolean/False.

FileName String File name along with the extension

AppDependenciesList String List of application dependency identifiers

AppDependenciesListName String Name of the list of application dependency identifiers

ApplicationDependencyid Numeric Application dependency identifier

PatchId Numeric Identifier of the uploaded patch

PatchFileName String Name of the patch file

AppPatchesList String List of the application patches

PatchBlobId Numeric Blob ID of the uploaded Patch

PatchType String Type of the uploaded patch

TransformId Numeric Identifier of the uploaded transform files

TransformFileName String Name of the transform files

TransformBlobId Numeric Blob ID of the uploaded Transform

UseCustomScript Boolean Use custom script

CustomScript String Custom script

CustomScriptType String Custom script type. Supported values: Input, Upload.

UninstallCommand String Application uninstall command provided

UninstallScriptBlobId Numeric Gets or sets the ID value of the uninstall script file uploaded

on the console.

Supported file types are .js, .jse, .ps1, .ps1, .xml, .psc1,

.psd1, .psm1, .pssc, .cdxml, .vbs, .vbe, .wsf, and .wsc.

UseCustomScript Boolean Value indicating whether custom script is used or not

IsDependencyFile Boolean Indicates whether uploaded file is a dependency file

LocationGroupId Numeric Location group identifier

MsiDeploymentParamModel String Msi deployment Parameter model. This is valid only for MSI

files when Software Distribution is not enabled.

CommandLineArguments String Command-line options to be used when calling MSIEXEC.exe

InstallTimeoutInMinutes Numeric 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.

Range: 0 - 60.

Chapter 4: Application Management

196

VMware AirWatch REST API Guide | v.2016.04 | April 2017

RetryCount Numeric The number of times the download and installation

operation will be retried before the installation will be

marked as failed. With a limit of ‘10' attempts.

RetryIntervalInMinutes Numeric Amount of time, in minutes between retry operations. The

range is 0 through 10.

Chapter 4: Application Management

197

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Create Application Group (*Refactored)

Functionality – Creates an Application Group in the desired Organization Group.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/appgroups/create. This URI will be deprecated soon. Instead, use the

*Supported API URI.

*Supported API URI – https://host/api/mam/apps/appgroups (HTTP Method Used – POST)

Request Payload

XML

<Name>String</Name>

<Platform>String</Platform>

<AppGroupType>String</AppGroupType>

<Description>String</Description>

<ManagedByOrganizationGroupID>Numeric</ManagedByOrganizationGroupID>

<Id>Numeric</Id>

<Name>String</Name>

</OrganizationGroup>

</OrganizationGroups>

<Id>Numeric</Id>

<Name>String</Name>

</UserGroup>

</UserGroups>

<DeviceOwnership>String</DeviceOwnership>

<DeviceModel>String</DeviceModel>

<DeviceOperatingSystem>String</DeviceOperatingSystem>

<IsActive>Boolean</IsActive>

<AppCount>String</AppCount>

<Name>String</Name>

<BundleId>Numeric</BundleId>

</ApplicationGroupItem>

</Applications>

</ApplicationGroup>

Chapter 4: Application Management

198

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"ApplicationGroupID" : "String",

"Name":"String",

"Platform":"String",

"AppGroupType":"String",

"Description":"String",

"ManagedByOrganizationGroupID":"String",

"OrganizationGroups":[{

"Name" : "String",

"Id":Numeric

}],

"UserGroups":[{

"Name" : "String",

"Id":Numeric

}],

"DeviceOwnership":"String",

"DeviceModel":"String",

"DeviceOperatingSystem":"String",

"IsActive" : true,

"AppCount" : "Text value",

"Applications":[{

"Name":"String",

"BundleId":Numeric

}]

}

Request Tag Details

Tag Mandatory Description

ApplicationGroupID Yes Unique identifier of the application

Name Yes Name of the application assigned to the device

Platform Yes Name of the device platform. "Android", "Apple"

AppGroupType Yes Type of the application group

Description No Description of the application group

ManagedByOrganizationGroupID Yes Unique identification of the organization group which manages the

application group

OrganizationGroups Id Yes Unique numeric identifier of the organization group

OrganizationGroups No Unique name of the organization groupp

UserGroups Id No Unique numeric identifier of the user group

UserGroups Name No Unique name of the user group

DeviceOwnership No Type of ownership of the device

Chapter 4: Application Management

199

VMware AirWatch REST API Guide | v.2016.04 | April 2017

DeviceModel No Model of the device

DeviceOperatingSystem No Operating System of the device

Applications Name Yes (atleast1) Name of the application

Applications BundleId Yes (atleast1) Bundle ID of the application

IsActive No State of the application

AppCount No Number of the applications in the device

Response Payload

XML

<ApplicationGroupID>String</ApplicationGroupID>

<Name>String</Name>

<Platform>String</Platform>

<AppGroupType>String</AppGroupType>

<Description>String</Description>

<ManagedByOrganizationGroupID>String</ManagedByOrganizationGroupID>

<Name>String</Name>

<Id>Numeric</Id>

</OrganizationGroup>

</OrganizationGroups>

<Name>String</Name>

<Id>Numeric</Id>

</UserGroup>

</UserGroups>

<DeviceOwnership>String</DeviceOwnership>

<DeviceModel>String</DeviceModel>

<DeviceOperatingSystem>String</DeviceOperatingSystem>

<IsActive>Boolean</IsActive>

<AppCount>String</AppCount>

<Name>String</Name>

<BundleId>Numeric</BundleId>

</ApplicationGroupItem>

</Applications>

</ApplicationGroup>

Chapter 4: Application Management

200

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"ApplicationGroupID":"String",

"Name":"String",

"Platform":"String",

"AppGroupType":"String",

"Description":"String",

"ManagedByOrganizationGroupID":"String",

"OrganizationGroups":[{

"Name":"String",

"Id":Numeric

}],

"UserGroups":[{

"Name":"String",

"Id":Numeric

}],

"DeviceOwnership":"String",

"DeviceModel":"String",

"DeviceOperatingSystem":"String",

"IsActive":Boolean,

"AppCount":"String",

"Applications":[{

"Name":"String",

"BundleId":Numeric

}]

}

Response Tag Details

Tag Type Description

ApplicationGroupID String Unique Id of the application

Name String Name of the application assigned to the device

Platform String Name of the device platform.

AppGroupType String Type of the application group

Description String Description of the application group

ManagedByOrganizationGroupID String Unique identification of the organization group which manages the

application group

OrganizationGroups Name String Name of the organization group

OrganizationGroups Id Numeric Unique numeric identifier of the organization group.

UserGroups Name String Name of the User group

UserGroups Id Numeric Unique numeric identifier of the user group

DeviceOwnership String Type of ownership of the device

Chapter 4: Application Management

201

VMware AirWatch REST API Guide | v.2016.04 | April 2017

DeviceModel String Model of the device

DeviceOperatingSystem String Operating System of the device

Applications Name String Name of the application

Applications BundleId Numeric Bundle ID of the application

Chapter 4: Application Management

202

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Application Group Details

Functionality – Retrieves the Application group details based on the application group id.

HTTP Method – GET

API URI – https://host/api/mam/apps/appgroups/{appgroupid}

Request Body – NA

Response Payload

XML

<ApplicationGroupID>String</ApplicationGroupID>

<Name>String</Name>

<Platform>String</Platform>

<AppGroupType>String</AppGroupType>

<Description>String</Description>

<ManagedByOrganizationGroupID>String</ManagedByOrganizationGroupID>

<Name>String</Name>

<Id>String</Id>

</OrganizationGroup>

</OrganizationGroups>

<Name>String</Name>

<Id>String</Id>

</UserGroup>

</UserGroups>

<DeviceOwnership>String</DeviceOwnership>

<DeviceModel>String</DeviceModel>

<DeviceOperatingSystem>String</DeviceOperatingSystem>

<Name>String</Name>

<BundleId>String</BundleId>

</ApplicationGroupItem>

</Applications>

</ApplicationGroup>

Chapter 4: Application Management

203

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"ApplicationGroupID":Numeric,

"Name":"String",

"Platform":"String",

"AppGroupType":"String",

"Description":"String",

"ManagedByOrganizationGroupID":"String",

"OrganizationGroups":[{

"Name":"String",

"Id":Numeric

}],

"UserGroups":[{

"Name":"String",

"Id":Numeric

}],

"DeviceOwnership":"String",

"DeviceModel":"String",

"DeviceOperatingSystem":"String",

"Applications":[{

"Name":"String",

"BundleId":Numeric

}]

}

Response Tag Details

Tag Type Description

ApplicationGroupID Numeric Unique numeric ID of the application

Name String Name of the application

Platform String Platform of the device

AppGroupType String Type of the application group

Description String Description of the application group

ManagedByOrganizationGroupID Numeric Unique identification of the organization group which manages the

application group

OrganizationGroups Name String Name of the organization group

OrganizationGroups Id Numeric Unique identification of the organization group from where the

devices are filtered

UserGroups Name String Name of the User group

UserGroups Id Numeric Unique numeric identification of the user group

DeviceOwnership String Type of ownership of the device

Chapter 4: Application Management

204

VMware AirWatch REST API Guide | v.2016.04 | April 2017

DeviceModel String Model of the device

DeviceOperatingSystem String Operating System of the device

Applications Name String Name of the application

Applications BundleId String Bundle ID of the application

Chapter 4: Application Management

205

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Application Group (*Refactored)

Functionality – Searches for the Application Groups based on the query information provided.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/appgroupsearch?name={appgroupname}&organizationgroupid=

{organizationgroupid}&plaform={platform}&appgrouptype={appgrouptype}&orderby={orderby}&sortorder=

{sortorder}&page={page}&pagesize={pagesize}

lExact Match Parameter – platform, appgrouptype, sortorder

lPattern (Contains) Match Parameter – name, organizationgroupid, orderby, page, pagesize

This URI will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/appgroups/search (HTTP Method Used – GET)

Request Body – NA

URI Parameters

Tag Type Description

appgroupname String Application Group Name

organizationgroupid Numeric Id of the Organization group

platform String Platform of the application group

appgrouptype String Application group type. "Whitelisted", "Blacklisted", "Required"

orderby String The column by which the results will be ordered.

sortorder String Sorting order. Values ASC or DESC. Defaults to ASC

page Numeric Page number of the device result. The first page has pagenumber=0

pagesize Numeric Maximum number of records per page

Response Payload

XML

<ApplicationGroupSearchResult xmlns="http://www.air-

watch.com/servicemodel/resources">

<Page>Numeric</Page>

<PageSize>Numeric</PageSize>

<Total>Numeric</Total>

<ApplicationGroupID>Numeric</ApplicationGroupID>

<Name>String</Name>

<Platform>String</Platform>

Chapter 4: Application Management

206

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<AppGroupType>String</AppGroupType>

<Description>String</Description>

<ManagedByOrganizationGroupID>Numeric</ManagedByOrganizationGroupID>

<Name>String</Name>

<Id>Numeric</Id>

</OrganizationGroup>

</OrganizationGroups>

<Name>String</Name>

<Id>Numeric</Id>

</UserGroup>

</UserGroups>

<DeviceOwnership>String</DeviceOwnership>

<DeviceModel>String</DeviceModel>

<DeviceOperatingSystem>String</DeviceOperatingSystem>

<IsActive>Boolean</IsActive>

<AppCount>String</AppCount>

<Name>String</Name>

<BundleId>Numeric</BundleId>

</ApplicationGroupItem>

</Applications>

</AppGroups>

<ApplicationGroupID>Numeric</ApplicationGroupID>

<Name>String</Name>

<Platform>String</Platform>

<AppGroupType>String</AppGroupType>

<Description>String</Description>

<ManagedByOrganizationGroupID>Numeric</ManagedByOrganizationGroupID>

<Name>String</Name>

<Id>Numeric</Id>

</OrganizationGroup>

</OrganizationGroups>

<Name>String</Name>

<Id>Numeric</Id>

</UserGroup>

</UserGroups>

<DeviceOwnership>String</DeviceOwnership>

<DeviceModel>String</DeviceModel>

<DeviceOperatingSystem>String</DeviceOperatingSystem>

<IsActive>Boolean</IsActive>

<AppCount>String</AppCount>

Chapter 4: Application Management

207

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Name>String</Name>

<BundleId>Numeric</BundleId>

</ApplicationGroupItem>

</Applications>

</AppGroups>

</ApplicationGroupSearchResult>

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"AppGroups":{

"ApplicationGroupID":Numeric,

"Name":"String",

"Platform":"String",

"AppGroupType":"String",

"Description":"String",

"ManagedByOrganizationGroupID":Numeric,

"OrganizationGroups":[{

"Name":"String",

"Id":Numeric

}],

"UserGroups":[{

"Name":"String",

"Id":Numeric

}],

"DeviceOwnership":"String",

"DeviceModel":"String",

"DeviceOperatingSystem":"String",

"IsActive":Boolean,

"AppCount":"String",

"Applications":[{

"Name":"String",

"BundleId":Numeric

}]

}

Response Tag Details

Tag Type Description

Page Numeric Page number of the retrieved response

Chapter 4: Application Management

208

VMware AirWatch REST API Guide | v.2016.04 | April 2017

PageSize Numeric Size of the current page

Total Numeric Total Results obtained from the search

ApplicationGroupID Numeric Unique group Id of the application

Name String Name of the application assigned to the device

Platform String Numeric ID of the device platform. Refer Tables for the platform IDs

AppGroupType String Type of the application group

Description String Description of the application group

ManagedByOrganizationGroupID Numeric Unique identification of the organization group which manages the

application group

OrganizationGroups Name String Name of the organization group

OrganizationGroups Id Numeric Unique identification of the organization group from where the

devices are filtered

UserGroups Name String Name of the User group

UserGroups Id Numeric Unique numeric identification of the user group

DeviceOwnership String Type of ownership of the device

DeviceModel String Model of the device

DeviceOperatingSystem String Operating System of the device

IsActive Boolean Status of the application group

AppCount Numeric Number of applications assigned to the App Group

Applications Name String Name of the application

Applications BundleId Numeric Bundle ID of the application

Chapter 4: Application Management

209

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search SDK Analytics

Functionality – Retrieves SDK analytics based on the query information provided.

HTTP Method – GET

API URI – https://host/api/mam/apps/sdkanalytics?organizationgroupid={organizationgroupid}&applicationid=

{applicationid}&eventname={eventname}&startdatetime={startdatetime}&enddatetime={enddatetime}&searchby=

{searchtype}&page={page}&pagesize={pagesize}

lPattern (Contains) Match Parameter – organizationgroupid, applicationid, eventname, startdatetime, enddatetime,

searchtype, page, pagesize

URI Parameters

Tag Description

organizationgroupid OrganizationGroup Identifier

applicationid Application Identifier

eventname Event name search parameter

startdatetime Sample Starttime

enddatetime Sample Endtime

searchtype Search by Device Identifier types (DeviceId, MacAddress, Udid, SerialNumber, and

ImeiNumber)

page Page index

pagesize Records per page

Request Payloads

XML

<Value>String</Value>

</BulkValues>

</BulkInput>

Chapter 4: Application Management

210

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"BulkValues":{

"Value":["String"]

}

Request Tag Details

Tag Mandatory Description

Value Yes Represents the unique identification of the application

Response Payload

XML

<ApplicationEventSampleSearchResult xmlns="http://www.air-

watch.com/servicemodel/resources">

<Page>Numeric</Page>

<PageSize>Numeric</PageSize>

<Total>Numeric</Total>

<DeviceID>Numeric</DeviceID>

<SampleTime>Datetime</SampleTime>

<ApplicationID>String</ApplicationID>

<Version>String</Version>

<UserName>String</UserName>

<FriendlyName>String</FriendlyName>

<EventName>String</EventName>

<EventData>String</EventData>

</ApplicationEventSampleSearchResultEntity>

</ApplicationEventSamples>

</ApplicationEventSampleSearchResult>

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"ApplicationEventSamples":[{

Chapter 4: Application Management

211

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"ApplicationID":"String",

"DeviceID":Numeric,

"EventData":"String",

"EventName":"String",

"FriendlyName":"String",

"SampleTime":"Datetime",

"UserName":"String",

"Version":"String"

}]

}

Response Tag Details

Tag Type Description

Page Numeric Page number of the retrieved response

PageSize Numeric Page Size of the retrieved response

Total Numeric Total Results obtained from the search

ApplicationID String Unique identification of the application

DeviceID Numeric Unique identification number of the device

EventData String Data of the event

EventName String Name of the event

FriendlyName String Friendly name of the device

SampleTime Datetime Time stamp of the sample time

UserName String Username of the device

Version String Version of the application

Chapter 4: Application Management

212

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Application Group (*Refactored)

Functionality – Updates the metadata of the application group specified by its numeric ID.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/appgroups/{appgroupid}/update. This URI will be deprecated soon.

Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/appgroups/appgroupid (HTTP Method Used – PUT)

Response Obtained – NA

Request Payload

XML

<Name>String</Name>

<ApplicationGroupID>String</ApplicationGroupID>

<Platform>String</Platform>

<AppGroupType>String</AppGroupType>

<Description>String</Description>

<ManagedByOrganizationGroupID>Numeric</ManagedByOrganizationGroupID>

<Name>String</Name>

<Id>Numeric</Id>

</OrganizationGroup>

</OrganizationGroups>

<Name>String</Name>

<Id>Numeric</Id>

</UserGroup>

</UserGroups>

<DeviceOwnership>String</DeviceOwnership>

<DeviceModel>String</DeviceModel>

<DeviceOperatingSystem>String</DeviceOperatingSystem>

<IsActive>Boolean</IsActive>

<AppCount>String</AppCount>

<Name>String</Name>

<BundleId>Numeric</BundleId>

</ApplicationGroupItem>

<Name>String</Name>

<BundleId>Numeric</BundleId>

</ApplicationGroupItem>

</Applications>

Chapter 4: Application Management

213

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</ApplicationGroup>

JSON

{

"ApplicationGroupID" : "String",

"Name":"String",

"Platform":"String",

"AppGroupType":"String",

"Description":"String",

"ManagedByOrganizationGroupID":Numeric,

"OrganizationGroups":[{

"Name":"String",

"Id":"Numeric"

}],

"UserGroups":[{

"Name":"String",

"Id":"Numeric"

}],

"DeviceOwnership":"String",

"DeviceModel":"String",

"DeviceOperatingSystem":"String",

"IsActive" : Boolean,

"AppCount" : "String",

"Applications":[{

"Name":"String",

"BundleId":Numeric

}]

}

Request Tag Details

Tag Mandatory Description

ApplicationGroupID No Unique identifier of the application

Name No Name of the application assigned to the device

Platform No Numeric ID of the device platform. Refer Tables for the platform IDs

AppGroupType No Type of the application group

Description No Description of the application group

ManagedByOrganizationGroupID No Unique identification of the organization group which manages the

application group

OrganizationGroups Name No Name of the organization group

Chapter 4: Application Management

214

VMware AirWatch REST API Guide | v.2016.04 | April 2017

OrganizationGroups Id No Unique identification of the organization group from where the

devices are filtered

UserGroups Name No Name of the User group

UserGroups Id No Unique numeric identification of the user group

DeviceOwnership No Type of ownership of the device

DeviceModel No Model of the device

DeviceOperatingSystem No Operating System of the device

isActive No State of the application in the device

AppCount No Number of applications

Applications Name No Name of the application

Applications BundleId No Bundle ID of the application

Chapter 4: Application Management

215

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Application Group (*Refactored)

Functionality – Deletes application groups identified by the application group identifiers.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/appgroups/delete. This URI will be deprecated soon. Start using the

*Supported API URI.

*Supported API URI – https://host/api/mam/apps/appgroups (HTTP Method Used – DELETE)

Request Payload

XML

<Value>

<string>String</string>

</Value>

</BulkValues>

</BulkInput>

JSON

{

"BulkValues":{

"Value":["String"]

}

Request Tag Details

Tag Mandatory Description

Values Yes (at least 1) Represents the unique numeric ID of the Application Group

Response Payload

XML

<TotalItems>Numeric</TotalItems>

Chapter 4: Application Management

216

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<AcceptedItems>Numeric</AcceptedItems>

<FailedItems>Numeric</FailedItems>

<ActivityId>Numeric</ActivityId>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

</Faults>

</BulkResponse>

JSON

{

"TotalItems":Numeric,

"AcceptedItems":Numeric,

"FailedItems":Numeric,

"Faults":{

"ActivityId":Numeric,

"Fault":{

"ErrorCode":Numeric,

"ItemValue":"String",

"Message":"String"

}

Response Tag Details

Tag Type Description

TotalItems Numeric Total Number of Items sent in the request for deletion

AcceptedItems Numeric Number of Application Groups successfully deleted

FailedItems Numeric Number of Application Groups not deleted.

Faults Numeric This chunk of XML/JSON indicates the cause of failure in deletion for

some App Groups.

ActivityId Numeric Indicates the Numeric IDof the Fault.

Chapter 4: Application Management

217

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Add Application to an Application Group (*Refactored)

Functionality – Adds applications to the specified application group.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/appgroups/{appgroupid}/addapplications. This URI will be

deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/appgroups/appgroupid/applications (HTTP Method Used – POST)

Response Obtained – NA

Request Payload

XML

<Name>String</Name>

<BundleId>Numeric</BundleId>

</ApplicationGroupItem>

</Applications>

</BulkAppInput>

JSON

{

"Applications":[{

"Name":"String",

"BundleId":Numeric,

}]

}

Request Tag Details

Tag Mandatory Description

Name Yes Name of the application

BundleId Yes Bundle Id of the application

Chapter 4: Application Management

218

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Application from the Application Group (*Refactored)

Functionality – Deletes one of more applications from the specified application group.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/appgroups/{appgroupid}/deleteapplications. This URI will be

deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/appgroups/appgroupid/applications (HTTP Method Used – DELETE)

Response Obtained – NA

Request Payload

XML

<BundleId>String</BundleId>

</ApplicationGroupItem>

<BundleId>String</BundleId>

</ApplicationGroupItem>

</Applications>

</BulkAppInput>

JSON

{

"Applications":[{

"BundleId":"String"

}]

}

Request Tag Details

Tag Mandatory Description

BundleId Yes PackageId of the application

Chapter 4: Application Management

219

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Create VPP Application Allocation (*Refactored)

Functionality – Create a new VPP Licensed App allocation.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/purchased/{applicationid}/assignmentcreate

This URI will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/purchased/applicationid/assignment (HTTP Method Used – POST)

Response Obtained – N/A

Request Payload

XML

<SmartGroupId>Numeric</SmartGroupId>

<Allocated>Numeric</Allocated>

</PurchasedAppAssignment>

</Assignments>

<AssignmentType>String</AssignmentType>

<RemoveOnUnenroll>Boolean</RemoveOnUnenroll>

<PreventApplicationBackup>Boolean</PreventApplicationBackup>

<UseVPN>Boolean</UseVPN>

</Deployment>

<SendApplicationConfiguration>Boolean</SendApplicationConfiguration>

<Id>Numeric</Id>

<Key>String</Key>

<Value>String</Value>

<Type>String</Type>

</AppConfig>

</AppConfigList>

</PurchasedApplication>

JSON

{

"AppConfigList" : [

{

"Key" : "String",

"Type" : "String",

Chapter 4: Application Management

220

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"Value" : "String"

}

"Assignments" : [

{

"Allocated" : Numeric,

"SmartGroupId" : Numeric

}

"Deployment" : {

"AssignmentType" : "String",

"PreventApplicationBackup" : Boolean,

"RemoveOnUnenroll" : Boolean,

"UseVPN" : Boolean

"SendApplicationConfiguration" : Boolean

}

Request Tag Details

Tag Type Description

AssignmentType String Type of the assignment

PreventApplicationBackup Boolean Defines if the application backup to be prevented. Boolean/False

RemoveOnUnenroll Boolean Defines to unenroll the device on removing the VPP application

UseVPN Boolean Defines to use VPN for VPP assignment

AppConfigList Key String Key for Application Configuration list

AppConfigList Type String Type of Application Configuration list

AppConfigList Value String Value of Application Configuration list

Assignments id Numeric ID of the assignment

Assignments Allocated Numeric Assignment allocation

Assignments SmartGroupId Numeric Smart Group ID to which the assignment is configured

SendApplicationConfiguration Boolean Defines if the application configuration must be sent

Chapter 4: Application Management

221

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete VPP Application

Functionality – Deletes the specified purchased app.

HTTP Method – DELETE

API URI – https://host/api/mam/apps/purchased/{applicationid}

Request – N/A

Response – N/A

Delete VPP Application Smart Group Assignment (*Refactored)

Functionality – Delete Assignment

HTTP Method – DELETE

Deprecated API URI – https://host/api/mam/apps/purchased/{applicationid}/deletesmartgroup/{smartgroupid}. This

URI will be deprecated soon. Start using the *Supported API URI henceforth.

*Supported API URI – https://host/api/mam/apps/purchased/{applicationid}/smartgroups/{smartgroupid}

URI Parameter

Tag Type Description

applicationid Numeric Unique application identifier

smartgroupid Numeric Unique smart group identifier

Request Payload – N/A

Response Obtained – N/A

Chapter 4: Application Management

222

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search VPP Application (*Refactored)

Functionality – Search and retrieve details for purchased applications.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/purchasedappsearch?applicationname=

{applicationname}&locationgroupid={locationgroupid}&bundleid={bundleid}&platform={platform}&model=

{model}&status={status}&isassigned={isassigned}&orderby={orderby}&page={page}&pagesize={pagesize}

lExact Match Parameter – platform, model, status, isassigned

lPattern (Contains) Match Parameter – applicationname, locationgroupid, bundleid, orderby, page, pagesize

This URI will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/purchased/search (HTTP Method Used – GET)

Request – N/A

Response Payloads

XML

<ApplicationSearchResult xmlns="http://www.air-

watch.com/servicemodel/resources">

<Page>Numeric</Page>

<PageSize>Numeric</PageSize>

<Total>Numeric</Total>

<Id xmlns="">Numeric</Id>

<ApplicationName>String</ApplicationName>

<BundleId>String</BundleId>

<AppVersion>String</AppVersion>

<ActualFileVersion>String</ActualFileVersion>

<AppType>String</AppType>

<Status>String</Status>

<Platform>Numeric</Platform>

<Model>

<ModelId>Numeric</ModelId>

<ModelName>String</ModelName>

</ApplicationSupportedModel>

<ModelId>Numeric</ModelId>

<ModelName>String</ModelName>

</ApplicationSupportedModel>

</Model>

</SupportedModels>

<AssignmentStatus>String</AssignmentStatus>

Chapter 4: Application Management

223

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<ApplicationSize>String</ApplicationSize>

<CategoryId>Numeric</CategoryId>

<Name>String</Name>

</Category>

<CategoryId>Numeric</CategoryId>

<Name>String</Name>

</Category>

</CategoryList>

<Id>Numeric</Id>

<Name>String</Name>

</SmartGroup>

<Id>Numeric</Id>

<Name>String</Name>

</SmartGroup>

</SmartGroups>

<Comments>String</Comments>

<IsReimbursable>Boolean</IsReimbursable>

<ApplicationUrl>String</ApplicationUrl>

<LocationGroupId>Numeric</LocationGroupId>

<ExternalId>String</ExternalId>

<LargeIconUri>String</LargeIconUri>

<MediumIconUri>String</MediumIconUri>

<SmallIconUri>String</SmallIconUri>

<AssignedDeviceCount>Numeric</AssignedDeviceCount>

<InstalledDeviceCount>Numeric</InstalledDeviceCount>

<NotInstalledDeviceCount>Numeric</NotInstalledDeviceCount>

</ApplicationEntity>

</Application>

</ApplicationSearchResult>

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"Application":[{

"Id":Numeric,

"ActualFileVersion":"String",

Chapter 4: Application Management

224

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"AppType":"String",

"AppVersion":"String",

"ApplicationName":"String",

"ApplicationSize":"String",

"ApplicationUrl":"String",

"AssignedDeviceCount":Numeric,

"AssignmentStatus":"String",

"BundleId":"String",

"CategoryList":{

"Category":[{

"CategoryId":Numeric,

"Name":"String"

}]

"Comments":"String",

"ExternalId":"String",

"InstalledDeviceCount":Numeric,

"IsReimbursable":Boolean,

"LargeIconUri":"String",

"LocationGroupId":Numeric,

"MediumIconUri":"String",

"NotInstalledDeviceCount":Numeric,

"Platform":Numeric,

"PushMode":0,

"SmallIconUri":"String",

"SmartGroups":[{

"Id":Numeric,

"Name":"String"

}],

"Status":"String",

"SupportedModels":{

"Model":[{

"ApplicationId":Numeric,

"ModelId":Numeric,

"ModelName":"String"

}]

}

}]

}

Response Tag Details

Tag Type Description

Page Numeric Page number of the search result

PageSize Numeric Number of device VPPapps shown on each page

Total Numeric Total number of VPP applications on the device

ApplicationName String Name of the VPP application

BundleId String Unique bundle identification of the VPP application

Chapter 4: Application Management

225

VMware AirWatch REST API Guide | v.2016.04 | April 2017

AppVersion String Version of the VPPapplication

ActualFileVersion String Version of the application file

AppType String Type of the application. "Public" ,"Internal", or "Purchased"

Status String Current Status of the application. "Active" or "Inactive"

Platform Numeric Device platform

ModelId Numeric ID of the Device Model. Refer Tables for the List of Model IDs

ModelName String Name of the Device Model

AssignmentStatus String Current assignment state of the application. "Assigned" or "Not

Assigned"

ApplicationSize String Application size in bytes

CategoryId Numeric Numeric ID of the Category of the VPP application

Name String Name of the Category of the VPPapplication

Comments String Comments associated with the purchased applications

ApplicationUrl String URL of a purchased Application

LocationGroupId Numeric Unique Numeric ID of the Organization Group where the

application is present

ExternalId Numeric Is the track ID of the application from the App Store for iOS

AssignedDeviceCount Numeric Number of the assigned devices with the application

InstalledDeviceCount Numeric Number of the devices with the application installed

NotInstalledDeviceCount Numeric Number of the devices with the application not installed

IsReimbursable Boolean/Numeric Is the purchased application reimbursable

Chapter 4: Application Management

226

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Get VPP Allocation Details

Functionality – Returns VPP Licensed Application allocation details by AppId.

HTTP Method – GET

API URI – https://host/api/mam/apps/purchased/{applicationid}

Request Payload – N/A

Response Payloads

XML

<ManagedBy>Numeric</ManagedBy>

<TotalLicenses>Numeric</TotalLicenses>

<OnHold>Numeric</OnHold>

<Allocated>Numeric</Allocated>

<Unallocated>Numeric</Unallocated>

<Redeemed>Numeric</Redeemed>

<ExternallyRedeemed>Numeric</ExternallyRedeemed>

</Orders>

<TotalLicenses>Numeric</TotalLicenses>

<OnHold>Numeric</OnHold>

<Allocated>Numeric</Allocated>

<Unallocated>Numeric</Unallocated>

<Redeemed>Numeric</Redeemed>

<ExternallyRedeemed>Numeric</ExternallyRedeemed>

</Licenses>

<Status>String</Status>

<SmartGroupId>Numeric</SmartGroupId>

<LocationGroupId>String</LocationGroupId>

<Users>Numeric</Users>

<Allocated>Numeric</Allocated>

<Redeemed>Numeric</Redeemed>

<AssignmentRuleType>String</AssignmentRuleType>

</Assignment>

<Status>String</Status>

<SmartGroupId>Numeric</SmartGroupId>

<LocationGroupId>String</LocationGroupId>

<Users>Numeric</Users>

<Allocated>Numeric</Allocated>

<Redeemed>Numeric</Redeemed>

<AssignmentRuleType>String</AssignmentRuleType>

</Assignment>

Chapter 4: Application Management

227

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</Assignments>

<AssignmentType>String</AssignmentType>

<RemoveOnUnenroll>Boolean</RemoveOnUnenroll>

<PreventApplicationBackup>Boolean</PreventApplicationBackup>

<UseVPN>Boolean</UseVPN>

</Deployment>

</PurchasedApp>

JSON

{

"Assignments":[{

"Allocated":Numeric,

"AssignmentRuleType":"String",

"LocationGroupId":"String",

"Redeemed":Numeric,

"SmartGroupId":Numeric,

"Status":"String",

"Users":Numeric

}],

"Deployment":{

"AssignmentType":"String",

"PreventApplicationBackup":Boolean,

"RemoveOnUnenroll":Boolean,

"UseVPN":Boolean

"Licenses":{

"Allocated":Numeric,

"ExternallyRedeemed":Numeric,

"OnHold":Numeric,

"Redeemed":Numeric,

"TotalLicenses":Numeric,

"Unallocated":Numeric

"ManagedBy":Numeric,

"Orders":{

"Allocated":Numeric,

"ExternallyRedeemed":Numeric,

"OnHold":Numeric,

"Redeemed":Numeric,

"TotalLicenses":Numeric,

"Unallocated":Numeric

}

Chapter 4: Application Management

228

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Tag Details

Tag Type Description

Allocated Numeric Number of assignments allocated to the device

AssignmentRuleType String Type of the assignment rule

LocationGroupId Numeric Unique identification of the organization group

Redeemed Numeric Number of assignments redeemed

SmartGroupId Numeric Unique identification of the smart group

Status String Status of the assignment rule

Users Numeric Number of the device users with the VPP licensed application

assignment rule

AssignmentType String Type of the assignment

PreventApplicationBackup Boolean Defines if the application backup to be prevented. True/False

RemoveOnUnenroll Boolean Defines the unenrollment of the device on the removal of the

application. True/False

UseVPN Boolean Use VPN for deployment. True/False.

Licenses Allocated Numeric Number of VPP licenses allocated

Licenses ExternallyRedeemed Numeric Number of externally redeemed licenses

Licenses OnHold Numeric Number of on-hold licenses

Licenses Redeemed Numeric Number of redeemed licenses

Licenses TotalLicenses Numeric Total number of licenses

Licenses Unallocated Numeric Number of unallocated licenses

Orders Allocated Numeric Number of allocated VPP orders

Orders ExternallyRedeemed Numeric Number of externally redeemed orders

Orders OnHold Numeric Number of on-hold orders

Orders Redeemed Numeric Number of redeemed orders

Orders TotalLicenses Numeric Total number of orders

Orders Unallocated Numeric Number of unallocated orders

Chapter 4: Application Management

229

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update VPP Licensed Application Assignment (*Refactored)

Functionality – Updates VPP licensed application assignment.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/purchased/{applicationid}/update. This URI will be deprecated soon.

Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/purchased/applicationid (HTTP Method Used – PUT)

Response Obtained – NA

URI Parameter

Tag Type Description

applicationid Numeric Unique VPP application identifier

Request Payload

XML

<PurchasedApp xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.air-

watch.com/servicemodel/resources">

<ManagedBy>Numeric</ManagedBy>

<TotalLicenses>Numeric</TotalLicenses>

<OnHold>Numeric</OnHold>

<Allocated>Numeric</Allocated>

<Unallocated>Numeric</Unallocated>

<Redeemed>Numeric</Redeemed>

<ExternallyRedeemed>Numeric</ExternallyRedeemed>

</Orders>

<TotalLicenses>Numeric</TotalLicenses>

<OnHold>Numeric</OnHold>

<Allocated>Numeric</Allocated>

<Unallocated>Numeric</Unallocated>

<Redeemed>Numeric</Redeemed>

<ExternallyRedeemed>Numeric</ExternallyRedeemed>

</Licenses>

<Status>Boolean</Status>

<SmartGroupId>Numeric</SmartGroupId>

<Users>Numeric</Users>

<Allocated>Numeric</Allocated>

<Redeemed>Numeric</Redeemed>

Chapter 4: Application Management

230

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</PurchasedAppAssignment>

</Assignments>

<SendApplicationConfiguration>Boolean</SendApplicationConfiguration>

<Key>String</Key>

<Value>String</Value>

<Type>String</Type>

</AppConfig>

</AppConfigList>

</PurchasedApp>

JSON

{

"AppConfigList" : [

{

"Key" : "Text value",

"Type" : "Text value",

"Value" : "Text value"

"ManagedBy" : Numeric,

}

"Orders" : {

"TotalLicenses" : Numeric,

"OnHold" : Numeric,

"Allocated" : Numeric,

"Unallocated" : Numeric,

"Redeemed" : Numeric,

"ExternallyRedeemed" : Numeric

"Licenses" : {

"TotalLicenses" : Numeric,

"OnHold" : Numeric,

"Allocated" : Numeric,

"Unallocated" : Numeric,

"Redeemed" : Numeric,

"ExternallyRedeemed" : Numeric

"ManagedBy" : Numeric,

"Assignments" : [

{

"Status" : "Boolean",

"SmartGroupId" : Numeric,

"Users" : Numeric,

"Allocated" : Numeric,

"Redeemed" : Numeric

}

Chapter 4: Application Management

231

VMware AirWatch REST API Guide | v.2016.04 | April 2017

]

"SendApplicationConfiguration" : Boolean

}

Request Tag Details

Tag Type Description

Orders TotalLicenses Numeric Total number of orders

Orders OnHold Numeric Number of on-hold orders

Orders Allocated Numeric Number of allocated VPP orders

Orders Unallocated Numeric Number of unallocated orders

Orders Redeemed Numeric Number of redeemed orders

Orders ExternallyRedeemed Numeric Number of externally redeemed orders

Licenses TotalLicenses Numeric Total number of licenses

Licenses OnHold Numeric Number of on-hold licenses

Licenses Allocated Numeric Number of VPP licenses allocated

Licenses Unallocated Numeric Number of unallocated licenses

Licenses Redeemed Numeric Number of redeemed licenses

Licenses ExternallyRedeemed Numeric Number of externally redeemed licenses

Status Boolean Status of the assignment rule

SmartGroupId Numeric Unique identifier of the smart group

Allocated Numeric Number of assignments allocated to the device

Redeemed Numeric Number of assignments redeemed

SendApplicationConfiguration Boolean Defines if the application configuration must be sent

ManagedBy Numeric Group IDof the Organization Group

AppConfigList key String Key for Application Configuration list

AppConfigList Type String Type of Application Configuration list

AppConfigList Value String Value of Application Configuration list

Chapter 4: Application Management

232

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Queues Sync Assets for VPP Applications

Functionality – Queues up Sync Assets job for Apple VPP applications.

HTTP Method – PUT

API URI – https://host/api/mam/apps/purchased/VppSyncAssets/{locationGroupId}

URI Parameters

Tag Type Description

locationGroupId Numeric Organization group of which sync is requested

Request Payload – NA

Response Payload

JSON

{}

Chapter 4: Application Management

233

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Resets the Client Context

Functionality – Resets the client context for the account at passed organization group.

HTTP Method – PUT

API URI – https://host/api/mam/apps/purchased/ResetClientAcontextForAccount/{locationGroupId:int}

URI Parameters

Tag Type Description

locationGroupId Numeric Organization group Id for the account where reset action is intended

Request Payload – NA

Response Payload

JSON

{}

Chapter 4: Application Management

234

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Get VPP Sync Assets Status

Functionality – Retrieves the status and details of the VPP Sync Assets for the VPP Account at passed organization group.

HTTP Method – GET

API URI – https://host/api/mam/apps/purchased/GetVppSyncAssetsStatus/{locationGroupId:int}

URI Parameters

Tag Type Description

locationGroupId Numeric Organization group Id for the account where reset action is intended

Request Payload – NA

Response Payload

JSON

{}

Chapter 4: Application Management

235

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Enable Device Based Assignment For VPP Applications

Functionality – Enables the device based Assignment for the VPP applications.

HTTP Method – PUT

API URI – https://host/api/mam/apps/purchased/EnableDeviceAssignmentForVppApp/{AppId:int}

URI Parameters

Tag Type Description

appId Numeric app Id for which device based assignment needs to be enabled

Request Payload – NA

Response Payload

JSON

{}

Update Application on Devices Having Device Based Licenses

Functionality – Updates the application on devices having device based licenses for the application if an update is

available.

HTTP Method – POST

API URI – https://host/api/mam/apps/purchased/{appId}

Request Payload – NA

Response Obtained – N/A

URI Parameters

Tag Type Description

appId Numeric Unique identifier of the application

Auto Update Flag for Device based VPP App

Functionality – Sets the value of the auto update flag for a device based VPP application.

HTTP Method – PATCH

API URI – https://host/api/mam/apps/purchased/{appId}

Response Obtained – N/A

Chapter 4: Application Management

236

VMware AirWatch REST API Guide | v.2016.04 | April 2017

URI Parameters

Tag Type Description

appId Numeric Unique identifier of the application

Request Payload

XML

<PurchasedAppsAutoUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<IsAutoUpdateEnabled xmlns="http://www.air-

watch.com/webapi/resources">Boolean</IsAutoUpdateEnabled>

</PurchasedAppsAutoUpdate>

JSON

{

"IsAutoUpdateEnabled" : Boolean

}

Request Tag Details

Tag Mandatory Description

IsAutoUpdateEnabled Yes Whether the auto update flag for device based VPP application is

enabled or not. Value: True or False.

Chapter 4: Application Management

237

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Get VPP Invite Status (*Refactored)

Functionality – Gets User's VPP invite status.

HTTP Method – GET

Deprecated API URI – https://host/api/mam/apps/purchased/{applicationid}/getvppinvitestatus/{deviceid}. This URI

will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/purchased/applicationid/vppinvitestatus/deviceid (HTTP Method

Used – GET)

Request Payload – N/A

URIParameters

Tag Type Description

applicationid Numeric Unique VPP application identifier

deviceid Numeric Unique device identifier

Response Payload

XML

<ApplicationId>Numeric</ApplicationId>

<DeviceId>Numeric</DeviceId>

<Status>String</Status>

</UserVppInviteStatus>

JSON

{

"ApplicationId":Numeric,

"DeviceId":Numeric,

"Status":"String"

}

Response Tag Details

Tag Type Description

ApplicationId Numeric Unique identification number of the VPPapplication

DeviceId Numeric Unique identifier of the device

Status String Status of the application

Chapter 4: Application Management

238

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Send Bulk VPP Invite (*Refactored)

Functionality – Sends VPP invites to the users.

HTTP Method – POST

Deprecated API URI – https://host/api/mam/apps/purchased/{applicationid}/sendvppinvite. This URI will be

deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mam/apps/purchased/applicationid/vppinvite (HTTP Method Used – POST)

Request Payload

XML

<Value>String</Value>

</BulkValues>

</BulkInput>

JSON

{

"BulkValues":{

"Value":["String"]

}

Request Tag Details

Tag Mandatory Description

Value Yes (at least

Represents the unique device ID of the VPPapplication

Response Payload

XML

<TotalItems>Numeric</TotalItems>

Chapter 4: Application Management

239

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<AcceptedItems>Numeric</AcceptedItems>

<FailedItems>Numeric</FailedItems>

<ActivityId>String</ActivityId>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

</Faults>

</BulkResponse>

JSON

{

"AcceptedItems":Numeric,

"FailedItems":Numeric,

"Faults":{

"Fault":[{

"ErrorCode":Numeric,

"ItemValue":"String",

"Message":"String"

}]

"TotalItems":Numeric

}

Response Tag Details

Tag Type Description

TotalItems Numeric Total number of VPP invite request sent

AcceptedItems Numeric Number of VPP invites successfully sent

FailedItems Numeric Number of VPP invites not sent

ActivityId Numeric Indicates the Numeric ID of the Fault.

Fault Numeric This chunk of XML/JSON indicates the cause of failure in sending VPP

invites.

ErrorCode Numeric HTTP status code for the failed element

Chapter 4: Application Management

240

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Windows App Dependency

Functionality – Gets the details of an Windows app dependency identified by ID.

HTTP Method – GET

API URI – https://host/api/mam/apps/internal/windowsappdependency/{windowsAppDependencyId}

Request Payload – NA

URI Parameters

Tag Type Description

windowsAppDependencyId Numeric Identifier of the Windows app dependency to be retrieved

Response Payload

XML

<Id xmlns="http://www.air-watch.com/webapi/resources">Numeric</Id>

<Name xmlns="http://www.air-watch.com/webapi/resources">String</Name>

<LocationGroupId xmlns="http://www.air-

watch.com/webapi/resources">Numeric</LocationGroupId>

<IsSystemApp xmlns="http://www.air-

watch.com/webapi/resources">Boolean</IsSystemApp>

<BlobId xmlns="http://www.air-watch.com/webapi/resources">Numeric</BlobId>

<Version xmlns="http://www.air-watch.com/webapi/resources">String</Version>

<ProcessorArchitecture xmlns="http://www.air-

watch.com/webapi/resources">String</ProcessorArchitecture>

<PackageFamilyName xmlns="http://www.air-

watch.com/webapi/resources">String</PackageFamilyName>

<PackageId xmlns="http://www.air-

watch.com/webapi/resources">String</PackageId>

<CriteriaType>String</CriteriaType>

<ApplicationIdentifier>String</ApplicationIdentifier>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

Chapter 4: Application Management

241

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

</DataContingencies>

<DiskSpaceRequiredInKb>Numeric</DiskSpaceRequiredInKb>

<DevicePowerRequired>Numeric</DevicePowerRequired>

<RamRequiredInMb>Numeric</RamRequiredInMb>

</WhenToInstall>

<InstallContext>String</InstallContext>

<InstallCommand>String</InstallCommand>

<AdminPrivileges>Boolean</AdminPrivileges>

<DeviceRestart>String</DeviceRestart>

<RetryCount>Numeric</RetryCount>

<RetryIntervalInMinutes>Numeric</RetryIntervalInMinutes>

<InstallTimeoutInMinutes>Numeric</InstallTimeoutInMinutes>

<InstallerRebootExitCode>String</InstallerRebootExitCode>

<InstallerSuccessExitCode>String</InstallerSuccessExitCode>

</HowToInstall>

<WhenToCallInstallComplete xmlns="http://www.air-

watch.com/webapi/resources">

<UseAdditionalCriteria>Boolean</UseAdditionalCriteria>

<IdentifyApplicationBy>String</IdentifyApplicationBy>

<CriteriaType>String</CriteriaType>

<ApplicationIdentifier>String</ApplicationIdentifier>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

</AppCriteria>

<Path>String</Path>

<VersionCondition>String</VersionCondition>

<MajorVersion>Numeric</MajorVersion>

<MinorVersion>Numeric</MinorVersion>

Chapter 4: Application Management

242

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<RevisionNumber>Numeric</RevisionNumber>

<BuildNumber>Numeric</BuildNumber>

<ModifiedOn>String</ModifiedOn>

</FileCriteria>

<Path>String</Path>

<KeyName>String</KeyName>

<KeyType>String</KeyType>

<KeyValue>String</KeyValue>

</RegistryCriteria>

<LogicalCondition>String</LogicalCondition>

</DeploymentByCriteria>

</CriteriaList>

<ScriptType>String</ScriptType>

<CommandToRunTheScript>String</CommandToRunTheScript>

<CustomScriptFileBlodId>Numeric</CustomScriptFileBlodId>

<SuccessExitCode>Numeric</SuccessExitCode>

</CustomScript>

</WhenToCallInstallComplete>

</DeploymentOptions>

<AppDependenciesList xmlns="http://www.air-

watch.com/webapi/resources">

<Name>String</Name>

<ApplicationDependencyId>Numeric</ApplicationDependencyId>

</ApplicationDependency>

</AppDependenciesList>

<TransformFileName>String</TransformFileName>

<TransformBlobId>Numeric</TransformBlobId>

</ApplicationTransform>

</AppTransformsList>

<PatchFileName>String</PatchFileName>

<PatchBlobId>Numeric</PatchBlobId>

<PatchType>String</PatchType>

<BuildVersion>String</BuildVersion>

</ApplicationPatch>

</AppPatchesList>

<ApplicationUnInstallProcess xmlns="http://www.air-

watch.com/webapi/resources">

<UseCustomScript>Boolean</UseCustomScript>

<CustomScriptType>String</CustomScriptType>

<UninstallCommand>String</UninstallCommand>

<UninstallScriptBlobId>Numeric</UninstallScriptBlobId>

</CustomScript>

Chapter 4: Application Management

243

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</ApplicationUnInstallProcess>

</FilesOptions>

</WindowsAppDependency>

JSON

{

"id" : "Numeric,

"BlobId" : "String",

"DeploymentOptions" : {

"HowToInstall" : {

"AdminPrivileges" : Boolean,

"InstallCommand" : "String",

"WhenToCallInstallComplete" : {

"CriteriaList" : [

{

"AppCriteria" : {

"ApplicationIdentifier" : "String",

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"CriteriaType" : "String",

"FileCriteria" : {

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"ModifiedOn" : "String",

"Path" : "String",

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"LogicalCondition" : "String",

"RegistryCriteria" : {

"KeyName" : "String",

"KeyType" : "String",

"KeyValue" : "String",

"Path" : "String"

}

"CustomScript" : {

"CommandToRunTheScript" : "String",

"CustomScriptFileBlodId" : Numeric,

"ScriptType" : "String",

Chapter 4: Application Management

244

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"SuccessExitCode" : Numeric

"IdentifyApplicationBy" : "String",

"UseAdditionalCriteria" : Boolean

"WhenToInstall" : {

"DataContingencies" : [

{

"AppCriteria" : {

"ApplicationIdentifier" : "String",

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"CriteriaType" : "String",

"FileCriteria" : {

"BuildNumber" : Numeric,

"MajorVersion" : Numeric,

"MinorVersion" : Numeric,

"ModifiedOn" : "String",

"Path" : "String",

"RevisionNumber" : Numeric,

"VersionCondition" : "String"

"LogicalCondition" : "String",

"RegistryCriteria" : {

"KeyName" : "String",

"KeyType" : "String",

"KeyValue" : "String",

"Path" : "String"

}

"DevicePowerRequired" : Numeric,

"DiskSpaceRequiredInKb" : Numeric,

"RamRequiredInMb" : Numeric

}

"Description" : "String",

"Developer" : "String",

"DeveloperEmail" : "String",

"DeveloperPhone" : "String",

"DeviceType" : "String",

"EnableProvisioning" : Boolean,

"FileName" : "String",

"FilesOptions" : {

"AppDependenciesList" : [

{

"ApplicationDependencyId" : Numeric

Chapter 4: Application Management

245

VMware AirWatch REST API Guide | v.2016.04 | April 2017

}

"AppPatchesList" : [

{

"PatchBlobId" : Numeric,

"PatchType" : "String"

}

"AppTransformsList" : [

{

"TransformBlobId" : Numeric

}

"ApplicationUnInstallProcess" : {

"CustomScript" : {

"CustomScriptType" : "String",

"UninstallCommand" : "String",

"UninstallScriptBlobId" : Numeric

"UseCustomScript" : Boolean

}

"IsSystemApp" : Boolean,

"LocationGroupId" : Numeric,

"Name" : "String",

"PackageFamilyName" : "String",

"PackageId" : "String",

"ProcessorArchitecture" : "String",

"Version" : "String"

}

Response Tag Details

Tag Type Description

BlobId String Unique blob ID of the application

AdminPrivileges Boolean Whether or not the installation should be initiated with logged-in user

privileges or with stepped up administrative permissions.

InstallCommand String Install command for the application

ApplicationIdentifier String Unique identifier of the application

BuildNumber Numeric Build number of the application

MajorVersion Numeric Major version of the application

MinorVersion Numeric Minor version of the application

RevisionNumber Numeric Revision number of the application

VersionCondition String Version condition of the application

Chapter 4: Application Management

246

VMware AirWatch REST API Guide | v.2016.04 | April 2017

CriteriaType String Type of the criteria

ModifiedOn Datetime Timestamp when the application was last modified

Path String The path and name of a file that has to be verified on your end user’s

devices

LogicalCondition String Logical condition of the application

KeyName String For registry criteria, enter the key name

KeyValue String For registry criteria, enter the key value

KeyType String For registry criteria, enter the key type

Path String Registry path in the format "HKLM\Software\.."

CommandToRunTheScrip String Command to run the script

CustomScriptFileBlodId Numeric Blob ID of the custom script file

ScriptType String Type of the script

SuccessExitCode Numeric Code of the success exit

IdentifyApplicationBy String Specify how to identify the application

UseAdditionalCriteria Boolean Specify additional criteria

DevicePowerRequired Numeric Specify the required device power

DiskSpaceRequiredInKb Numeric Specify the disc space required in Kb

RamRequiredInMb Numeric Specify the device ram required in Mb

Description String Description of the application

Developer String Developer of the application

DeveloperEmail String Email ID of the developer

DeveloperPhone String Phone number of the developer

DeviceType String Type of the device used

EnableProvisioning Boolean Is provisioning needs to be enabled or not. Supported values are True

and False.

FileName String Name of the file

ApplicationDependencyId Numeric Unique application dependency identifier

PatchBlobId Numeric Blob ID of the application patch

PatchType String Application patch type

TransformBlobId Numeric Blob ID of app transformation list

CustomScriptType String For application uninstall process, specify the type of custom script

UninstallCommand String Specify the uninstall command for application uninstall process

UninstallScriptBlobId Numeric Specify the blob ID of the uninstall script for application uninstall

process

Chapter 4: Application Management

247

VMware AirWatch REST API Guide | v.2016.04 | April 2017

UseCustomScript Boolean Whether to use custom script or not

IsSystemApp Boolean Indicate if the application is a seeded dependency application within

the AirWatch system

LocationGroupId Numeric Unique identifier of the Organization Group

Name String Name of the application

PackageFamilyName String Name of the package family

PackageId String Unique identifier of the package

ProcessorArchitecture String The architecture type of the end user devices that the application

supports

Version String Version of the application

Chapter 4: Application Management

248

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve List of Windows App Dependency Files

Functionality – Retrieves the list of saved Windows app dependency files for current organization group and child

Organization Groups.

HTTP Method – GET

API URI – https://host/api/mam/apps/internal/windowsappdependencies/{organizationGroupId}

Request Payload – NA

URI Parameters

Tag Type Description

organizationGroupId Numeric Identifier of the Organization Group

Response Payload

XML

<Id xmlns="http://www.air-watch.com/webapi/resources">Numeric</Id>

<Name xmlns="http://www.air-watch.com/webapi/resources">String</Name>

<LocationGroupId xmlns="http://www.air-

watch.com/webapi/resources">Numeric</LocationGroupId>

<IsSystemApp xmlns="http://www.air-

watch.com/webapi/resources">Boolean</IsSystemApp>

<BlobId xmlns="http://www.air-

watch.com/webapi/resources">Numeric</BlobId>

<Version xmlns="http://www.air-

watch.com/webapi/resources">String</Version>

<ProcessorArchitecture xmlns="http://www.air-

watch.com/webapi/resources">String</ProcessorArchitecture>

<PackageFamilyName xmlns="http://www.air-

watch.com/webapi/resources">String</PackageFamilyName>

<PackageId xmlns="http://www.air-

watch.com/webapi/resources">String</PackageId>

</WindowsAppDependency>

</ArrayOfWindowsAppDependency>

Chapter 4: Application Management

249

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

[

{

"id" : Numeric,

"BlobId" : Numeric,

"IsSystemApp" : Boolean,

"LocationGroupId" : Numeric,

"Name" : "String",

"PackageFamilyName" : "String",

"PackageId" : "String",

"ProcessorArchitecture" : "String",

"Version" : "String"

}

]

Response Tag Details

Tag Type Description

BlobId Numeric Unique identifier obtained from the "Upload Blob" API response

IsSystemApp Boolean Indicate if the application is a seeded dependency application within

the AirWatch system

LocationGroupId Numeric Numeric ID of the organization group to retrieve list of Windows

application dependency files

Name String Name of the application

PackageFamilyName String Name of the package family

PackageId String Unique identifier of the package

ProcessorArchitecture String The architecture type of the end user devices that the application

supports

Version String Version of the application

Chapter 4: Application Management

250

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Windows Dependency Application

Functionality – Deletes the Windows dependency application specified by ID.

HTTP Method – DELETE

API URI – https://host/api/mam/apps/internal/windowsappdependency/{windowsAppDependencyId}

URI Parameters

Tag Type Description

windowsAppDependencyId Numeric Identifier of the dependency to be deleted

Request Payload – NA

Response Obtained – NA

Chapter 4: Application Management

251

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search and Retrieve Removal Logs for Internal Applications

Functionality – Searches and retrieves removal logs for internal applications.

If the number of remove application commands queued in a set time interval exceeds the configured threshold, the

commands are put in locked state. This API method returns the details of the commands that are put in locked state.

HTTP Method – GET

API URI – https://host/api/mam/apps/removallogs?organizationgroupid={organizationgroupid}&bundleid=

{bundleid}&status={status}&page={page}&pagesize={pagesize}&orderby={orderby}

Response Payload – N/A

URI Parameters

Tag Type Description

bundleid String Bundle ID or package ID of the application

organizationgroupid String Unique identifier of the Organization Group

status String Status of the command

page String Page number

pagesize String Number of records per page

orderby String Order by column name

Response Payload

XML

<AppRemovalProtectionLogSearchResultModel

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

</AdditionalInfo>

<TotalResults>Numeric</TotalResults>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

<Identifier>String</Identifier>

<Source>Numeric</Source>

<ThresholdStatus>Numeric</ThresholdStatus>

<ThresholdId>Numeric</ThresholdId>

</AppRemovalProtectionModel>

Chapter 4: Application Management

252

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</ResultSet>

</AppRemovalProtectionLogSearchResultModel>

JSON

{

"ResultSet" : [

{

"CreatedOn" : "Datetime",

"ModifiedOn" : "Datetime",

"Identifier" : "String",

"Source" : Numeric,

"ThresholdStatus" : Numeric,

"ThresholdId" : Numeric

}

"AdditionalInfo" : {

"Links" : [],

"id" : Numeric

"TotalResults" : Numeric

}

Response Tag Details

Tag Type Description

CreatedOn Datetime Timestamp when the internal application was last created

ModifiedOn Datetime Timestamp when the internal application was last modified

Identifier String Unique identifier of the application

Source Numeric Source of the internal application

ThresholdStatus Numeric Indicates the action taken or to be taken by the administrator on the

held commands. The values can be Held for admin approval,

Commands released to devices, and Commands dismissed from the

queue.

ThresholdId Numeric Identifier for the log record. This should be passed as an input in the

‘PUT’ request body to take action on the held remove commands.

Links String Link to download the application

id Numeric Unique identifier of the Organization Group

TotalResults Numeric Total results shown per page

Chapter 4: Application Management

253

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Removal Logs

Functionality – Updates the action taken on the threshold. Either unlock/clear the threshold. On unlock, the commands

are sent to the device. On clear, the commands are purged from the queue.

Note:Add the assignments back to the application if you choose to dismiss the remove commands. This is to prevent

the applications from being removed from devices on subsequent checks for assignment or entitlement.

HTTP Method – PUT

API URI – https://host/api/mam/apps/removallogs?organizationgroupid={organizationgroupid}

URI Parameters

Tag Type Description

organizationgroupid String Unique identifier of the Organization Group

Response Obtained – NA

Request Payload

XML

<UpdateAppRemovalProtectionModel

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<ThresholdId>Numeric</ThresholdId>

<NewThresholdStatus>Numeric</NewThresholdStatus>

</UpdateAppRemovalProtectionModel>

JSON

{

"ThresholdId" : Numeric,

"NewThresholdStatus" : Numeric

}

Request Tag Details

Tag Mandatory Description

Chapter 4: Application Management

254

VMware AirWatch REST API Guide | v.2016.04 | April 2017

ThresholdId Yes Identifier for the log record. This should be passed as an input in the

‘PUT’ request body to take action on the held remove commands.

NewThresholdStatus Yes Indicates the action to be taken by the administrator on the held

commands. The values can be one of the following: Release

commands to devices, Dismiss commands from the queue.

Chapter 4: Application Management

255

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Chapter 5:

Content Management

Overview 258

Personal Content Overview 258

Retrieve List of Files and Folders 259

Move Files to Target Folder 263

Delete a File 267

Retrieve File Metadata 268

Share Content 271

Download File 273

Remove File Sharing 274

Get File Sharing Information 275

Update File Metadata Information 277

Upload Content/Files 282

Explicit Upload Initialize 286

Explicit Upload Finalize 288

Retrieve Folder Information 291

Create Folder 294

Update Folder 298

Move Folder 302

Delete Folder 306

Return Sharing Metadata 307

Retrieve Collaborator List 309

Remove Sharing 311

256

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Share Folder with Users or UserGroups 312

Update Collaborator 316

Remove Sharing on Collaborator Folder 320

Update Collaborator of Shared Folder 322

Retrieve Admin Storage Information 326

Managed Content Overview 327

Retrieve All Categories 328

Create New Category 330

Delete Category 332

Update Category 333

Upload AirWatch Managed Content 335

Download AirWatch Managed Content 340

Delete AirWatch Managed Content 341

Retrieve AirWatch Managed Content 342

Update AirWatch Managed Content 347

Retrieve List of AirWatch Managed Content 354

Chapter 5: Content Management

257

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Overview

AirWatch REST APIs provide the ability to access and manage both Personal Content and AirWatch Managed Content.

You need to have separate APIaccount types to access Personal Content APIs and Managed Content APIs.

Note: Personal Content APIs only support Basic Authentication. For more details, please refer API Authentication on

page 32. For more details on configuring Personal Content APIs and Managed Content APIs, see Enabling Personal

Content API Access on page 29.

Personal Content Overview

With Enrollment User as account type, you can access all the Personal Content APIs. To do this, navigate to Groups

&Settings > All Settings > System > Advanced > API > RESTAPI, and select Add, to generate API key for the service and

account type as Enrollment User. Using Personal Content APIs, you can add, move, share, and delete Files and Folders.

Personal Content details can be viewed on the AirWatch Self Service Portal:

lPersonal Content – Self Service Portal > My Content.

Personal Content APIs are divided into three parts:

lContents – Personal Content APIs perform operations to obtain information about the files and folder structure

within AirWatch Personal Content.

lFiles – Personal Content Files APIs perform operations to obtain information about the files and to perform actions

on them.

lFolders – Personal Content Folder APIs perform operations to obtain information about the folders and to perform

actions on them.

Chapter 5: Content Management

258

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve List of Files and Folders

Functionality – Retrieves the list of Files and Folders.

HTTP Method – GET

API URI – https://host/api/mcm/contents?queryString={queryString}&folderId={folderId}&mimeType=

{mimeType}&includeTrashed={includeTrashed}&isShared={isShared}&modifiedSince={modifiedSince}&pageSize=

{pageSize}&startIndex={startIndex}

Request Payload – NA

URI Parameters

Tag Type Description

queryString String Searches for the string value in the File or Folder Name

folderId Numeric The unique identifier for the Folder being queried. If the Folder ID is not

provided, the Contents at the Root Level are displayed

mimeType String Filter contents by Mime Type

includeTrashed Boolean Include Content that has already been moved to the Trash Folder

isShared Boolean Filter by shared contents. If set to 'True', only Shared Content is

returned

modifiedSince Datetime Filter by Content that has been modified on or after the specified Date

startIndex Numeric Start index of page

pageSize Numeric Specifies the number of results returned per Page

Response Payload

XML

<Id>Numeric</Id>

<Links>

<Link>

<Rel>String</Rel>

<Href>String</Href>

</Link>

</Links>

</AdditionalInfo>

<TotalResults xmlns="http://www.air-

watch.com/webapi/resources">Numeric</TotalResults>

Chapter 5: Content Management

259

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

<Title xmlns="http://www.air-

watch.com/webapi/resources">String</Title>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

</ResultSet>

</ContentPagedResultModel>

JSON

{

"AdditionalInfo": {

"Links":[{

"Href":"String",

"Rel":"String",

}],

"TotalResults":Numeric

"content":[

{

Chapter 5: Content Management

260

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"Links":[{

"Href":"String",

"Rel":"String",

}],

"contentId":"String",

"parentId":"String",

"name":"String",

"mimeType":"String",

"sharingRole":"String",

"owner":"String",

"isFavorite":Boolean,

"isTrashed":Boolean,

"isShared":Boolean,

"downloadMethod":"String",

"downloadWhileRoaming":Boolean,

"forceEncryption":Boolean,

"currentVersionNumber":"String",

"description":"String",

"notes":"String",

"subject":"String",

"downloadLink":"String",

"size":Numeric,

"createdOn":"Datetime

"modifiedOn":"Datetime

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the content

parentId String Unique identifier of the parent organization group

name String Name of the content

mimeType String Type of the MIME to filter contents

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

owner String Owner of the content

isFavorite Boolean Is the content favorite. True or False

isTrashed Boolean Is the content trashed. True or False

isShared Boolean Is the content shared. True or False

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

Chapter 5: Content Management

261

VMware AirWatch REST API Guide | v.2016.04 | April 2017

currentVersionNumber String The current version of the content

description String Description about the content

notes String Additional notes regarding the content

subject String Subject of the content

downloadLink String Link to download the content

size Numeric Size of the content

createdOn Datetime Time stamp when the content was created

modifiedOn Datetime Time stamp when the content was last modified

AdditionalInfo String Additional information about the content

TotalResults Numeric Total results shown per page

Chapter 5: Content Management

262

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Move Files to Target Folder

Functionality – Moves given file to destination folder given in the request.

HTTP Method – PATCH

API URI – https://host/api/mcm/contents/files/{id}

URI Parameters

Tag Type Description

id String Unique identifier of the file

Request Payload

XML

<Id>Numeric</Id>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

Chapter 5: Content Management

263

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"contentId":"String"

}

Request Tag Details

Tag Mandatory Description

contentId Yes Unique identifier for the content

Response Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

Chapter 5: Content Management

264

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</ContentItemModel>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"contentId":"String",

"parentId":"String",

"name":"String",

"mimeType:"String",

"sharingRole":"String",

"owner":"String",

"isFavorite":Boolean,

"isTrashed":Boolean,

"isShared":Boolean,

"downloadMethod":"String",

"downloadWhileRoaming":Boolean,

"forceEncryption":Boolean,

"currentVersionNumber":"String",

"description":"String",

"notes":"String",

"subject":"String",

"downloadLink":"String",

"size":Numeric,

"createdOn":"Datetime

"modifiedOn":"Datetime

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the content

parentId String Unique identifier of the parent organization group

name String Name of the content

mimeType String Type of the MIME to filter contents

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

owner String Owner of the content

isFavorite Boolean Is the content favorite. True or False

isTrashed Boolean Is the content trashed. True or False

Chapter 5: Content Management

265

VMware AirWatch REST API Guide | v.2016.04 | April 2017

isShared Boolean Is the content shared. True or False

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

currentVersionNumber String The current version of the content

description String Description about the content

notes String Additional notes regarding the content

subject String Subject of the content

downloadLink String Link to download the content

size Numeric Size of the content

createdOn Datetime Time stamp when the content was created

modifiedOn Datetime Time stamp when the content was last modified

Chapter 5: Content Management

266

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete a File

Functionality – Deletes a file.

HTTP Method – DELETE

API URI – https://host/api/mcm/contents/files/{id}

URI Parameters

Tag Type Description

id String Unique identifier of the file

Request Payload – NA

Response Payload

JSON

{}

Chapter 5: Content Management

267

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve File Metadata

Functionality – Retrieves the file metadata.

HTTP Method – GET

API URI – https://host/api/mcm/contents/files/{id}/info

Request Payload – NA

URI Parameters

Tag Type Description

id String Unique identifier of the file

Response Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

Chapter 5: Content Management

268

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String"

}],

"contentId":"String",

"parentId":"String",

"name":"String",

"mimeType:"String",

"sharingRole":"String",

"owner":"String",

"isFavorite":Boolean,

"isTrashed":Boolean,

"isShared":Boolean,

"downloadMethod":"String",

"downloadWhileRoaming":Boolean,

"forceEncryption":Boolean,

"currentVersionNumber":"String",

"description":"String",

"notes":"String",

"subject":"String",

"downloadLink":"String",

"size":Numeric,

"createdOn":"Datetime

"modifiedOn":"Datetime

"id":Numeric

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the content

parentId String Unique identifier of the parent organization group

name String Name of the content

mimeType String Type of the MIME to filter contents

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

owner String Owner of the content

isFavorite Boolean Is the content favorite. True or False

Chapter 5: Content Management

269

VMware AirWatch REST API Guide | v.2016.04 | April 2017

isTrashed Boolean Is the content trashed. True or False

isShared Boolean Is the content shared. True or False

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

currentVersionNumber String The current version of the content

description String Description about the content

notes String Additional notes regarding the content

subject String Subject of the content

downloadLink String Link to download the content

size Numeric Size of the content

createdOn Datetime Time stamp when the content was created

modifiedOn Datetime Time stamp when the content was last modified

Chapter 5: Content Management

270

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Share Content

Functionality – Create a shared link for a file.

HTTP Method – POST

API URI – https://host/api/mcm/contents/files/{id}/shares

URI Parameters

Tag Type Description

id String Unique identifier of the file

Request Payload – NA

Response Payload

XML

<Id>Numeric</Id>

<Link>String</Link>

<Password>String</Password>

<MaxDownloadCount>String</MaxDownloadCount>

<ExpiryDays>String</ExpiryDays>

<ViewOnly>String</ViewOnly>

<Token>String</Token>

<IsDeactivated>Boolean</IsDeactivated>

<IsDownloadsExpired>Boolean</IsDownloadsExpired>

<IsDaysExpired>Boolean</IsDaysExpired>

<CurrentDownloads>Numeric</CurrentDownloads>

</ContentShareModel>

JSON

{

"currentDownloads" : Numeric,

"expiryDays" : "String",

"isDaysExpired" : Boolean,

"isDeactivated" : Boolean,

"isDownloadExpired" : Boolean,

"link" : "String",

"maxDownloadCount" : "String",

"password" : "String",

"token" : "String",

"viewOnly" : "String"

Chapter 5: Content Management

271

VMware AirWatch REST API Guide | v.2016.04 | April 2017

}

Response Tag Details

Tag Type Description

currentDownloads Numeric Number of content downloads

expiryDays String Number of days set to expire the content

isDaysExpired Boolean Whether the content is expired. Values: True, False

isDeactivated Boolean Whether the content is deactivated. Values: True, False

isDownloadExpired Boolean Whether the downloaded content is expired. Values: True, False

link String Link to download the content

maxDownloadCount String Maximum number of content download counts

password String Password to open the content

token String Token of the content

viewOnly String Content only viewable

Chapter 5: Content Management

272

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Download File

Functionality – Downloads a file.

HTTP Method – GET

API URI – https://host/api/mcm/contents/files/{id}

URI Parameters

Tag Type Description

id String Unique identifier of blob

Request Body – NA

Response Obtained – NA

Chapter 5: Content Management

273

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Remove File Sharing

Functionality – Remove sharing on a file if you are the owner.

HTTP Method – DELETE

API URI – https://host/api/mcm/contents/files/{id}/shares

URI Parameters

Tag Type Description

id String Unique identifier of the file

Request Body – NA

Response Obtained – NA

Chapter 5: Content Management

274

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Get File Sharing Information

Functionality – Getting sharing information on a file if you are the owner.

HTTP Method – GET

API URI – https://host/api/mcm/contents/files/{id}/shares

Request Body – NA

URI Parameters

Tag Type Description

id String Unique identifier of the file

Response Payload

XML

<Id>Numeric</Id>

<Link>String</Link>

<Password>String</Password>

<MaxDownloadCount>String</MaxDownloadCount>

<ExpiryDays>String</ExpiryDays>

<ViewOnly>String</ViewOnly>

<Token>String</Token>

<IsDeactivated>Boolean</IsDeactivated>

<IsDownloadsExpired>Boolean</IsDownloadsExpired>

<IsDaysExpired>Boolean</IsDaysExpired>

<CurrentDownloads>Numeric</CurrentDownloads>

</ContentShareModel>

JSON

{

"currentDownloads" : Numeric,

"expiryDays" : "String",

"isDaysExpired" : Boolean,

"isDeactivated" : Boolean,

"isDownloadExpired" : Boolean,

"link" : "String",

"maxDownloadCount" : "String",

"password" : "String",

"token" : "String",

"viewOnly" : "String"

Chapter 5: Content Management

275

VMware AirWatch REST API Guide | v.2016.04 | April 2017

}

Response Tag Details

Tag Type Description

currentDownloads Numeric Number of current downloads

expiryDays String Number of days for file expiry

isDaysExpired Boolean True or False if the file is expired

isDeactivated Boolean True of False of the file is deactivated

isDownloadExpired Boolean True or false if the file download expired

link String Link to download the file

maxDownloadCount String Count of maximum number of downloads

password String Password to access file

token String File token

viewOnly String File can only be viewed

Chapter 5: Content Management

276

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update File Metadata Information

Functionality – Updates the file metadata information (name, description, notes and subject).

HTTP Method – PUT

API URI – https://host/api/mcm/contents/files/{id}/info

URI Parameters

Tag Type Description

id String Unique identifier of the file

Request Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

JSON

{

"name":"String",

Chapter 5: Content Management

277

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"description":"String",

"notes":"String",

"subject":"String",

}

Request Tag Details

Tag Mandatory Description

name No Name of the content

description No Description about the content

notes No Additional notes regarding the content

subject No Subject of the content

Response Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

Chapter 5: Content Management

278

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

Chapter 5: Content Management

279

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"contentId":"String",

"parentId":"String",

"name":"String",

"mimeType:"String",

"sharingRole":"String",

"owner":"String",

"isFavorite":Boolean,

"isTrashed":Boolean,

"isShared":Boolean,

"downloadMethod":"String",

"downloadWhileRoaming":Boolean,

"forceEncryption":Boolean,

"currentVersionNumber":"String",

"description":"String",

"notes":"String",

"subject":"String",

"downloadLink":"String",

"size":Numeric,

"createdOn":"Datetime

"modifiedOn":"Datetime

"id":Numeric

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the content

parentId String Unique identifier of the parent organization group

name String Name of the content

mimeType String Type of the MIME to filter contents

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

owner String Owner of the content

isFavorite Boolean Is the content favorite. True or False

isTrashed Boolean Is the content trashed. True or False

isShared Boolean Is the content shared. True or False

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

Chapter 5: Content Management

280

VMware AirWatch REST API Guide | v.2016.04 | April 2017

forceEncryption Boolean Whether to force encrypt the content. True or False

currentVersionNumber String The current version of the content

description String Description about the content

notes String Additional notes regarding the content

subject String Subject of the content

downloadLink String Link to download the content

size Numeric Size of the content

createdOn Datetime Time stamp when the content was created

modifiedOn Datetime Time stamp when the content was last modified

Chapter 5: Content Management

281

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Upload Content/Files

Functionality – Uploads small files to the database using simple upload method. This method is used when Rfs is not

configured and the file is relatively small.

Important Note

Use this approach to send file metadata along with file binary in the same request.

lSample request header – "Content-Type: multipart/form-data; boundary=CUSTOM_BOUNDARY".

lSample request body – "CUSTOM_BOUNDARY Content-Disposition: form-data; name="fileMetadata" Content-Type:

application/json {"Title":"Pic1.jpg", "Description":"First upload attempt"} CUSTOM_BOUNDARY Content-

Disposition: form-data; name="fileBinary"; filename="Pic1.jpg" Content-Type: image/jpeg Content-Length: 23548 ....

file binary here .... CUSTOM_BOUNDARY

HTTP Method – POST

API URI – https://host/api/mcm/contents/files/simpleupload

Request Payload

XML

JSON

{}

Request Sample

POST /contents/files HTTP/1.1

Host: String

Authorization: String

aw-tenant-code: String

aw-groupid: String

Content-Type: multipart/form-data; boundary=----

WebKitFormBoundary7MA4YWxkTrZu0gW

Accept: application/json

Cache-Control: no-cache

Postman-Token: String

Chapter 5: Content Management

282

VMware AirWatch REST API Guide | v.2016.04 | April 2017

----WebKitFormBoundary

Content-Disposition: form-data; name="fileMetadata"

Content-Type: application/json

{"Title":"Pic1.jpg", "Description":"First upload attempt"}

----WebKitFormBoundary

Content-Disposition: form-data; name="fileBinary"; filename="Pic1.jpg"

Content-Type: image/jpeg

Content-Length: Numeric

.... file binary here ....

----WebKitFormBoundary

Response Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

Chapter 5: Content Management

283

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</ContentItemModel>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"contentId":"String",

"parentId":"String",

"name":"String",

"mimeType:"String",

"sharingRole":"String",

"owner":"String",

"isFavorite":Boolean,

"isTrashed":Boolean,

"isShared":Boolean,

"downloadMethod":"String",

"downloadWhileRoaming":Boolean,

"forceEncryption":Boolean,

"currentVersionNumber":"String",

"description":"String",

"notes":"String",

"subject":"String",

"downloadLink":"String",

"size":Numeric,

"createdOn":"Datetime

"modifiedOn":"Datetime

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the content

parentId String Unique identifier of the parent organization group

name String Name of the content

mimeType String Type of the MIME to filter contents

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

owner String Owner of the content

isFavorite Boolean Is the content favorite. True or False

isTrashed Boolean Is the content trashed. True or False

Chapter 5: Content Management

284

VMware AirWatch REST API Guide | v.2016.04 | April 2017

isShared Boolean Is the content shared. True or False

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

currentVersionNumber String The current version of the content

description String Description about the content

notes String Additional notes regarding the content

subject String Subject of the content

downloadLink String Link to download the content

size Numeric Size of the content

createdOn Datetime Time stamp when the content was created

modifiedOn Datetime Time stamp when the content was last modified

Chapter 5: Content Management

285

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Explicit Upload Initialize

Functionality – Explicit upload is the approach that you can use to upload big files to Rfs. Also you have to update the

metadata of the file in a separate request.

Explicit upload is carried out in three steps:

1. Initalize step – Initialize the upload operation by sending file name, size, folder id (optional), server responds with

upload url and finalize url.

2. Upload step – Upload the file using upload url that you have got from the server. You will get the file hash in this

step.

3. Finalize step – Expose the Finalize url after substituting hash place holder '$hash$' with the actual hash that you

have got from step# 2. This is the Initialize step endpoint, you will get Rfs Upload Url and Finalize Url from this step.

HTTP Method – POST

API URI – https://host/api/mcm/contents/files/explicitupload/initialize?name={name}&folderId=

{folderId}&contentLength={contentLength}

Request Payload – NA

URI Parameters

Tag Type Description

name String File name along with the Extension

folderId Numeric Numeric identifier of the folder to which you want to upload the file.

Root folder is the default

contentLength Long File size in bytes

Response Palyload

XML

<UploadUrlsModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<UploadUrl>String</UploadUrl>

<FinalizeUrl>String</FinalizeUrl>

</UploadUrlsModel>

Chapter 5: Content Management

286

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"UploadUrl":"String",

"FinalizeUrl":"String"

}

Response Tag Details

Tag Type Description

UploadUrl String URL to upload the file

FinalizeUrl String URL to finalize the procedure and to expose the file

Chapter 5: Content Management

287

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Explicit Upload Finalize

Functionality – Explicit upload is the approach that you can use to upload big files to Rfs. Also you have to update the

metadata of the file in a separate request.

Explicit upload is carried out in three steps:

1. Initalize step – Initialize the upload operation by sending file name, size, folder id (optional), server responds with

upload url and finalize url.

2. Upload step – Upload the file using upload url that you have got from the server. You will get the file hash in this

step.

3. Finalize step – Expose the Finalize url after substituting hash place holder '$hash$' with the actual hash that you

have got from step# 2. This is the Finalize step endpoint, when you expose it successfully, you should see the file in

the personal content repository.

HTTP Method – POST

API URI – https://host/api/mcm/contents/files/explicitupload/finalize?name={name}&folderId=

{folderId}&contentLength={contentLength}&externalFileID={externalFileID}&externalFileHash={externalFileHash}

Request Payload – NA

URI Parameters

Tag Type Description

name String File name along with the Extension

folderId Numeric Numeric identifier of the folder to which you want to upload the file.

Root folder is the default

contentLength Long File size in bytes

externalFileID String External file id for the file you've uploaded it to Rfs

externalFileHash String External file hash for the file you've uploaded it to Rfs

Response Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

Chapter 5: Content Management

288

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"contentId":"String",

"parentId":"String",

"name":"String",

"mimeType:"String",

"sharingRole":"String",

"owner":"String",

"isFavorite":Boolean,

"isTrashed":Boolean,

"isShared":Boolean,

"downloadMethod":"String",

"downloadWhileRoaming":Boolean,

"forceEncryption":Boolean,

"currentVersionNumber":"String",

"description":"String",

"notes":"String",

Chapter 5: Content Management

289

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"subject":"String",

"downloadLink":"String",

"size":Numeric,

"createdOn":"Datetime

"modifiedOn":"Datetime

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the content

parentId String Unique identifier of the parent organization group

name String Name of the content

mimeType String Type of the MIME to filter contents

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

owner String Owner of the content

isFavorite Boolean Is the content favorite. True or False

isTrashed Boolean Is the content trashed. True or False

isShared Boolean Is the content shared. True or False

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

currentVersionNumber String The current version of the content

description String Description about the content

notes String Additional notes regarding the content

subject String Subject of the content

downloadLink String Link to download the content

size Numeric Size of the content

createdOn Datetime Time stamp when the content was created

modifiedOn Datetime Time stamp when the content was last modified

Chapter 5: Content Management

290

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Folder Information

Functionality – Retrieves the folder information.

HTTP Method – GET

API URI – https://host/api/mcm/contents/folders/{id}/info

Request Payload – NA

URI Parameters

Tag Type Description

id String Unique Identifier for the Folder being queried

Response Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

Chapter 5: Content Management

291

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"contentId":"String",

"parentId":"String",

"name":"String",

"mimeType:"String",

"sharingRole":"String",

"owner":"String",

"isFavorite":Boolean,

"isTrashed":Boolean,

"isShared":Boolean,

"downloadMethod":"String",

"downloadWhileRoaming":Boolean,

"forceEncryption":Boolean,

"currentVersionNumber":"String",

"description":"String",

"notes":"String",

"subject":"String",

"downloadLink":"String",

"size":Numeric,

"createdOn":"Datetime

"modifiedOn":"Datetime

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the folder

parentId String Unique identifier of the parent organization group

name String Name of the folder

mimeType String Type of the MIME to filter folder

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

owner String Owner of the folder

isFavorite Boolean Is the folder favorite. True or False

Chapter 5: Content Management

292

VMware AirWatch REST API Guide | v.2016.04 | April 2017

isTrashed Boolean Is the folder trashed. True or False

isShared Boolean Is the folder shared. True or False

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

currentVersionNumber String The current version of the content

description String Description about the content

notes String Additional notes regarding the content

subject String Subject of the content

downloadLink String Link to download the content

size Numeric Size of the folder

createdOn Datetime Time stamp when the content was created

modifiedOn Datetime Time stamp when the content was last modified

Chapter 5: Content Management

293

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Create Folder

Functionality – Creates a folder.

HTTP Method – POST

API URI – https://host/api/mcm/contents/folders

Request Payload

XML

<Folder xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

<Name>String</Name>

<ParentFolderIdGuid>String</ParentFolderIdGuid>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<AllowEncryption>Boolean</AllowEncryption>

<DownloadMethod>String</DownloadMethod>

</Folder>

JSON

{

"name":"String",

"parentFolderId":"String",

"downloadWhileRoaming":Boolean,

"allowEncryption":Boolean,

"downloadMethod":"String"

}

Request Tag Details

Tag Mandatory Description

name Yes Name of the folder

parentFolderId Yes Unique identifier of the parent folder

downloadWhileRoaming Yes Whether to download content while roaming. True or False

allowEncryption Yes Whether to allow encryption of the folder and its contents

downloadMethod Yes Method used to download the content

Chapter 5: Content Management

294

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"contentId":"String",

"parentId":"String",

"name":"String",

"mimeType:"String",

Chapter 5: Content Management

295

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"sharingRole":"String",

"owner":"String",

"isFavorite":Boolean,

"isTrashed":Boolean,

"isShared":Boolean,

"downloadMethod":"String",

"downloadWhileRoaming":Boolean,

"forceEncryption":Boolean,

"currentVersionNumber":"String",

"description":"String",

"notes":"String",

"subject":"String",

"downloadLink":"String",

"size":Numeric,

"createdOn":"Datetime

"modifiedOn":"Datetime

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the folder

parentId String Unique identifier of the parent organization group

name String Name of the folder

mimeType String Type of the MIME to filter folder

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

owner String Owner of the folder

isFavorite Boolean Is the folder favorite. True or False

isTrashed Boolean Is the folder trashed. True or False

isShared Boolean Is the folder shared. True or False

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

currentVersionNumber String The current version of the content

description String Description about the content

notes String Additional notes regarding the content

subject String Subject of the content

downloadLink String Link to download the content

size Numeric Size of the folder

Chapter 5: Content Management

296

VMware AirWatch REST API Guide | v.2016.04 | April 2017

createdOn Datetime Time stamp when the content was created

modifiedOn Datetime Time stamp when the content was last modified

Chapter 5: Content Management

297

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Folder

Functionality – Updates the folder metadata.

HTTP Method – PUT

API URI – https://host/api/mcm/contents/folders/{id}/info

URI Parameters

Tag Type Description

id String Unique identifier of the folder

Request Payload

XML

<Folder xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

<Name>String</Name>

<ParentFolderIdGuid>String</ParentFolderIdGuid>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<AllowEncryption>Boolean</AllowEncryption>

<DownloadMethod>String</DownloadMethod>

</Folder>

JSON

{

"name":"String",

"parentFolderId":"String",

"downloadWhileRoaming":Boolean,

"allowEncryption":Boolean,

"downloadMethod":"String"

}

Request Tag Details

Tag Mandatory Description

name Yes Name of the folder

parentFolderId Yes Unique identifier of the parent folder

Chapter 5: Content Management

298

VMware AirWatch REST API Guide | v.2016.04 | April 2017

downloadWhileRoaming Yes Whether to download content while roaming. True or False

allowEncryption Yes Whether to allow encryption of the folder and its contents

downloadMethod Yes Method used to download the content

Response Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

Chapter 5: Content Management

299

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"contentId":"String",

"parentId":"String",

"name":"String",

"mimeType:"String",

"sharingRole":"String",

"owner":"String",

"isFavorite":Boolean,

"isTrashed":Boolean,

"isShared":Boolean,

"downloadMethod":"String",

"downloadWhileRoaming":Boolean,

"forceEncryption":Boolean,

"currentVersionNumber":"String",

"description":"String",

"notes":"String",

"subject":"String",

"downloadLink":"String",

"size":Numeric,

"createdOn":"Datetime

"modifiedOn":"Datetime

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the folder

parentId String Unique identifier of the parent organization group

name String Name of the folder

mimeType String Type of the MIME to filter folder

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

owner String Owner of the folder

isFavorite Boolean Is the folder favorite. True or False

isTrashed Boolean Is the folder trashed. True or False

isShared Boolean Is the folder shared. True or False

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

currentVersionNumber String The current version of the content

description String Description about the content

notes String Additional notes regarding the content

Chapter 5: Content Management

300

VMware AirWatch REST API Guide | v.2016.04 | April 2017

subject String Subject of the content

downloadLink String Link to download the content

size Numeric Size of the folder

createdOn Datetime Time stamp when the content was created

modifiedOn Datetime Time stamp when the content was last modified

Chapter 5: Content Management

301

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Move Folder

Functionality – Moves a folder to the destination folder given in the request.

HTTP Method – PATCH

API URI – https://host/api/mcm/contents/folders/{id}

URI Parameters

Tag Type Description

id String Unique identifier of the folder

Request Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

Chapter 5: Content Management

302

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"contentId":"String",

}

Request Tag Details

Tag Mandatory Description

contentId Yes Unique identifier for the folder

Response Payload

XML

<ContentItemModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

Chapter 5: Content Management

303

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</ContentItemModel>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"contentId":"String",

"parentId":"String",

"name":"String",

"mimeType:"String",

"sharingRole":"String",

"owner":"String",

"isFavorite":Boolean,

"isTrashed":Boolean,

"isShared":Boolean,

"downloadMethod":"String",

"downloadWhileRoaming":Boolean,

"forceEncryption":Boolean,

"currentVersionNumber":"String",

"description":"String",

"notes":"String",

"subject":"String",

"downloadLink":"String",

"size":Numeric,

"createdOn":"Datetime

"modifiedOn":"Datetime

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the folder

parentId String Unique identifier of the parent organization group

name String Name of the folder

mimeType String Type of the MIME to filter folder

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

owner String Owner of the folder

isFavorite Boolean Is the folder favorite. True or False

isTrashed Boolean Is the folder trashed. True or False

Chapter 5: Content Management

304

VMware AirWatch REST API Guide | v.2016.04 | April 2017

isShared Boolean Is the folder shared. True or False

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

currentVersionNumber String The current version of the content

description String Description about the content

notes String Additional notes regarding the content

subject String Subject of the content

downloadLink String Link to download the content

size Numeric Size of the folder

createdOn Datetime Time stamp when the content was created

modifiedOn Datetime Time stamp when the content was last modified

Chapter 5: Content Management

305

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Folder

Functionality – Deletes a folder.

HTTP Method – DELETE

API URI – https://host/api/mcm/contents/folders/{id}

URI Parameters

Tag Type Description

id String Unique identifier of the folder

Request Body – NA

Response Obtained – NA

Chapter 5: Content Management

306

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Return Sharing Metadata

Functionality – Returns sharing metadata for the folder.

HTTP Method – GET

API URI – https://host/api/mcm/contents/folders/{id}/shares

URI Parameters

Tag Type Description

id String Unique identifier of the folder

Response Payload

XML

<FolderShare xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

<Links>

<Link>

<Rel>String</Rel>

<Href>String</Href>

<Title>String</Title>

</Link>

</Links>

<FolderId>String</FolderId>

<OwnerUserId>Numeric</OwnerUserId>

<OwnerName>String</OwnerName>

<ID>Numeric</ID>

<Name>String</Name>

<Email>String</Email>

<Type>String</Type>

<Role>String</Role>

<ActknowledgedAt>Dateime</ActknowledgedAt>

</CollaboratorModel>

</Collaborators>

</FolderShare>

Chapter 5: Content Management

307

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"folderId":"String",

"ownerUserId":Numeric,

"ownerName":"String",

"collaborators":[

{

"id":Numeric,

"name":"String",

"email":"String",

"type":"String",

"role":"String",

"actknowledgedAt":"Datetime

}

Response Tag Details

Tag Type Description

folderId String Unique identifier of the folder

ownerUserId Numeric Unique identifier of the owner who is sharing the folder

ownerName String Name of the owner who is sharing the folder

collaborator id Numeric Unique identifier of the collaborator

collaborator name String Name of the collaborator

collaborator email String Email address of the collaborator

collaborator type String Type of the collaborator

collaborator role String Role of the collaborator (Co-Owner, Reader, or Editor)

actknowledgedAt Datetime Time stamp when the folder was shared

Chapter 5: Content Management

308

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Collaborator List

Functionality – Retrieves the prospective collaborators list for the given folder.

HTTP Method – GET

API URI – https://host/api/mcm/contents/folders/{id}/collaborators?searchText={searchText}&type=

{type}&startIndex={startIndex}&pageSize={pageSize}

URI Parameters

Tag Type Description

id String Unique identifier of the folder

Response Payload

XML

<Id>Numeric</Id>

<Links>

<Link>

<Rel>String</Rel>

<Href>String</Href>

<Title>String</Title>

</Link>

</Links>

</AdditionalInfo>

<TotalResults>Numeric</TotalResults>

<ID>Numeric</ID>

<Name>String</Name>

<Email>String</Email>

<Type>String</Type>

<Role>String</Role>

<ActknowledgedAt>Datetime</ActknowledgedAt>

</CollaboratorModel>

</ResultSet>

</ProspectiveCollaborator>

Chapter 5: Content Management

309

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"AdditionalInfo": {

"Links":[{

"Href":"String",

"Rel":"String",

}],

"collaborators":[

{

"id":Numeric,

"name":"String",

"email":"String",

"type":"String",

"role":"String",

"actknowledgedAt":"Datetime

}

"TotalResults":Numeric

}

Response Tag Details

Tag Type Description

id Numeric Unique identifier of the collaborator

email String Email address of the collaborator

type String Type of the collaborator

role String Role of the collaborator (Co-Owner, Reader, or Editor)

actknowledgedAt Datetime Time stamp when the folder was shared

TotalResults Numeric Total results returned per page

Chapter 5: Content Management

310

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Remove Sharing

Functionality – Removes sharing on folder if you are the owner. Otherwise, leave the folder.

HTTP Method – DELETE

API URI – https://host/api/mcm/contents/folders/{id}/shares

URI Parameters

Tag Type Description

id String Unique identifier of the folder

Request Payload – NA

Response Payload

JSON

{}

Chapter 5: Content Management

311

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Share Folder with Users or UserGroups

Functionality – Shares a folder with users or usergroups. The API expects User Id or User Group Id, Role and Type to

share accordingly.

Important: If no userid present and emailid is mentioned then the user is considered to be external userid. This end

point accepts the collaborators list and shares the folder to them assuming that the folder is not shared to anyone

else yet.

HTTP Method – POST

API URI – https://host/api/mcm/contents/folders/{id}/shares

URI Parameters

Tag Type Description

id String Unique identifier of the folder

Request Payload

XML

<Id>Numeric</Id>

<Links>

<Link>

<Rel>String</Rel>

<Href>String</Href>

<Title>String</Title>

</Link>

</Links>

<FolderId>String</FolderId>

<OwnerUserId>Numeric</OwnerUserId>

<OwnerName>String</OwnerName>

<ID>Numeric</ID>

<Name>String</Name>

<Email>String</Email>

<Type>String</Type>

<Role>String</Role>

<ActknowledgedAt>Dateime</ActknowledgedAt>

</CollaboratorModel>

</Collaborators>

</FolderShare>

Chapter 5: Content Management

312

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"collaborators":[

{

"id":Numeric,

"email":"String",

"type":"String",

"role":"String",

}

]

}

Request Tag Details

Tag Mandatory Description

folderId Yes Unique identifier of the folder

ownerUserId Yes Unique identifier of the owner who is sharing the folder

ownerName Yes Name of the owner who is sharing the folder

collaborator id Yes Unique identifier of the collaborator

collaborator name Yes Name of the collaborator

collaborator email Yes Email address of the collaborator

collaborator type No Type of the collaborator

collaborator role Yes Role of the collaborator (Co-Owner, Reader, or Editor)

actknowledgedAt No Time stamp when the folder was shared

Response Payload

XML

<Id>Numeric</Id>

<Links>

<Link>

<Rel>String</Rel>

<Href>String</Href>

<Title>String</Title>

</Link>

</Links>

<FolderId>String</FolderId>

<OwnerUserId>Numeric</OwnerUserId>

Chapter 5: Content Management

313

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<OwnerName>String</OwnerName>

<ID>Numeric</ID>

<Name>String</Name>

<Email>String</Email>

<Type>String</Type>

<Role>String</Role>

<ActknowledgedAt>Dateime</ActknowledgedAt>

</CollaboratorModel>

</Collaborators>

</FolderShare>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"folderId":"String",

"ownerUserId":Numeric,

"ownerName":"String",

"collaborators":[

{

"id":Numeric,

"name":"String",

"email":"String",

"type":"String",

"role":"String",

"actknowledgedAt":"Datetime

}

Response Tag Details

Tag Type Description

folderId String Unique identifier of the folder

ownerUserId Numeric Unique identifier of the owner who is sharing the folder

ownerName String Name of the owner who is sharing the folder

collaborator id Numeric Unique identifier of the collaborator

collaborator name String Name of the collaborator

collaborator email String Email address of the collaborator

Chapter 5: Content Management

314

VMware AirWatch REST API Guide | v.2016.04 | April 2017

collaborator type String Type of the collaborator

collaborator role String Role of the collaborator (Co-Owner, Reader, or Editor)

actknowledgedAt Datetime Time stamp when the folder was shared

Chapter 5: Content Management

315

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Collaborator

Functionality – Updates a Collaborator. You can only update Role of the Collaborator. The API expects User Id or User

Group Id, Role and Type to share accordingly.

Important: If no userid present and emailid is mentioned then the user is considered to be external userid.

HTTP Method – PUT

API URI – https://host/api/mcm/contents/folders/{id}/shares/collaborators

URI Parameters

Tag Type Description

id String Unique identifier of the folder

Request Payload

XML

<FolderShare xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

<Links>

<Link>

<Rel>String</Rel>

<Href>String</Href>

<Title>String</Title>

</Link>

</Links>

<FolderId>String</FolderId>

<OwnerUserId>Numeric</OwnerUserId>

<OwnerName>String</OwnerName>

<ID>Numeric</ID>

<Name>String</Name>

<Email>String</Email>

<Type>String</Type>

<Role>String</Role>

<ActknowledgedAt>Dateime</ActknowledgedAt>

</CollaboratorModel>

</Collaborators>

</FolderShare>

Chapter 5: Content Management

316

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"id":Numeric,

"type":"String",

"role":"String",

}

]

}

Request Tag Details

Tag Mandatory Description

folderId Yes Unique identifier of the folder

ownerUserId Yes Unique identifier of the owner who is sharing the folder

ownerName Yes Name of the owner who is sharing the folder

collaborator id Yes Unique identifier of the collaborator

collaborator name Yes Name of the collaborator

collaborator email Yes Email address of the collaborator

collaborator type No Type of the collaborator

collaborator role Yes Role of the collaborator (Co-Owner, Reader, or Editor)

actknowledgedAt No Time stamp when the folder was shared

Response Payload

XML

<FolderShare xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

<Links>

<Link>

<Rel>String</Rel>

<Href>String</Href>

<Title>String</Title>

</Link>

</Links>

<FolderId>String</FolderId>

<OwnerUserId>Numeric</OwnerUserId>

Chapter 5: Content Management

317

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<OwnerName>String</OwnerName>

<ID>Numeric</ID>

<Name>String</Name>

<Email>String</Email>

<Type>String</Type>

<Role>String</Role>

<ActknowledgedAt>Dateime</ActknowledgedAt>

</CollaboratorModel>

</Collaborators>

</FolderShare>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"folderId":"String",

"ownerUserId":Numeric,

"ownerName":"String",

"collaborators":[

{

"id":Numeric,

"name":"String",

"email":"String",

"type":"String",

"role":"String",

"actknowledgedAt":"Datetime

}

Response Tag Details

Tag Type Description

folderId String Unique identifier of the folder

ownerUserId Numeric Unique identifier of the owner who is sharing the folder

ownerName String Name of the owner who is sharing the folder

collaborator id Numeric Unique identifier of the collaborator

collaborator name String Name of the collaborator

collaborator email String Email address of the collaborator

Chapter 5: Content Management

318

VMware AirWatch REST API Guide | v.2016.04 | April 2017

collaborator type String Type of the collaborator

collaborator role String Role of the collaborator (Co-Owner, Reader, or Editor)

actknowledgedAt Datetime Time stamp when the folder was shared

Chapter 5: Content Management

319

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Remove Sharing on Collaborator Folder

Functionality – Remove one or more collaborators from a shared folder.

HTTP Method – DELETE

API URI – https://host/api/mcm/contents/folders/{id}/shares/collaborators

URI Parameters

Tag Type Description

id String Unique identifier of the folder

Request Payload

XML

<ArrayOfDeletedCollaboratorModel

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<ID xmlns="http://www.air-watch.com/webapi/resources">Numeric</ID>

<Type xmlns="http://www.air-watch.com/webapi/resources">String</Type>

</DeletedCollaboratorModel>

<ID xmlns="http://www.air-watch.com/webapi/resources">Numeric</ID>

<Type xmlns="http://www.air-watch.com/webapi/resources">String</Type>

</DeletedCollaboratorModel>

</ArrayOfDeletedCollaboratorModel>

JSON

[

{

"id":Numeric,

"type":"String"

{

"id":Numeric,

"type":"String"

}

]

Chapter 5: Content Management

320

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

id Yes Unique identifier of the folder

type Yes Type of the folder

Response Payload

JSON

{}

Chapter 5: Content Management

321

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Collaborator of Shared Folder

Functionality – Update collaborators of shared folder. This end point will add or update or delete the collaborators.

HTTP Method – PUT

API URI – https://host/api/mcm/contents/folders/{id}/shares

Response Obtained – NA

URI Parameters

Tag Type Description

id String Unique identifier of the folder

Request Payload

XML

<FolderShare xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

<Links>

<Link>

<Rel>String</Rel>

<Href>String</Href>

<Title>String</Title>

</Link>

</Links>

<FolderId>String</FolderId>

<OwnerUserId>Numeric</OwnerUserId>

<OwnerName>String</OwnerName>

<ID>Numeric</ID>

<Name>String</Name>

<Email>String</Email>

<Type>String</Type>

<Role>String</Role>

<ActknowledgedAt>Dateime</ActknowledgedAt>

</CollaboratorModel>

</Collaborators>

</FolderShare>

Chapter 5: Content Management

322

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"id":Numeric,

"email":"String",

"type":"String",

"role":"String"

}

]

}

Request Tag Details

Tag Mandatory Description

folderId Yes Unique identifier of the folder

ownerUserId Yes Unique identifier of the owner who is sharing the folder

ownerName Yes Name of the owner who is sharing the folder

collaborator id Yes Unique identifier of the collaborator

collaborator name Yes Name of the collaborator

collaborator email Yes Email address of the collaborator

collaborator type No Type of the collaborator

collaborator role Yes Role of the collaborator (Co-Owner, Reader, or Editor)

actknowledgedAt No Time stamp when the folder was shared

Response Payload

XML

<FolderShare xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

<Links>

<Link>

<Rel>String</Rel>

<Href>String</Href>

<Title>String</Title>

</Link>

</Links>

<FolderId>String</FolderId>

<OwnerUserId>Numeric</OwnerUserId>

Chapter 5: Content Management

323

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<OwnerName>String</OwnerName>

<ID>Numeric</ID>

<Name>String</Name>

<Email>String</Email>

<Type>String</Type>

<Role>String</Role>

<ActknowledgedAt>Dateime</ActknowledgedAt>

</CollaboratorModel>

</Collaborators>

</FolderShare>

JSON

{

"Links":[{

"Href":"String",

"Rel":"String",

}],

"folderId":"String",

"ownerUserId":Numeric,

"ownerName":"String",

"collaborators":[

{

"id":Numeric,

"name":"String",

"email":"String",

"type":"String",

"role":"String",

"actknowledgedAt":"Datetime

}

Response Tag Details

Tag Type Description

folderId String Unique identifier of the folder

ownerUserId Numeric Unique identifier of the owner who is sharing the folder

ownerName String Name of the owner who is sharing the folder

collaborator id Numeric Unique identifier of the collaborator

collaborator name String Name of the collaborator

collaborator email String Email address of the collaborator

Chapter 5: Content Management

324

VMware AirWatch REST API Guide | v.2016.04 | April 2017

collaborator type String Type of the collaborator

collaborator role String Role of the collaborator (Co-Owner, Reader, or Editor)

actknowledgedAt Datetime Time stamp when the folder was shared

Chapter 5: Content Management

325

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Admin Storage Information

Functionality – Returns admin storage information of the organization group.

HTTP Method – GET

API URI – https://host/api/mcm/storage

Request Payload – NA

Response Payload

XML

<AdminStorageModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<StorageCapacity>Numeric</StorageCapacity>

<StorageUsage> Numeric</StorageUsage>

<StorageUsagePercentage> Numeric</StorageUsagePercentage>

<MaxFileSizeAllowed> Numeric</MaxFileSizeAllowed>

<StorageOverage> Numeric</StorageOverage>

<FileEncryption>Boolean</FileEncryption>

</AdminStorageModel>

JSON

{

"storageCapacity" : Numeric,

"usedStorage" : Numeric,

"usedStoragePercentage" : Numeric,

"maxFileSizeAllowed" : Numeric,

"overageAllowed" : Numeric,

"fileEncryption" : Boolean,

}

Response Tag Details

Tag Type Description

storageCapacity Numeric Storage capacity of the organization group

usedStorage Numeric Volume of the storage capacity utilized

usedStoragePercentage Numeric Volume of the storage capacity utilized in percentage

maxFileSizeAllowed Numeric Allowed maximum file size

overageAllowed Numeric Allowed overage

fileEncryption Boolean Is file encryption allowed. True or False

Chapter 5: Content Management

326

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Managed Content Overview

With Admin as account type, you can access all the managed content APIs. To do this, navigate to Groups &Settings >

All Settings > System > Advanced > API > RESTAPI, and select Add, to generate API key for the service and account

type as Admin.

Using managed content APIs, you can perform various operations such as to upload, download, update, delete, and

retrieve files that are AirWatch managed. The list of available AirWatch managed content APIs are:

lRetrieve all categories

lCreate new category

lDelete category

lUpdate category

lUpload AirWatch Managed Content

lDownload AirWatch Managed Content

lDelete AirWatch Managed Content

lRetrieve AirWatch Managed Content

lUpdate AirWatch Managed Content

lRetrieve List of AirWatch Managed Content

Chapter 5: Content Management

327

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve All Categories

Functionality – Retrieve all categories available for the organization group.

HTTP Method – GET

API URI – https://host/api/mcm/categories?locationgroupcode={locationgroupcode}&locationgroupid=

{locationgroupid}

Request Payload – NA

URI Parameters

Tag Type Description

locationgroupcode String Location group code

locationgroupid Numeric Location group id

Response Payload

XML

<ArrayOfCategoryModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<CategoryId xmlns="http://www.air-

watch.com/webapi/resources">String</CategoryId>

<Name xmlns="http://www.air-watch.com/webapi/resources">String</Name>

<ParentId xmlns="http://www.air-

watch.com/webapi/resources">String</ParentId>

<HasSubCategories xmlns="http://www.air-

watch.com/webapi/resources">Boolean</HasSubCategories>

<LocationGroupId xmlns="http://www.air-

watch.com/webapi/resources">Numeric</LocationGroupId>

<Description xmlns="http://www.air-

watch.com/webapi/resources">String</Description>

</CategoryModel>

</ArrayOfCategoryModel>

JSON

[

{

"categoryId" : "String",

"parentId" : "String",

"name" : "String",

Chapter 5: Content Management

328

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"description" : "String",

"hasSubCategories" : Boolean,

"locationGroupId" : Numeric

}

]

Response Tag Details

Tag Type Description

categoryId String Unique identification number of the category

parentId String Unique identifier of the parent organization group

name String Name of the category

description String Description for the category

hasSubCategories Boolean Does the category has sub categories. True or False

locationGroupId Numeric Unique identifier of the organization group

Chapter 5: Content Management

329

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Create New Category

Functionality – Create new category under the specified organization group.

HTTP Method – POST

API URI – https://host/api/mcm/categories

Request Payload

XML

<Name>String</Name>

<ParentId>String</ParentId>

<LocationGroupId>Numeric</LocationGroupId>

<Description>String</Description>

</CategoryModel>

JSON

{

"parentId" : "String",

"name" : "String",

"description" : "String",

"locationGroupId" : Numeric

}

Request Tag Details

Tag Mandatory Description

categoryId Yes Unique identification number of the category

parentId Yes Unique identifier of the parent organization group

name Yes Name of the category

description No Description for the category

locationGroupId Yes Unique identifier of the organization group

Chapter 5: Content Management

330

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Payload

XML

<CategoryModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<CategoryId>String</CategoryId>

<Name>String</Name>

<ParentId>String</ParentId>

<HasSubCategories>Boolean</HasSubCategories>

<LocationGroupId>Numeric</LocationGroupId>

<Description>String</Description>

</CategoryModel>

JSON

{

"categoryId" : "String",

"parentId" : "String",

"name" : "String",

"description" : "String",

"hasSubCategories" : Boolean,

"locationGroupId" : Numeric

}

Response Tag Details

Tag Type Description

categoryId String Unique identification number of the category

parentId String Unique identifier of the parent organization group

name String Name of the category

description String Description for the category

hasSubCategories Boolean Does the category has sub categories. True or False

locationGroupId Numeric Unique identifier of the organization group

Chapter 5: Content Management

331

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Category

Functionality – Deletes a category specified by the Id.

HTTP Method – DELETE

API URI – https://host/api/mcm/categories/{id}

URI Parameters

Tag Type Description

id String Unique id of the category

Request Payload – NA

Response Obtained – NA

Chapter 5: Content Management

332

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Category

Functionality – Updates the category metadata.

HTTP Method – PUT

API URI – https://host/api/mcm/categories/{id}

URI Parameters

Tag Type Description

id String Unique id of the category

Request Payload

XML

<Name>String</Name>

<Description>String</Description>

</CategoryModel>

JSON

{

"name" : "String",

"description" : "String"

}

Request Tag Details

Tag Mandatory Description

name Yes Name of the category

description No Description for the category

Response Payload

XML

<CategoryModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

Chapter 5: Content Management

333

VMware AirWatch REST API Guide | v.2016.04 | April 2017

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<CategoryId>String</CategoryId>

<Name>String</Name>

<ParentId>String</ParentId>

<HasSubCategories>Boolean</HasSubCategories>

<Description>String</Description>

</CategoryModel>

JSON

{

"categoryId" : "String",

"parentId" : "String",

"name" : "String",

"description" : "String",

"hasSubCategories" : Boolean,

"locationGroupId" : Numeric

}

Response Tag Details

Tag Type Description

categoryId String Unique identification number of the category

parentId String Unique identifier of the parent organization group

name String Name of the category

description String Description for the category

hasSubCategories Boolean Does the category has sub categories. Boolean or False

locationGroupId Numeric Unique identifier of the organization group

Chapter 5: Content Management

334

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Upload AirWatch Managed Content

Functionality – Uploads AirWatch managed content.

HTTP Method – POST

API URI – https://host/api/mcm/awcontents?fileName={fileName}&categoryId={categoryId}&effectiveDate=

{effectiveDate}&locationGroupId={locationGroupId}&locationGroupCode={locationGroupCode}

Request Payload – NA

URI Parameters

Tag Type Description

fileName String File name along with the extension

categoryId String Unique identifier of the category

effectiveDate String Effective date for the file being uploaded

locationGroupId String Location group id

locationGroupCode String Location group code

Response Payload

XML

<AwContentModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<ContentId>String</ContentId>

<CreatedOn>Datetime</CreatedOn>

<CreatedBy>String</CreatedBy>

<ModifiedBy>String</ModifiedBy>

<Name>String</Name>

<Description>String</Description>

<Importance>String</Importance>

<LocationGroupId>Numeric</LocationGroupId>

<CategoryId>String</CategoryId>

<Name>String</Name>

</SearchCategoryModel>

</Categories>

<MimeType>String</MimeType>

<IsActive>Boolean</IsActive>

<ContentVersionId>String</ContentVersionId>

Chapter 5: Content Management

335

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Version>String</Version>

<Notes>String</Notes>

<Size>Numeric</Size>

<Hash>String</Hash>

<Author>String</Author>

<Subject>String</Subject>

<Keywords>String</Keywords>

<DownloadLink>String</DownloadLink>

<HashAlgorithm>String</HashAlgorithm>

</ContentVersion>

<ViewOnlineOnly>Boolean</ViewOnlineOnly>

<ForceEncryption>Boolean</ForceEncryption>

<AllowEmail>Boolean</AllowEmail>

<IsExportable>Boolean</IsExportable>

<AllowRepoExport>Boolean</AllowRepoExport>

<EnableWatermark>Boolean</EnableWatermark>

<AllowPrint>Boolean</AllowPrint>

<AllowEdit>Boolean</AllowEdit>

</SecuritySettings>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<DownloadMethod>String</DownloadMethod>

<ForceDownload>Boolean</ForceDownload>

<DownloadPriority>String</DownloadPriority>

<IsRequiredContent>Boolean</IsRequiredContent>

<IsFeaturedContent>Boolean</IsFeaturedContent>

<EffectiveDate>Datetime</EffectiveDate>

<ExpirationDate>Datetime</ExpirationDate>

<DownloadDate>Datetime</DownloadDate>

</DeploymentSettings>

</AwContentModel>

JSON

{

"contentId" : "String",

"name" : "String",

"description" : "String",

"mimeType" : "String",

"isActive" : Boolean,

"importance" : "String",

"locationGroupId" : Numeric,

"createdOn" : "Datetime",

"createdBy" : "String",

"modifiedOn" : "Datetime",

"modifiedBy" : "String",

"Categories" : [

Chapter 5: Content Management

336

VMware AirWatch REST API Guide | v.2016.04 | April 2017

{

"categoryId" : "String",

"name" : "String"

{

"categoryId" : "String",

"name" : "String"

}

"ContentVersion" : {

"contentVersionId" : "String",

"version" : "String",

"notes" : "String",

"size" : Numeric,

"hash" : "String",

"author" : "String",

"subject" : "String",

"keywords" : "String",

"downloadLink" : "String",

"hashAlgorithm" : "String",

"SecuritySettings" : {

"allowViewOnline" : Boolean,

"forceEncryption" : Boolean,

"allowOpenInEmail" : Boolean,

"allowOpenInThirdPartyApps" : Boolean,

"allowSavingToOtherRepositories" : Boolean,

"enableWaterMark" : Boolean,

"allowPrint" : Boolean,

"allowEdit" : Boolean,

"DeploymentSettings" : {

"downloadWhileRoaming" : Boolean,

"downloadMethod" : "String",

"forceDownload" : Boolean,

"downloadPriority" : "String",

"isRequired" : Boolean,

"isFeaturedContent" : Boolean,

"effectiveDate" : "Datetime",

"expirationDate" : "Datetime",

"downloadDate" : "Datetime",

}

Response Tag Details

Tag Type Description

contentId Numeric Unique identification number of the content

name String Name of the content

description String Description for the content

Chapter 5: Content Management

337

VMware AirWatch REST API Guide | v.2016.04 | April 2017

mimeType String Type of the MIME to filter contents

isActive Boolean Is the content active. True of False

importance String Importance of the content

locationGroupId Numeric Unique identification number of the location group

createdOn Datetime Time stamp when the content was created

createdBy String Name of the author who created the content

modifiedOn Datetime Time stamp when the content was last modified

modifiedBy String Name of the author who modified the content

categoryId Numeric Unique identifier for the category

name String Name of the category

contentVersionId String Unique identifier of the content version

version String Version of the content

notes String Notes for the content

size Numeric Size of the content

hash String Computed hash for the content

author String Author of the content

subject String Subject of the content

keywords String Keywords to search the content

downloadLink String Link to download the content

hashalgorithm String Algorithm used to compute hash

allowViewOnline Boolean Whether to allow content to view online. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

allowOpenInEmail Boolean Whether to allow content to open in emails. True or False

allowOpenInThirdPartyApps Boolean Whether to allow content to open in third party applications. True

or False

allowSavingToOtherRepositories Boolean Whether to allow content to get saved in other repositories. True or

False

enableWaterMark Boolean Whether to enable water mark on the content. True or False

allowPrint Boolean Whether to allow to print the content. True or False

allowEdit Boolean Whether to allow editing the content. True or False

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

downloadMethod String Method used to download the content

forceDownload Boolean Whether to force download the content. True or False

Chapter 5: Content Management

338

VMware AirWatch REST API Guide | v.2016.04 | April 2017

downloadPriority String Priority set to the content. Values: High, Normal, and Low

isRequired Boolean Whether deployment settings are required or not. True or False

effectiveDate Datetime Datetime when the content will be effective

expirationDate Datetime Expiration date of the content

downloadDate Datetime Download date of the content

Chapter 5: Content Management

339

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Download AirWatch Managed Content

Functionality – Downloads AirWatch managed contents.

HTTP Method – GET

API URI – https://host/api/mcm/awcontents/{id}

URI Parameters

Tag Type Description

id String Unique identifier of the content

Request Payload – NA

Response Obtained – NA

Chapter 5: Content Management

340

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete AirWatch Managed Content

Functionality – Deletes AirWatch managed contents.

HTTP Method – DELETE

API URI – https://host/api/mcm/awcontents/{id}

URI Parameters

Tag Type Description

id String Unique identifier of the content

Request Payload – NA

Response Obtained – NA

Chapter 5: Content Management

341

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve AirWatch Managed Content

Functionality – Retrieves AirWatch managed content.

HTTP Method – GET

API URI – https://host/api/mcm/awcontents/{id}/info

Request Payload – NA

URI Parameters

Tag Type Description

id String Unique identifier of the content

Response Payload

XML

<AwContentModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

<ContentId>String</ContentId>

<CreatedOn>Datetime</CreatedOn>

<CreatedBy>String</CreatedBy>

<ModifiedBy>String</ModifiedBy>

<Name>String</Name>

<Description>String</Description>

<Importance>String</Importance>

<LocationGroupId>Numeric</LocationGroupId>

<CategoryId>String</CategoryId>

<Name>String</Name>

</SearchCategoryModel>

</Categories>

<MimeType>String</MimeType>

<IsActive>Boolean</IsActive>

<ContentVersionId>String</ContentVersionId>

<Version>String</Version>

<Notes>String</Notes>

<Size>Numeric</Size>

<Hash>String</Hash>

<Author>String</Author>

<Subject>String</Subject>

<Keywords>String</Keywords>

Chapter 5: Content Management

342

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<DownloadLink>String</DownloadLink>

<HashAlgorithm>String</HashAlgorithm>

</ContentVersion>

<ViewOnlineOnly>Boolean</ViewOnlineOnly>

<ForceEncryption>Boolean</ForceEncryption>

<AllowEmail>Boolean</AllowEmail>

<IsExportable>Boolean</IsExportable>

<AllowRepoExport>Boolean</AllowRepoExport>

<EnableWatermark>Boolean</EnableWatermark>

<AllowPrint>Boolean</AllowPrint>

<AllowEdit>Boolean</AllowEdit>

</SecuritySettings>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<DownloadMethod>String</DownloadMethod>

<ForceDownload>Boolean</ForceDownload>

<DownloadPriority>String</DownloadPriority>

<IsRequiredContent>Boolean</IsRequiredContent>

<IsFeaturedContent>Boolean</IsFeaturedContent>

<EffectiveDate>Datetime</EffectiveDate>

<ExpirationDate>Datetime</ExpirationDate>

<DownloadDate>Datetime</DownloadDate>

</DeploymentSettings>

</AwContentModel>

JSON

{

"contentId" : "String",

"name" : "String",

"description" : "String",

"mimeType" : "String",

"isActive" : Boolean,

"importance" : "String",

"locationGroupId" : Numeric,

"createdOn" : "Datetime",

"createdBy" : "String",

"modifiedOn" : "Datetime",

"modifiedBy" : "String",

"Categories" : [

{

"categoryId" : "String",

"name" : "String"

{

"categoryId" : "String",

"name" : "String"

Chapter 5: Content Management

343

VMware AirWatch REST API Guide | v.2016.04 | April 2017

}

"ContentVersion" : {

"contentVersionId" : "String",

"version" : "String",

"notes" : "String",

"size" : Numeric,

"hash" : "String",

"author" : "String",

"subject" : "String",

"keywords" : "String",

"downloadLink" : "String",

"hashAlgorithm" : "String",

"SecuritySettings" : {

"allowViewOnline" : Boolean,

"forceEncryption" : Boolean,

"allowOpenInEmail" : Boolean,

"allowOpenInThirdPartyApps" : Boolean,

"allowSavingToOtherRepositories" : Boolean,

"enableWaterMark" : Boolean,

"allowPrint" : Boolean,

"allowEdit" : Boolean,

"DeploymentSettings" : {

"downloadWhileRoaming" : Boolean,

"downloadMethod" : "String",

"forceDownload" : Boolean,

"downloadPriority" : "String",

"isRequired" : Boolean,

"isFeaturedContent" : Boolean,

"effectiveDate" : "Datetime",

"expirationDate" : "Datetime",

"downloadDate" : "Datetime",

}

Response Tag Details

Tag Type Description

contentId String Unique identification number of the content

name String Name of the content

description String Description for the content

mimeType String Type of the MIME to filter contents

isActive Boolean Is the content active. True of False

importance String Importance of the content

Chapter 5: Content Management

344

VMware AirWatch REST API Guide | v.2016.04 | April 2017

locationGroupId Numeric Unique identification number of the location group

createdOn Datetime Time stamp when the content was created

createdBy String Name of the author who created the content

modifiedOn Datetime Time stamp when the content was last modified

modifiedBy String Name of the author who modified the content

categoryId Numeric Unique identifier for the category

name String Name of the category

contentVersionId String Unique identifier of the content version

version String Version of the content

notes String Notes for the content

size Numeric Size of the content

hash String Computed hash for the content

author String Author of the content

subject String Subject of the content

keywords String Keywords to search the content

downloadLink String Link to download the content

hashAlgorithm String Algorithm used to compute hash

allowViewOnline Boolean Whether to allow the content to be viewed online. True or False

forceEncryption Boolean Whether to force to encrypt the content. True or False

allowOpenInEmail Boolean Whether to allow content to open in emails. True or False

allowOpenInThirdPartyApps Boolean Whether to allow content to open in third-party applications. True

or False

allowSavingToOtherRepositories Boolean Whether to allow content to get saved in other repositories. True or

False

enableWaterMark Boolean Whether to enable water mark on the content. True or False

allowPrint Boolean Whether to allow the content to be printed. True or False

allowEdit Boolean Whether to allow editing the content. True or False

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

downloadMethod String Method used to download the content

forceDownload Boolean Whether to force download the content. True or False

downloadPriority String Priority set to the content. Values: High, Normal, and Low

isRequired Boolean Whether deployment settings are required or not. True or False

effectiveDate Datetime Datetime when the content is effective

Chapter 5: Content Management

345

VMware AirWatch REST API Guide | v.2016.04 | April 2017

expirationDate Datetime Expiration date of the content

downloadDate Datetime Download date of the content

Chapter 5: Content Management

346

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update AirWatch Managed Content

Functionality – Updates AirWatch managed content.

HTTP Method – PUT

API URI – https://host/api/mcm/awcontents/{id}/info

Request Payload – NA

URI Parameters

Tag Type Description

id String Unique identifier of the content

Request Payload

XML

<AwContentModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Name>String</Name>

<Description>String</Description>

<Importance>String</Importance>

<CategoryId>String</CategoryId>

</SearchCategoryModel>

</Categories>

<IsActive>Boolean</IsActive>

<ViewOnlineOnly>Boolean</ViewOnlineOnly>

<ForceEncryption>Boolean</ForceEncryption>

<AllowEmail>Boolean</AllowEmail>

<IsExportable>Boolean</IsExportable>

<AllowRepoExport>Boolean</AllowRepoExport>

<EnableWatermark>Boolean</EnableWatermark>

<AllowPrint>Boolean</AllowPrint>

<AllowEdit>Boolean</AllowEdit>

</SecuritySettings>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<DownloadMethod>String</DownloadMethod>

<ForceDownload>Boolean</ForceDownload>

<DownloadPriority>String</DownloadPriority>

<IsRequiredContent>Boolean</IsRequiredContent>

<IsFeaturedContent>Boolean</IsFeaturedContent>

<EffectiveDate>Datetime</EffectiveDate>

Chapter 5: Content Management

347

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<ExpirationDate>Datetime</ExpirationDate>

<DownloadDate>Datetime</DownloadDate>

</DeploymentSettings>

</AwContentModel>

JSON

{

"name" : "String",

"description" : "String",

"isActive" : Boolean,

"importance" : "String",

"Categories" : [

{

"categoryId" : "String",

{

"categoryId" : "String",

}

"SecuritySettings" : {

"allowViewOnline" : Boolean,

"forceEncryption" : Boolean,

"allowOpenInEmail" : Boolean,

"allowOpenInThirdPartyApps" : Boolean,

"allowSavingToOtherRepositories" : Boolean,

"enableWaterMark" : Boolean,

"allowPrint" : Boolean,

"allowEdit" : Boolean,

"DeploymentSettings" : {

"downloadWhileRoaming" : Boolean,

"downloadMethod" : "String",

"forceDownload" : Boolean,

"downloadPriority" : "String",

"isRequired" : Boolean,

"isFeaturedContent" : Boolean,

"effectiveDate" : "Datetime",s

"expirationDate" : "Datetime",

"downloadDate" : "Datetime",

}

Request Tag Details

Tag Mandatory Description

name No Name of the content

Chapter 5: Content Management

348

VMware AirWatch REST API Guide | v.2016.04 | April 2017

description No Description for the content

isActive No Is the content active. True of False

importance No Importance of the content

categoryId Yes Unique identifier for the category

allowViewOnline No Whether to allow content to view online. True or False

forceEncryption No Whether to force encrypt the content. True or False

allowOpenInEmail No Whether to allow content to open in emails. True or False

allowOpenInThirdPartyApps No Whether to allow content to open in third party applications. True

or False

allowSavingToOtherRepositories No Whether to allow content to get saved in other repositories. True or

False

enableWaterMark No Whether to enable water mark on the content. True or False

allowPrint No Whether to allow to print the content. True or False

allowEdit No Whether to allow editing the content. True or False

downloadWhileRoaming No Whether to download content while roaming. True or False

downloadMethod No Method used to download the content

forceDownload No Whether to force download the content. True or False

downloadPriority No Priority set to the content. Values: High, Normal, and Low

isRequired No Whether deployment settings are required or not. True or False

effectiveDate Yes Datetime when the content will be effective

expirationDate Yes Expiration date of the content

downloadDate Yes Download date of the content

Response Payload

XML

<AwContentModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<ContentId>String</ContentId>

<CreatedOn>Datetime</CreatedOn>

<CreatedBy>String</CreatedBy>

<ModifiedBy>String</ModifiedBy>

<Name>String</Name>

<Description>String</Description>

<Importance>String</Importance>

Chapter 5: Content Management

349

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<LocationGroupId>Numeric</LocationGroupId>

<CategoryId>String</CategoryId>

<Name>String</Name>

</SearchCategoryModel>

</Categories>

<MimeType>String</MimeType>

<IsActive>Boolean</IsActive>

<ContentVersionId>String</ContentVersionId>

<Version>String</Version>

<Notes>String</Notes>

<Size>Numeric</Size>

<Hash>String</Hash>

<Author>String</Author>

<Subject>String</Subject>

<Keywords>String</Keywords>

<DownloadLink>String</DownloadLink>

<HashAlgorithm>String</HashAlgorithm>

</ContentVersion>

<ViewOnlineOnly>Boolean</ViewOnlineOnly>

<ForceEncryption>Boolean</ForceEncryption>

<AllowEmail>Boolean</AllowEmail>

<IsExportable>Boolean</IsExportable>

<AllowRepoExport>Boolean</AllowRepoExport>

<EnableWatermark>Boolean</EnableWatermark>

<AllowPrint>Boolean</AllowPrint>

<AllowEdit>Boolean</AllowEdit>

</SecuritySettings>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<DownloadMethod>String</DownloadMethod>

<ForceDownload>Boolean</ForceDownload>

<DownloadPriority>String</DownloadPriority>

<IsRequiredContent>Boolean</IsRequiredContent>

<IsFeaturedContent>Boolean</IsFeaturedContent>

<EffectiveDate>Datetime</EffectiveDate>

<ExpirationDate>Datetime</ExpirationDate>

<DownloadDate>Datetime</DownloadDate>

</DeploymentSettings>

</AwContentModel>

JSON

{

"contentId" : "String",

Chapter 5: Content Management

350

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"name" : "String",

"description" : "String",

"mimeType" : "String",

"isActive" : Boolean,

"importance" : "String",

"locationGroupId" : Numeric,

"createdOn" : "Datetime",

"createdBy" : "String",

"modifiedOn" : "Datetime",

"modifiedBy" : "String",

"Categories" : [

{

"categoryId" : "String",

"name" : "String"

{

"categoryId" : "String",

"name" : "String"

}

"ContentVersion" : {

"contentVersionId" : "String",

"version" : "String",

"notes" : "String",

"size" : Numeric,

"hash" : "String",

"author" : "String",

"subject" : "String",

"keywords" : "String",

"downloadLink" : "String",

"hashAlgorithm" : "String",

"SecuritySettings" : {

"allowViewOnline" : Boolean,

"forceEncryption" : Boolean,

"allowOpenInEmail" : Boolean,

"allowOpenInThirdPartyApps" : Boolean,

"allowSavingToOtherRepositories" : Boolean,

"enableWaterMark" : Boolean,

"allowPrint" : Boolean,

"allowEdit" : Boolean,

"DeploymentSettings" : {

"downloadWhileRoaming" : Boolean,

"downloadMethod" : "String",

"forceDownload" : Boolean,

"downloadPriority" : "String",

"isRequired" : Boolean,

"isFeaturedContent" : Boolean,

"effectiveDate" : "Datetime",

"expirationDate" : "Datetime",

Chapter 5: Content Management

351

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"downloadDate" : "Datetime",

}

Response Tag Details

Tag Type Description

contentId Numeric Unique identification number of the content

name String Name of the content

description String Description for the content

mimeType String Type of the MIME to filter contents

isActive Boolean Is the content active. True of False

importance String Importance of the content

locationGroupId Numeric Unique identification number of the location group

createdOn Datetime Time stamp when the content was created

createdBy String Name of the author who created the content

modifiedOn Datetime Time stamp when the content was last modified

modifiedBy String Name of the author who modified the content

categoryId Numeric Unique identifier for the category

name String Name of the category

contentVersionId String Unique identifier of the content version

version String Version of the content

notes String Notes for the content

size Numeric Size of the content

hash String Computed hash for the content

author String Author of the content

subject String Subject of the content

keywords String Keywords to search the content

downloadLink String Link to download the content

hashAlgorithm String Algorithm used to compute hash

allowViewOnline Boolean Whether to allow content to view online. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

allowOpenInEmail Boolean Whether to allow content to open in emails. True or False

Chapter 5: Content Management

352

VMware AirWatch REST API Guide | v.2016.04 | April 2017

allowOpenInThirdPartyApps Boolean Whether to allow content to open in third party applications. True

or False

allowSavingToOtherRepositories Boolean Whether to allow content to get saved in other repositories. True or

False

enableWaterMark Boolean Whether to enable water mark on the content. True or False

allowPrint Boolean Whether to allow to print the content. True or False

allowEdit Boolean Whether to allow editing the content. True or False

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

downloadMethod String Method used to download the content

forceDownload Boolean Whether to force download the content. True or False

downloadPriority String Priority set to the content. Values: High, Normal, and Low

isRequired Boolean Whether deployment settings are required or not. True or False

effectiveDate Datetime Datetime when the content will be effective

expirationDate Datetime Expiration date of the content

downloadDate Datetime Download date of the content

Chapter 5: Content Management

353

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve List of AirWatch Managed Content

Functionality – Retrieves list of AirWatch managed content.

HTTP Method – GET

API URI – https://host/api/mcm/awcontents?locationgroupcode={locationgroupcode}&locationgroupid=

{locationgroupid}&queryString={queryString}&categoryId={categoryId}&mimeType={mimeType}&expiresIn=

{expiresIn}&sortBy={sortBy}&sortAscending={sortAscending}&pageSize={pageSize}&startIndex={startIndex}

Request Payload – NA

URI Parameters

Tag Type Description

locationgroupcode String Location group code

locationgroupid Numeric Location group id

queryString String Searches for the string value in the File Name

categoryId Numeric The unique identifier for the Category being queried

mimeType String Filter contents by Mime Type

expiresIn Numeric Filter by Contents that are going to expire within days specified

sortBy String Sort by what column, it accepts "Name", "Size", "Author",

"DownloadPriority", "IsRequired", "IsActive", "EffectiveDate",

"ExpirationDate", "ModifiedOn", or "ModifiedBy". By default it sorts by

"Name"

sortAscending Boolean Sort direction. By default it sorts Ascending

startIndex Numeric Start index of page

pageSize Numeric Specifies the number of results returned per Page

Response Payload

XML

<Id>Numeric</Id>

<Links>

<Link>

<Rel>String</Rel>

<Href>String</Href>

<Title>String</Title>

</Link>

Chapter 5: Content Management

354

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</Links>

</AdditionalInfo>

<TotalResults xmlns="http://www.air-

watch.com/webapi/resources">Numeric</TotalResults>

<Id>Numeric</Id>

<Links>

<Link>

<Rel xmlns="http://www.air-

watch.com/webapi/resources">String</Rel>

<Href xmlns="http://www.air-

watch.com/webapi/resources">String</Href>

<Title xmlns="http://www.air-

watch.com/webapi/resources">String</Title>

</Link>

</Links>

<ContentId>String</ContentId>

<ParentId>String</ParentId>

<Name>String</Name>

<MimeType>String</MimeType>

<SharingRole>String</SharingRole>

<Owner>String</Owner>

<IsFavorite>Boolean</IsFavorite>

<IsTrashed>Boolean</IsTrashed>

<IsShared>Boolean</IsShared>

<DownloadMethod>String</DownloadMethod>

<DownloadWhileRoaming>Boolean</DownloadWhileRoaming>

<ForceEncryption>Boolean</ForceEncryption>

<CurrentVersionNumber>String</CurrentVersionNumber>

<Description>String</Description>

<Notes>String</Notes>

<Subject>String</Subject>

<DownloadLink>String</DownloadLink>

<Size>Numeric</Size>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</ContentItemModel>

</ResultSet>

</ContentPagedResultModel>

JSON

{

"AdditionalInfo" : {

"Links" : [

{

"Href" : "String",

Chapter 5: Content Management

355

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"Rel" : "String",

"Title" : "String"

}

]

"TotalResults" : Numeric,

"content" : [

{

"id" : Numeric,

"Links" : [

{

"Href" : "String",

"Rel" : "String",

"Title" : "String"

}

"contentId" : "String",

"createdOn" : "Datetime",

"currentVersionNumber" : "String",

"description" : "String",

"downloadLink" : "String",

"downloadMethod" : "String",

"downloadWhileRoaming" : Boolean,

"forceEncryption" : Boolean,

"isFavorite" : Boolean,

"isShared" : Boolean,

"isTrashed" : Boolean,

"mimeType" : "String",

"modifiedOn" : "Datetime,

"name" : "String",

"notes" : "String",

"owner" : "String",

"parentId" : "String",

"sharingRole" : "String",

"size" : Numeric,

"subject" : "String"

}

]

}

Response Tag Details

Tag Type Description

contentId String Unique identifier for the content

createdOn Datetime Time stamp when the content was created

currentVersionNumber String The current version of the content

description String Description about the content

downloadLink String Link to download the content

Chapter 5: Content Management

356

VMware AirWatch REST API Guide | v.2016.04 | April 2017

downloadMethod String Method used to download the content

downloadWhileRoaming Boolean Whether to download content while roaming. True or False

forceEncryption Boolean Whether to force encrypt the content. True or False

isFavorite Boolean Is the content favorite. True or False

isShared Boolean Is the content shared. True or False

isTrashed Boolean Is the content trashed. True or False

mimeType String Type of the MIME to filter contents

modifiedOn Datetime Time stamp when the content was last modified

name String Name of the content

notes String Additional notes regarding the content

owner String Owner of the content

parentId String Unique identifier of the parent organization group

sharingRole String Type of the sharing role; Co-owner, Editor, or Reader

size Numeric Size of the content

subject String Subject of the content

Chapter 5: Content Management

357

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Chapter 6:

Device Management

Overview 361

Retrieve Application Details From the Device 361

Retrieve Admin Application Details 364

Retrieve Device Bulk Settings 366

Retrieve Certificate Details From the Device 368

Retrieve Compliance Details of the Device 370

Retrieve Compliance Attributes 372

Save Compliance Attributes for a List of Devices 374

Retrieve Content Details of the Device 377

Retrieve Device Information 379

Retrieve Bulk Device Information 383

Retrieve Device Application Status 388

Retrieve Event Logs From the Device 390

Retrieve GPS Co-ordinates of the Device 393

Retrieve Bulk GPS Co-ordinates From the Device 395

Execute Bulk GPS Coordinates 398

Retrieve Network Information of the Device 400

Retrieve Profile Details of the Device 404

Retrieve Enrollment User Details of the Device 407

Retrieve Enrolled Device Count 409

Retrieve Smart Group details 411

Retrieve Device Associated Smart Groups 415

358

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Security Information 417

Change Device Passcode (*Refactored) 419

Clear Passcode on the Device (*Refactored) 420

Enterprise Wipe a Device (*Refactored) 421

Enterprise Wipe in Bulk (*Refactored) 422

Find Device (*Refactored) 424

Lock Device (*Refactored) 426

Lock Devices in Bulk (*Refactored) 427

Query Device (*Refactored) 430

Device Wipe (*Refactored) 431

Delete Device 432

Delete Devices in Bulk (*Refactored) 433

Sync Device (*Refactored) 436

Send Email to the Device Enrollment User (*Refactored) 437

Send Email in Bulk (*Refactored) 439

Send SMS to the Device (*Refactored) 441

Send SMS in Bulk (*Refactored) 443

Send Push Message to the Device (*Refactored) 445

Bulk Push Message to the Devices (*Refactored) 447

Push Notification (*Refactored) 449

Execute Device Commands 451

Execute Bulk Device Commands 452

Schedule OS Update Command 454

Bulk Schedule OS Update Command 455

Start Airplay 458

Send Remote Control Action Command (*Refactored) 460

Add Note to the Device (*Refactored) 461

Delete Note From the Device 463

Retrieve Notes From the Device 464

Retrieve a Specific Note From the Device 466

Update Note onto the Device (*Refactored) 468

Search Device Details 470

Chapter 6: Device Management

359

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Compliance Policy 477

Device Extensive Search 480

Search Security Information 484

Search Network Information 486

Device Extensive Search (Lite) 488

Custom Attribute Search 491

Search Changes Made To Custom Attribute 493

Update Device Custom Attribute (*Refactored) 495

Delete Custom Attribute (*Refactored) 498

Edit Device Details 501

Managed Settings 503

Change Device Organization Group 504

Create Offline Device Record 505

Create Relay Server 506

Create Relay Servers in Bulk 510

Delete Relay Server 516

Retrieve Relay Server Details 517

Update Relay Server 521

Create Staging Bundle 525

Delete Staging Bundle 528

Retrieve Staging Bundle 529

Update Staging Bundle 532

Retrieve Printer Details Using Identifier 534

Retrieve Printer Details Using Location Group 536

Chapter 6: Device Management

360

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Overview

AirWatch REST APIs allows you to manage all the functionalities of Mobile Device Management (MDM). The

functionalities that are included but not limited to are device commands, retrieval of compliance, profile, network,

location, and event log details. Device details can be viewed in the following path on the AirWatch Console:

lDevice Dashboard – Devices > List View.

Retrieve Application Details From the Device

Functionality – Retrieves the details of the applications that are present on the device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/apps? page={page}&pagesize={pagesize}

The user can obtain the application details using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/apps?searchby={searchby}&id={id}&page=

{page}&pagesize={pagesize}

Pattern (Contains) Match Parameter – id, page, pagesize, searchby

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id Device alternate id

page The specific page number to get

pagesize Max records per page

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/apps

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/apps

lUDID – https://host/api/mdm/devices/UDID/{UDID}/apps

Response Payload

XML

<Page>Numeric</Page>

<PageSize>Numeric</PageSize>

<Total>Numeric</Total>

Chapter 6: Device Management

361

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Id>Numeric</Id>

<ApplicationName>String</ApplicationName>

<Version>Numeric</Version>

<BuildVersion>Numeric</BuildVersion>

<Status>String</Status>

<Size>Numeric</Size>

<ApplicationIdentifier>Numeric</ApplicationIdentifier>

<Type>String</Type>

<IsManaged>String</IsManaged>

<AppVersion>String</AppVersion>

</DeviceApps>

JSON

{

"DeviceApps": [

{

"ApplicationName": "String",

"Version": Numeric,

"BuildVersion": Numeric,

"Status": Numeric,

"Size": Numeric,

"ApplicationIdentifier": Numeric,

"Type": "String",

"IsManaged":String

"Id":Numeric}]

"DeviceId":{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

}

Response Tag Details

Tag Type Description

Page Numeric Page number of the search result

PageSize Numeric Number of device apps shown on each page

Total Numeric Total number of applications on the device

Id Numeric Application ID of a managed device

ApplicationName String Name of the application

Chapter 6: Device Management

362

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Version Numeric Version of the application

BuildVersion Numeric Build version of the application

Status String Current status of the application of the device (Installed, Pending

Install etc). Refer Tables.

Size Numeric Size of the application in bytes

ApplicationIdentifier Numeric Unique ID of the application (Bundle ID or External ID)

Type String Type of application; Internal or Public

IsManaged String Denotes if the application is managed by MDM. The values obtained is

either True or False

Deviceid Numeric Unique identification number of the device

Chapter 6: Device Management

363

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Admin Application Details

Functionality – Retrieves admin applications details for the passed device ID.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/adminapps

Request Payload – N/A

URI Parameters

Tag Type Description

Id Numeric Unique numeric ID of the device

Response Payload

XML

<DeviceAdminAppsResultModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Name>String</Name>

<Version>String</Version>

<Identifier>String</Identifier>

</DeviceAdminAppInfoModel>

<Name>String</Name>

<Version>String</Version>

<Identifier>String</Identifier>

</DeviceAdminAppInfoModel>

</DeviceAdminApps>

</DeviceAdminAppsResultModel>

JSON

{

"DeviceAdminApps" : [

{

"Name" : "String",

"Version" : "String",

"Identifier" : "String"

{

"Name" : "String",

Chapter 6: Device Management

364

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"Version" : "String",

"Identifier" : "String"

}

]

}

Response Tag Details

Tag Type Description

Name String Name of the device admin application

Version String Version of the application

Identifier String Unique identifier of the application

Chapter 6: Device Management

365

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Device Bulk Settings

Functionality – Retrieves the values for bulk management settings done on the AirWatch Console.

HTTP Method – GET

API URI – https://host/api/mdm/devices/bulksettings

Response Payload

XML

<SendMessage>String</SendMessage>

<EnterpriseWipe>String</EnterpriseWipe>

<DeleteDevice>String</DeleteDevice>

<GPS>String</GPS>

<LockDevice>String</LockDevice>

</BulkSettings>

JSON

{

"SendMessage":String,

"EnterpriseWipe":String,

"DeleteDevice":String,

"GPS":String,

"LockDevice":String

}

Response Tag Details

Tag Type Description

SendMessage String Maximum number of devices to which message can be sent in bulk

EnterpriseWipe String Maximum number of devices which can be enterprise wiped in bulk

DeleteDevice String Maximum number of devices which can be deleted from the console in

bulk

GPS String Maximum number of devices for which the location details can be

obtained in bulk

LockDevice String Maximum number of devices which can be locked in bulk

Chapter 6: Device Management

366

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Note: Bulk settings can be viewed in the following path in the AirWatch Console : Settings > Devices & Users >

Advanced > Bulk Management.

Chapter 6: Device Management

367

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Certificate Details From the Device

Functionality – Retrieves the details of the certificates that are present on the device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/certificates?page={page}&pagesize={pagesize}

You can obtain the device certificate details using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/certificates?searchby={searchby}&id={id}&page=

{page}&pagesize={pagesize}

Pattern (Contains) Match Parameter – id, page, pagesize, searchby

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id Device alternate id

page The specific page number to get

pagesize Max records per page

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/certificates

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/certificates

lUDID – https://host/api/mdm/devices/UDID/{UDID}/certificates

Response Payload

XML

<Page >Numeric </Page>

<PageSize >Numeric</PageSize>

<Total>Numeric</Total>

<Id>Numeric</Id>

<FirstSampleTime>Datetime</FirstSampleTime>

<LastSampleTime>Datetime </LastSampleTime>

<DeviceId>Numeric</DeviceId>

<Name>String</Name>

<ExpiresOn>Datetime</ExpiresOn>

<IssuedBy>String</IssuedBy>

<Status>String</Status>

Chapter 6: Device Management

368

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</DeviceCertificates>

JSON

{"DeviceCertificates": [

{

"FirstSampleTime": "Datetime",

"LastSampleTime": "Datetime",

"DeviceId": {"Id": {"Value": Numeric} },

"Name": "String ",

"ExpiresOn": "Datetime",

"IssuedBy": "String",

"Status": String,

"Id": {"Value": Numeric}

},]

"Page": Numeric,

"PageSize": Numeric,

"Total": Numeric

}

Response Tag Details

Tag Type Description

FirstSampleTime Datetime Time stamp of the time the first certificate sample was received

LastSampleTime Datetime Time stamp of the time the last certificate sample was received

DeviceId Numeric Unique identification of the device

Name String Name of the certificate

ExpiresOn Datetime Date of expiry of the certificate

IssuedBy String Issuer of the certificate

Status String Current Status of the certificate on the device (Installed, Pending Install

etc)

Id Numeric Unique ID of the certificate

Page Numeric Page number of the search result

PageSize Numeric Number of device certificates shown on each page

Total Numeric Total number of certificates on the device

Chapter 6: Device Management

369

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Compliance Details of the Device

Functionality – Retrieves the details of the compliance policies that are present on a device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/compliance? page={page}&pagesize={pagesize}

You can obtain the device compliance policy details using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/compliance?searchby={searchby}&id={id}&page=

{page}&pagesize={pagesize}

Pattern (Contains) Match Parameter – id, page, pagesize, searchby

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, IMEI number)

id id of the device for which remote control action needs to be initiated

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/compliance

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/compliance

lUDID – https://host/api/mdm/devices/UDID/{UDID}/compliance

Response Payload

XML

<Page >Numeric</Page>

<PageSize >Numeric</PageSize>

<Total>Numeric</Total>

<OverallCompliantStatus>String</OverallCompliantStatus>

<Id>Numeric</Id>

<ActionType>String</ActionType>

</ActionTaken>

<CompliantStatus>String</CompliantStatus>

<PolicyName>String</PolicyName>

<PolicyDetail>String</PolicyDetail>

<LastComplianceCheck>Datetime</LastComplianceCheck>

<NextComplianceCheck>Datetime</NextComplianceCheck>

</DeviceCompliance>

</DeviceComplianceSearchResult>

Chapter 6: Device Management

370

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{ "DeviceCompliance": [ {

"CompliantStatus": String,

"PolicyName": "String ",

"PolicyDetail": "String ",

"LastComplianceCheck": "Datetime",

"NextComplianceCheck": "Datetime",

"ActionTaken": [String],

"Id": { Value": Numeric} } ],

"Page": Numeric,

"PageSize": Numeric,

"Total": Numeric}

Response Tag Details

Tag Type Description

CompliantStatus String Compliance status of the specific policy

PolicyName String Name of the compliance policy

PolicyDetail String Details of the compliance policy

LastComplianceCheck Datetime Time stamp of the last compliance check

NextComplianceCheck Datetime Scheduled time of the next compliance check

ActionTaken String Action taken on the device for the policy

Id Numeric Unique ID of the compliance policy

Page Numeric Page number of the search result

PageSize Numeric Number of compliance polices shown on each page

Total Numeric Total number of policies on the device

Chapter 6: Device Management

371

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Compliance Attributes

Functionality – Gets the list compliance attributes configured for an organizational group based on the vendor name.

HTTP Method – GET

API URI – https://host/api/mdm/complianceattributes/organizationgroupcomplianceattributes?vendorname=

{vendorname}

URI Parameters

Tag Type Description

vendorname String Name of the vendor

Request Payload – NA

Response Payload

XML

<OrganizationGroupComplianceAttributeListModel

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<FriendlyName>String</FriendlyName>

<Key>String</Key>

<OperatorTypes>String</OperatorTypes>

<string>String</string>

</Values>

</ComplianceAttributes>

</OrganizationGroupComplianceAttributeListModel>

JSON

{

"ComplianceAttributes" : [

{

"FriendlyName" : "String",

"Key" : "String",

"OperatorTypes" : [

"String",

"String"

Chapter 6: Device Management

372

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"Values" : [

"String",

"String"

]

}

]

}

Response Tag Details

Tag Type Description

FriendlyName String Friendly name of the custom attribute

Key String Key for the custom attribute to be retrieved

OperatorTypes String Operator type for the custom attribute

Values String Unique value for the custom attribute to be retrieved

Chapter 6: Device Management

373

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Save Compliance Attributes for a List of Devices

Functionality – Saves a list of compliance attributes for a list of devices. Also, evaluates compliance status for devices if

admin has setup policies for these devices.

HTTP Method – PUT

API URI – https://host/api/mdm/complianceattributes/devicecomplianceattributes

Request Payload

XML

DeviceComplianceAttributeListModel

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<SerialNumber>String</SerialNumber>

<Name>String</Name>

<Value>String</Value>

</ComplianceAttributes>

</DeviceComplianceAttributes>

</DeviceComplianceAttributeListModel>

JSON

{

"DeviceComplianceAttributes" : [

{

"SerialNumber" : "String",

"ComplianceAttributes" : [

{

"Name" : "String",

"Value" : "String"

}

]

}

]

}

Request Tag Details

Tag Mandatory Description

SerialNumber Yes The serial number of the device

Chapter 6: Device Management

374

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Name No Compliance attribute name

Value Yes Compliance attribute value

Response Payload

XML

<BulkResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/servicemodel/resources">

<TotalItems>Numeric</TotalItems>

<AcceptedItems>Numeric</AcceptedItems>

<FailedItems>Numeric</FailedItems>

<ActivityId>String</ActivityId>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

</Faults>

</BulkResponse>

JSON

{

"TotalItems" : Numeric,

"AcceptedItems" : Numeric,

"FailedItems" : Numeric,

"Faults" : {

"Fault" : [

{

"ErrorCode" : Numeric,

"ItemValue" : "String",

"Message" : "String"

}

]

}

Response Tag Details

Tag Type Description

TotalItems Numeric Total number of compliance attributes

AcceptedItems Numeric Accepted compliance policies

Chapter 6: Device Management

375

VMware AirWatch REST API Guide | v.2016.04 | April 2017

FailedItems Numeric Failed compliance policies

ErrorCode Numeric Error code of the failed compliance policy

ItemValue String Value of the compliance attribute

Message String Message displayed during the failure of a compliance policy

Chapter 6: Device Management

376

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Content Details of the Device

Functionality – Retrieves the details of the content that is present on a device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/content? page={page}&pagesize={pagesize}

The user can obtain the device content details using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/content?searchby={searchby}&id={id}&page=

{page}&pagesize={pagesize}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, IMEI number)

id id of the device for which remote control action needs to be initiated

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/content

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/content

lUDID – https://host/api/mdm/devices/UDID/{UDID}/content

Response Payload

XML

<Page >Numeric </Page>

<PageSize >Numeric</PageSize>

<Total>Numeric</Total>

<DeviceId>Numeric</DeviceId>

<Id>Numeric</Id>

<ContentName>String</ContentName>

<Status>String</Status>

<DownloadPriority>String</DownloadPriority>

<DeployMode>String</DeployMode>

<ContentType>String</ContentType>

</DeviceContents>

Chapter 6: Device Management

377

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{"DeviceId": {"Id": {"Value": Numeric},},

"DeviceContents": [

{

"ContentName": " String ",

"Status": String,

"DownloadPriority": String.,

"DeployMode": String,

"ContentType": String,

"Id": {"Value": Numeric }

},]

"Page": Numeric,

"PageSize": Numeric,

"Total":Numeric }

Response Tag Details

Tag Type Description

Id Numeric Unique ID of the content

ContentName String Name for the content

Status String Current Status of the content: Installed/Pending Install/Never Installed

etc

DownloadPriority String Priority set to the content. Values: High, Normal, and Low

DeployMode String Deployment mode of the content on the device. Values: On Demand,

Automatic

ContentType String Content Type (.doc,.pdf etc.)

Page Numeric Page number of the search result

PageSize Numeric Number of content details shown on each page

Total Numeric Total number of documents on the device

Chapter 6: Device Management

378

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Device Information

Functionality – Retrieves details of the device identified by device ID.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}

You can obtain the device information using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices?searchby={searchby}&id={id}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber, EasId)

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}

lUDID – https://host/api/mdm/devices/UDID/{UDID}

Request Body – NA

Response Payload

XML

<Id>Numeric</Id>

<Udid>String</Udid>

<SerialNumber>String</SerialNumber>

<MacAddress>String</MacAddress>

<Imei>String</Imei>

<EasId>String</EasId>

<AssetNumber>String</AssetNumber>

<DeviceFriendlyName>String</DeviceFriendlyName>

<LocationGroupId>Numeric</LocationGroupId>

<LocationGroupName>String</LocationGroupName>

<UserName>String</UserName>

<UserEmailAddress>String</UserEmailAddress>

<Ownership>String</Ownership>

<PlatformId title="platformName">Numeric</PlatformId>

<Platform>String</Platform>

<ModelId title="Model Name">Numeric</ModelId>

<Model>String</Model>

<PhoneNumber>String</PhoneNumber>

<OperatingSystem>String</OperatingSystem>

Chapter 6: Device Management

379

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<LastSeen>Datetime</LastSeen>

<EnrollmentStatus>String</EnrollmentStatus>

<ComplianceStatus>String</ComplianceStatus>

<CompromisedStatus>String</CompromisedStatus>

<LastEnrolledOn>Datetime</LastEnrolledOn>

<LastComplianceCheckOn>Datetime</LastComplianceCheckOn>

<LastCompromisedCheckOn>Datetime</LastCompromisedCheckOn>

<Id xmlns="">Numeric</Id>

<CompliantStatus>Boolean</CompliantStatus>

<PolicyName>String</PolicyName>

<PolicyDetail>String</PolicyDetail>

<LastComplianceCheck>Datetime</LastComplianceCheck>

<NextComplianceCheck>Datetime</NextComplianceCheck>

<ActionType>unknown</ActionType>

</ActionTaken>

</DeviceCompliance>

</ComplianceSummary>

<IsSupervised>Boolean</IsSupervised>

<IsRemoteManagementEnabled>String</IsRemoteManagementEnabled>

<DataEncryptionYN>String</DataEncryptionYN>

<AcLineStatus>Numeric</AcLineStatus>

<VirtualMemory>Numeric</VirtualMemory>

<OEMInfo>String</OEMInfo>

</Device>

JSON

{

"Id":Numeric,

"AcLineStatus":Numeric,

"AssetNumber":"String",

"ComplianceStatus":"String",

"ComplianceSummary":{

"DeviceCompliance":[{

"Id":Numeric,

"ActionTaken":[{

"ActionType":Boolean

}],

"CompliantStatus":Boolean,

"LastComplianceCheck":"Datetime",

"NextComplianceCheck":"Datetime",

"PolicyDetail":"String",

"PolicyName":"String"

}]

Chapter 6: Device Management

380

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"CompromisedStatus":Boolean,

"DataEncryptionYN":"String",

"DeviceFriendlyName":"String",

"EasId":"String",

"EnrollmentStatus":"String",

"Imei":"String",

"IsRemoteManagementEnabled":"String",

"IsSupervised":Boolean,

"LastComplianceCheckOn":"Datetime",

"LastCompromisedCheckOn":"Datetime",

"LastEnrolledOn":"Datetime",

"LastSeen":"Datetime",

"LocationGroupId": {

"Id": { "Value":Numeric} },

"Name": "String"

"LocationGroupName":"String",

"MacAddress":"String",

"Model":"String",

"ModelId":{

"Id": { "Value": Numeric },

"Name": "String"

"OEMInfo":"String",

"OperatingSystem":"String",

"Ownership":"String",

"PhoneNumber":"String",

"Platform":"String",

"PlatformId":{

"Id": { "Value": Numeric },

"Name": "String"

"SerialNumber":"String",

"Udid":"TString",

"UserEmailAddress":"String",

"UserId":{

"Id": { "Value": Numeric },

"Name": "String"

"UserName":"String",

"VirtualMemory":Numeric

}

Response Tag Details

Tag Type Description

Udid String UDID of the device

SerialNumber String Serial number of the device

MacAddress String MAC address of the device

Chapter 6: Device Management

381

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Imei String IMEI number of the device

AssetNumber String Asset number of the device

DeviceFriendlyName String Friendly name assigned to the device

LocationGroupId Id Numeric ID of the organization group to which the device is assigned

LocationGroupName String Name of the organization group to which the device is assigned

UserName String Name of the enrollment user to whom the device is assigned

UserEmailAddress String Email address of the enrollment user

Ownership String Ownership type of the device. Values: Corporate-Shared, Corporate-

Dedicated, Employee Owned

PlatformId Numeric Unique identification associated with the platform

Platform String Name of the platform

ModelId Numeric Unique identification associated with the model

Model String OEM model name

OperatingSystem String Operating System version on the model

PhoneNumber String Phone number of the device

LastSeen Datetime Last seen time stamp of the device

EasId String Unique identification of the Exchange Active Sync

EnrollmentStatus String Current enrollment status of the device. For example, Enrolled,

Unenrolled etc

ComplianceStatus String Overall compliance status of the device

CompromisedStatus String Compromised status of the device. Values: True/False

LastEnrolledOn Datetime Time stamp of the last enrollment of the device

LastComplianceCheckOn Datetime Time stamp of the last compliance check

LastCompromisedCheckOn Datetime Time stamp of the last compromised status check

Id Numeric Unique identification of the device

VirtualMemory Numeric Virtual memory of the device

OEMInfo String OEM information of the device

IsRemoteManagementEnabled String Remote management status of the device

IsSupervised Boolean The supervised status of the device

CompliantStatus Boolean Complaint status of the device

PolicyDetail String Details of the compliance policy action taken on the device

PolicyName String Name of the compliance policy

Chapter 6: Device Management

382

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Bulk Device Information

Functionality – Retrieves information about multiple devices identified by the specified Id type.

HTTP Method – POST

API URI – https://host/api/mdm/devices/id

You can obtain the bulk device details using the following parameters:

lAlternate device ID type – https://host/api/mdm/devices?searchby={searchby}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress

lSerial Number – https://host/api/mdm/devices/serialnumber

lUDID – https://host/api/mdm/devices/UDID

Request Payloads

XML

<Value>Numeric/String</Value>

</BulkValues>

</BulkInput>

JSON

{

"BulkValues":{"value": ["Numeric/String","Numeric/String"]}

}

Chapter 6: Device Management

383

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

Value Yes(at least 1) Desired device parameter. "DeviceID","MAC Address", "Serial Number"

or "UDID"

Response Payloads

XML

<DeviceSearchResult xmlns="http://www.air-

watch.com/servicemodel/resources"><Device>

<Id>Numeric</Id>

<Udid>String</Udid>

<SerialNumber>String</SerialNumber>

<MacAddress>String</MacAddress>

<Imei>String</Imei>

<EasId>String</EasId>

<AssetNumber>String</AssetNumber>

<DeviceFriendlyName>String</DeviceFriendlyName>

<LocationGroupId>Numeric</LocationGroupId>

<LocationGroupName>String</LocationGroupName>

<UserName>String</UserName>

<UserEmailAddress>String</UserEmailAddress>

<Ownership>String</Ownership>

<PlatformId title="platformName">Numeric</PlatformId>

<Platform>String</Platform>

<ModelId title="Model Name">Numeric</ModelId>

<Model>String</Model>

<PhoneNumber>String</PhoneNumber>

<OperatingSystem>String</OperatingSystem>

<LastSeen>Datetime</LastSeen>

<EnrollmentStatus>String</EnrollmentStatus>

<ComplianceStatus>String</ComplianceStatus>

<CompromisedStatus>String</CompromisedStatus>

<LastEnrolledOn>Datetime</LastEnrolledOn>

<LastComplianceCheckOn>Datetime</LastComplianceCheckOn>

<LastCompromisedCheckOn>Datetime</LastCompromisedCheckOn>

<Id xmlns="">Numeric</Id>

<CompliantStatus>Boolean</CompliantStatus>

<PolicyName>String</PolicyName>

<PolicyDetail>String</PolicyDetail>

<LastComplianceCheck>Datetime</LastComplianceCheck>

<NextComplianceCheck>Datetime</NextComplianceCheck>

<ActionType>unknown</ActionType>

Chapter 6: Device Management

384

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</ActionTaken>

</DeviceCompliance>

</ComplianceSummary>

<IsSupervised>Boolean</IsSupervised>

<SIMMCC>String</SIMMCC>

<CurrentMCC>String</CurrentMCC>

</DeviceMCC>

<IsRemoteManagementEnabled>String</IsRemoteManagementEnabled>

<DataEncryptionYN>String</DataEncryptionYN>

<AcLineStatus>Numeric</AcLineStatus>

<VirtualMemory>Numeric</VirtualMemory>

<OEMInfo>String</OEMInfo>

</Devices>

</DeviceSearchResult>

JSON

{

"Id":Numeric,

"AcLineStatus":Numeric,

"AssetNumber":"String",

"ComplianceStatus":"String",

"ComplianceSummary":{

"DeviceCompliance":[{

"Id":Numeric,

"ActionTaken":[{

"ActionType":Boolean

}],

"CompliantStatus":Boolean,

"LastComplianceCheck":"Datetime",

"NextComplianceCheck":"Datetime",

"PolicyDetail":"String",

"PolicyName":"String"

}]

"CompromisedStatus":Boolean,

"DataEncryptionYN":"String",

"DeviceFriendlyName":"String",

"EasId":"String",

"EnrollmentStatus":"String",

"Imei":"String",

"IsRemoteManagementEnabled":"String",

"IsSupervised":Boolean,

"LastComplianceCheckOn":"Datetime",

"LastCompromisedCheckOn":"Datetime",

"LastEnrolledOn":"Datetime",

"LastSeen":"Datetime",

Chapter 6: Device Management

385

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"LocationGroupId": { "Id": { "Value":Numeric} },

"LocationGroupName":"String",

"MacAddress":"String",

"Model":"String",

"ModelId":{

"Id": { "Value": Numeric },

"Name": "String"

"OEMInfo":"String",

"OperatingSystem":"String",

"Ownership":"String",

"PhoneNumber":"String",

"Platform":"String",

"PlatformId":{

"Id": { "Value": Numeric },

"Name": "String"

"SerialNumber":"String",

"Udid":"TString",

"UserEmailAddress":"String",

"UserId":{

"Id": { "Value": Numeric },

"Name": "String"

"UserName":"String",

"VirtualMemory":Numeric

}

Response Tag Details

Tag Type Description

Udid String UDID of the device

SerialNumber String Serial number of the device

MacAddress String MAC address of the device

Imei String IMEI number of the device

AssetNumber String Asset number of the device

DeviceFriendlyName String Friendly name assigned to the device

LocationGroupId Id Numeric Unique identification of the organization group to which the device is

assigned

LocationGroupName String Name of the organization group to which the device is assigned

UserName String Name of the enrollment user to whom the device is assigned

UserEmailAddress String Email address of the enrollment user

Chapter 6: Device Management

386

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Ownership String Ownership type of the device. Values: Corporate-Shared, Corporate-

Dedicated, Employee Owned

PlatformId Numeric Unique identification associated with the platform

Platform String Name of the platform

ModelId Numeric Unique identification associated with the model

Model String OEM model name

OperatingSystem String Operating system version on the model

PhoneNumber String Phone number of the device

LastSeen Datetime Last seen time stamp of the device

EnrollmentStatus String Current enrollment status of the device. For example, Enrolled,

Unenrolled etc

ComplianceStatus String Overall compliance status of the device

CompromisedStatus String Compromised status of the device. Values: True/False

LastEnrolledOn Datetime Time stamp of the last enrollment of the device

LastComplianceCheckOn Datetime Time stamp of the last compliance check

LastCompromisedCheckOn Datetime Time stamp of the last compromised status check

Id Numeric Unique identification of the device

VirtualMemory Numeric Virtual memory of the device

OEMInfo String OEM information of the device

IsRemoteManagementEnabled String Remote management status of the device

IsSupervised Boolean The supervised status of the device

CompliantStatus Boolean Complaint status of the device

PolicyDetail String Details of the compliance policy action taken on the device

PolicyName String Name of the compliance policy

Chapter 6: Device Management

387

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Device Application Status

Functionality – Retrieves the application status for a combination of input elements.

HTTP Method – GET

API URI – https://host/api/mdm/devices/appstatus?searchby={searchBy}&id={id}&groupid={groupid}&bundleId=

{bundleId}&version={version}&deviceType={deviceType}

URI Parameters

Tag Type Description

searchBy string The alternate id type (macaddress, udid, serialnumber, imeiNumber etc)

id string The alternate id

groupid string GroupId is location group's customer code

bundleId string Bundle id of the application

version string Version of the application

deviceType string Type of the device

Request Payload – NA

Response Payload

XML

<AppStatus xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<appstatus>Numeric</appstatus>

<setting>String</setting>

<value>String</value>

</DeviceStatusMessage>

</devicestatus>

<ssoenabled>Boolean</ssoenabled>

<authenticationurl>String</authenticationurl>

</authentication>

</AppStatus>

Chapter 6: Device Management

388

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"appstatus" : Numeric,

"devicestatus" : [

{

"setting" : "String",

"value" : "String"

}

"authentication" : {

"ssoenabled" : Boolean,

"authenticationurl" : "String"

}

Response Tag Details

Tag Type Description

appstatus Numeric Status of the application in device

setting String Device status setting

value String Value for the device status

ssoenabled Boolean Is SSO enable for the application. Values are: True, False

authenticationurl String URL for the authentication

Chapter 6: Device Management

389

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Event Logs From the Device

Functionality – Retrieves the event log details of the device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/eventlog?page={page}&pagesize={pagesize}&severity=

{severity}&dayrange={dayrange}

lExact Match Parameter – severity

lPattern (Contains) Match Parameter – id, page, pagesize, dayrange

You can also retrieve event log of the device using the following parameter:

lAlternate device id – https://host/api/mdm/devices/eventlog?searchby={searchby}&id={id}&page=

{page}&pagesize={pagesize}&severity={severity}&dayrange={dayrange}

oExact Match Parameter – severity

oPattern (Contains) Match Parameter – searchby, id, page, pagesize, dayrange

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

Note: The Severity (Warning, Information, Notice, Debug) of the event logs can be specified by the severity filter. The

DayRange filter specifies the number of days of logging prior to the current time sent in the response.

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/eventlog

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/eventlog

lUDID – https://host/api/mdm/devices/UDID/{UDID}/eventlog

Response Payload

XML

<Page >Numeric</Page>

<PageSize >Numeric</PageSize>

<Total>Numeric</Total>

<Id>Numeric</Id>

Chapter 6: Device Management

390

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Id>Numeric</Id>

<EventDataType>String</EventDataType>

<OldValue>Numeric</OldValue>

<NewValue>Numeric</NewValue>

</EventDataList>

<Severity>String</Severity>

<TimeStamp>Datetime</TimeStamp>

<Source>String</Source>

<Event>String</Event>

<AdminAccount>String</AdminAccount>

</DeviceEventLogEntries>

JSON

{

"DeviceEventLogEntries":{

"Id":Numeric,

"EventDataList":{"Id": Numeric,

"EventDataType":" String ",

"OldValue":Numeric,

"NewValue":Numeric},

"Severity":" String",

"TimeStamp":"Datetime ",

"Source":"String",

"Event":" String ",

"AdminAccount":" String"

"Page": Numeric,

"PageSize": Numeric,

"Total": Numeric }

}

Response Tag Details

Tag Type Description

Id Numeric Unique identification of the logged event

EventDataList Id Numeric Unique identification of the event data

EventDataType String Type of event data. For example, Compromised Status, Content

Status, etc

OldValue Numeric Existing value of the logged event

NewValue Numeric Modified value of the logged event

Chapter 6: Device Management

391

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Severity String Severity of the logged event. For example, Information ,Debug,

Warning etc

TimeStamp Datetime Time stamp of the logged event

Source String Whether the events are triggered from a 'Server' or an 'Device'

Event String Details of the event logged

AdminAccount String Name of the admin who triggered the logged event

Page Numeric Page number of the search result

PageSize Numeric Number of content details shown on each page

Total Numeric Total number of documents on the device

Chapter 6: Device Management

392

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve GPS Co-ordinates of the Device

Functionality – Retrieves the GPS co-ordinates of the device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/gps?dayrange={dayrange}

You can obtain the device information using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/gps?searchby={searchby}&id={id}&dayrange=

{dayRange}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, IMEI number)

id id of the device for which remote control action needs to be initiated

Note: The DayRange filter specifies the number of days of logging prior to the current time sent in the response.

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/gps

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/gps

lUDID – https://host/api/mdm/devices/UDID/{UDID}/gps

Response Payload

XML

<Id>Numeric</Id>

<SampleTime>Datetime</SampleTime>

<Latitude>Numeric</Latitude>

<Longitude>Numeric</Longitude>

<Elevation>Numeric </Elevation>

<Speed >Numeric</Speed>

<Note>String</Note>

<DeviceId>Numeric </DeviceId>

</GpsCoordinate>

</ArrayOfGpsCoordinate>

Chapter 6: Device Management

393

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

[ { "SampleTime": "Datetime",

"Latitude": Numeric,

"Longitude": Numeric,

"Elevation": Numeric,

"Speed": Numeric,

"Note": "String",

"DeviceId": {"Value": Numeric },

"Id": {"Value":Numeric}

}]

Response Tag Details

Tag Type Description

SampleTime Datetime Time stamp of the obtained GPS sample

Latitude Numeric Latitude in decimal degrees

Longitude Numeric Longitude in decimal degrees

Elevation Numeric Elevation in decimal degrees

Speed Numeric Rate of change of the device position

DeviceId Numeric Unique identification of the device

Id Numeric Unique identification for the obtained GPS co-ordinate

Chapter 6: Device Management

394

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Bulk GPS Co-ordinates From the Device

Functionality – Retrieves the GPS co-ordinates of a list of devices.

HTTP Method – POST

API URI – https://host/api/mdm/devices/gps/search?searchby={searchby}&startdatetime=

{startdatetime}&enddatetime={enddatetime}&dayrange={dayrange}

lPattern (Contains) Match Parameter – searchby, startdatetime, enddatetime, dayrange

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/gps

lSerial Number – https://host/api/mdm/devices/serialnumber/gps

lUDID – https://host/api/mdm/devices/UDID/gps

URI Parameters

Tag Description

searchby Search by device identifier types (DeviceId, MacAddress, Udid, SerialNumber, and

ImeiNumber)

startdatetime Start Date time

enddatetime End Date time

daterange Number of days in which range device location details needs to be returned

Request Payloads

XML

<Value>Numeric</Value>

</BulkValues>

</BulkInput>

Chapter 6: Device Management

395

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"BulkValues":{"value": [Numeric,Numeric]}

}

Request Tag Details

Tag Mandatory Description

Value Yes The device parameter. For example, DeviceID , MAC Address , Serial

Number or UDID

Response Payload

XML

<Id>Numeric</Id>

<SampleTime>Datetime</SampleTime>

<Latitude>Numeric</Latitude>

<Longitude>Numeric</Longitude>

<Elevation>Numeric </Elevation>

<Speed >Numeric</Speed>

<Note>String</Note>

<DeviceId>Numeric</DeviceId>

</GpsCoordinate>

</ArrayOfGpsCoordinate>

JSON

[ { "SampleTime": "Datetime",

"Latitude": Numeric,

"Longitude": Numeric,

"Elevation": Numeric,

"Speed": Numeric,

"Note": "String",

"DeviceId": {"Value": Numeric },

"Id": {"Value":Numeric}

}]

Chapter 6: Device Management

396

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Tag Details

Tag Type Description

SampleTime Datetime Time stamp of the obtained GPS sample

Latitude Numeric Latitude in decimal degrees

Longitude Numeric Longitude in decimal degrees

Elevation Numeric Elevation in decimal degrees

Speed Numeric Rate of change of the device position

DeviceId Numeric Unique identification of the device

Id Numeric Unique identification for the GPS co-ordinate obtained

Chapter 6: Device Management

397

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Execute Bulk GPS Coordinates

Functionality – Executes bulk gps coordinates by device and alternate id.

HTTP Method – POST

API URI – https://host/api/mdm/devices/gps?searchby={searchBy}

URI Parameters

Tag Description

searchby Search by device identifier types (DeviceId, MacAddress, Udid, SerialNumber, and

ImeiNumber)

startdatetime Start Date time

enddatetime End Date time

daterange Number of days in which range device location details needs to be returned

Request Payloads

XML

<Value>Numeric</Value>

</BulkValues>

</BulkInput>

JSON

{

"BulkValues":{"value": [Numeric,Numeric]}

}

Request Tag Details

Tag Mandatory Description

Value Yes The device parameter. For example, DeviceID , MAC Address , Serial

Number or UDID

Chapter 6: Device Management

398

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Payload

XML

<Id>Numeric</Id>

<SampleTime>Datetime</SampleTime>

<Latitude>Numeric</Latitude>

<Longitude>Numeric</Longitude>

<Elevation>Numeric </Elevation>

<Speed >Numeric</Speed>

<Note>String</Note>

<DeviceId>Numeric</DeviceId>

</GpsCoordinate>

</ArrayOfGpsCoordinate>

JSON

[ { "SampleTime": "Datetime",

"Latitude": Numeric,

"Longitude": Numeric,

"Elevation": Numeric,

"Speed": Numeric,

"Note": "String",

"DeviceId": {"Value": Numeric },

"Id": {"Value":Numeric}

}]

Response Tag Details

Tag Type Description

SampleTime Datetime Time stamp of the obtained GPS sample

Latitude Numeric Latitude in decimal degrees

Longitude Numeric Longitude in decimal degrees

Elevation Numeric Elevation in decimal degrees

Speed Numeric Rate of change of the device position

DeviceId Numeric Unique identification of the device

Id Numeric Unique identification for the GPS co-ordinate obtained

Chapter 6: Device Management

399

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Network Information of the Device

Functionality – Retrieves the network information of the device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/network

The user can obtain the network details using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/network?searchby={searchby}&id={id}

URI Parameters

Tag Description

searchby The alternate id type [Macaddress, Udid, Serialnumber, ImeiNumber]

id Device alternate id

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/network

lSerial Number – https://host/api/mdm/devices/serialnumber/{serialNumber}/network

lUDID – https://host/api/mdm/devices/udid/{udid}/network

Response Payload

XML

<DeviceNetworkInfoModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Id xmlns="http://www.air-watch.com/webapi/resources">Numeric</Id>

<PhoneNumber>String</PhoneNumber>

<RoamingStatus>Boolean</RoamingStatus>

<DataRoamingEnabled>Boolean</DataRoamingEnabled>

<VoiceRoamingEnabled>Boolean</VoiceRoamingEnabled>

<WifiIPAddress xmlns="http://www.air-

watch.com/servicemodel/resources">String</WifiIPAddress>

<CellularIPAddress xmlns="http://www.air-

watch.com/servicemodel/resources">String</CellularIPAddress>

<EthernetIPAddress xmlns="http://www.air-

watch.com/servicemodel/resources">String</EthernetIPAddress>

</IPAddress>

<CellularTechnology xmlns="http://www.air-

watch.com/servicemodel/resources">None</CellularTechnology>

Chapter 6: Device Management

400

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<CurrentOperator xmlns="http://www.air-

watch.com/servicemodel/resources">String</CurrentOperator>

<CurrentSIM xmlns="http://www.air-

watch.com/servicemodel/resources">String</CurrentSIM>

<ApprovedSims xmlns="http://www.air-

watch.com/servicemodel/resources">

<SimCardId>String</SimCardId>

</DeviceSimCard>

</ApprovedSims>

<CarrierVersion xmlns="http://www.air-

watch.com/servicemodel/resources">String</CarrierVersion>

<SignalStrength xmlns="http://www.air-

watch.com/servicemodel/resources">String</SignalStrength>

<SIMMCC>String</SIMMCC>

<CurrentMCC>String</CurrentMCC>

</DeviceMCC>

<SimMNC>String</SimMNC>

<CurrentMNC>String</CurrentMNC>

</DeviceMNC>

</CellularNetworkInfo>

<WifiMacAddress xmlns="http://www.air-

watch.com/servicemodel/resources">String</WifiMacAddress>

<SignalStrength xmlns="http://www.air-

watch.com/servicemodel/resources">String</SignalStrength>

</WifiInfo>

</DeviceNetworkInfoModel>

JSON

{

"phonenumber" : "String",

"roamingstatus" : Boolean,

"dataroamingenabled" : Boolean,

"voiceroamingenabled" : Boolean,

"ipaddress" : {

"WifiIPAddress" : "String",

"CellularIPAddress" : "String",

"EthernetIPAddress" : "String"

"cellularnetworkinfo" : {

"CellularTechnology" : Numeric,

"CurrentOperator" : "String",

"CurrentSIM" : "String",

"ApprovedSims" : [

Chapter 6: Device Management

401

VMware AirWatch REST API Guide | v.2016.04 | April 2017

{

"SimCardId" : "String"

{

"SimCardId" : "String"

}

"CarrierVersion" : "String",

"SignalStrength" : "String",

"DeviceMCC" : {

"SIMMCC" : "String",

"CurrentMCC" : "String"

}

"DeviceMNC" : {

"SimMNC" : "String",

"CurrentMNC" : "String"

}

"wifiinfo" : {

"WifiMacAddress" : "String",

"SignalStrength" : "String"

"Links" : [],

"id" : Numeric

}

Response Tag Details

Tag Type Description

PhoneNumber String Phone number of the device

RoamingStatus Boolean The current roaming status. Values: True or False

DataRoamingEnabled Boolean Denotes if the data roaming is enabled. Values: True or False

VoiceRoamingEnabled Boolean Denotes if the voice roaming is enabled. Values: True or False

WifiIPAddress String The IP address for Wi-Fi connectivity

CellularIPAddress String The IP address for cellular connectivity

EthernetIPAddress String The IP address for Ethernet connectivity

CellularTechnology Numeric The current cellular technology

CurrentOperator String Name of the current operator

CurrentSIM String Current SIM number of the device

SimCardId String Unique identification number of the SIM card

CarrierVersion String Version of the SIM Carrier

SignalStrength String Signal strength of the SIM

Chapter 6: Device Management

402

VMware AirWatch REST API Guide | v.2016.04 | April 2017

SIMMCC String SIM MCC number

CurrentMCC String Current MCC Number

SimMNC String SIMMNCnumber

CurrentMNC String Current MNC number

wifiinfo SignalStrength String Signal strength of the wifi connectivity

Chapter 6: Device Management

403

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Profile Details of the Device

Functionality – Retrieves the profile related information of the device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/profiles?page={page}&pagesize={pagesize}

lPattern (Contains) Match Parameter – page, pagesize

You can obtain the device profile details using the following parameter:

lAlternate Device Id – https://host/api/mdm/devices/profiles?searchby={searchby}&id={id}&page=

{page}&pagesize={pagesize}

oPattern (Contains) Match Parameter – id, page, pagesize, searchby

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, IMEI number)

id id of the device for which remote control action needs to be initiated

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/profiles

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/profiles

lUDID – https://host/api/mdm/devices/UDID/{UDID}/profiles

Response Payload

XML

<Page >Numeric </Page>

<PageSize >Numeric</PageSize>

<Total>Numeric</Total>

<DeviceId>Numeric</DeviceId>

<Id>Numeric </Id>

<Status>String</Status>

<Name>String</Name>

<Description>String<Description>

<LocationGroupId>Numeric</LocationGroupId>

<CurrentVersion>Numeric</CurrentVersion>

<AssignmentType>String</AssignmentType>

</DeviceProfiles>

Chapter 6: Device Management

404

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

"DeviceProfiles": [ {

"Status":Numeric,

"Name": " String ",

"Description": " String ",

"LocationGroupId": {"Id": {"Value": Numeric}},

"CurrentVersion": Numeric

"AssignmentType": Numeric,

"Id": {"Value": Numeric}

}]

"Page": Numeric,

"PageSize":Numeric,

"Total": Numeric

}

Response Tag Details

Tag Type Description

Device Id Numeric Unique identification of the device

Status String/Numeric Current status of the profile on device. Status should be of string for

XML response. For example, Installed, Pending Removal etc. Status

should be of Numeric for JSON response. Values for JSON response

are:

0 = unknown

1 = pendinginstall

2 = unconfirmedinstall

3 = confirmedinstall

4 = pendingremoval

5 = unconfirmedremoval

6 = confirmedremoval

Name String Name of the profile

Description String Description of the profile

LocationGroupId Numeric Unique identification of the organization group to which the profile is

assigned

CurrentVersion Numeric Current version of the profile

AssignmentType String/Numeric Assignment type of the profile. Values are: Auto, Optional, Interactive,

Compliance. Should be String for XML response and Numeric for JSON

response.

Id Numeric Unique identification of the profile

Chapter 6: Device Management

405

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Page Numeric Page number of the search result

PageSize Numeric Number of profile details shown on each page

Total Numeric Total number of profiles on the device

Chapter 6: Device Management

406

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Enrollment User Details of the Device

Functionality – Retrieves the details of the enrollment user associated to the device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/user

You can obtain the device enrollment user details using the following parameter:

lAlternate Device Id – https://host/api/mdm/devices/user?searchby={searchby}&id={id}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, IMEI number)

id id of the device for which remote control action needs to be initiated

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/user

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/user

lUDID – https://host/api/mdm/devices/UDID/{UDID}/user

Response Payload

XML

<Id>Numeric</Id>

<UserName>String</UserName>

<FirstName>String</FirstName>

<LastName>String</LastName>

<Status>Boolean</Status>

<Email>String</Email>

<SecurityType>String</SecurityType>

<ContactNumber>String</ContactNumber>

<Group>String</Group>

<LocationGroupId>String</LocationGroupId>

<Role>String</Role>

<MessageType>String</MessageType>

<EmailUserName>String</EmailUserName>

<EnrolledDevicesCount>String</EnrolledDevicesCount>

<ExternalId>String</ExternalId>

</DeviceUser>

</DeviceUserSearchResult>

Chapter 6: Device Management

407

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"DeviceUser":{"Id": Numeric,

"UserName":" String ",

"FirstName":" String ",

"LastName":" String ",

"Status": Boolean,

"Email":" String ",

"SecurityType": String,

"ContactNumber":" String ",

"Group":" String ",

"Role":" String ",

"MessageType": String,

"EmailUserName" : "String",

"EnrolledDevicesCount":"String",

"LocationGroupId" : "String",

"ExternalId" : "String"

}

Response Tag Details

Tag Type Description

DeviceUser Id Numeric Unique identification associated with the enrollment user

UserName String Username of the enrollment user

Status Boolean Denotes if the user is active. Values include True or False

Email String Email of the enrollment user

SecurityType String/Numeric Security type of the enrollment User. In XML payload, you can pass

String values ("Basic" for a basic enrollment User, and "Directory" for

a directory enrollment user) and Numeric values (1for directory

enrollment users and 2for Basic enrollment users). For JSON payload,

you can pass only Numeric values.

ContactNumber String Contact number of the enrollment user

Group String Unique identification of the Organization Group associated with the

enrollment user

Role String Role of the enrollment user

MessageType String The type of message. Values include Email, SMS, None

EnrolledDevicesCount String Number of devices enrolled to the user

EmailUserName String Email username of the enrollment user

Group String Group of the enrollment user

ExternalId String Track Id of the device enrollment user

Chapter 6: Device Management

408

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Enrolled Device Count

Functionality – Retrieves count of all enrolled devices based on any or all of the OG ids, tag names, and devices

registered after 'SeenSince' datetime until the 'SeenTill' datetime.

HTTP Method – POST

API URI – https://host/api/mdm/devices/enrolleddevicescount

Request Payload

XML

<DeviceCountFilterCriteriaRequestModel

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Id>Numeric</Id>

<OrganizationGroupId>String</OrganizationGroupId>

<TagName>String</TagName>

<DeviceSeenSince>String</DeviceSeenSince>

<DeviceSeenTill>String</DeviceSeenTill>

<Value>Numeric</Value>

</LocationGroupId>

</DeviceCountFilterCriteriaRequestModel>

JSON

{

"OrganizationGroupId" : "String",

"TagName" : "String",

"DeviceSeenSince" : "String",

"DeviceSeenTill" : "String",

"id" : Numeric

}

Request Tag Details

Tag Mandatory Description

OrganizationGroupId Yes Unique identifier of the organization group the device is enrolled to

TagName Yes Desired unique name of the device tag

DeviceSeenSince No Devices seen after the seensince datetime will be returned if present

DeviceSeenTill No Devices seen till the seentill datetime will be returned if present

Chapter 6: Device Management

409

VMware AirWatch REST API Guide | v.2016.04 | April 2017

id Yes Unique identifier of the device

Response Payload

XML

<DeviceCountFilterCriteriaResponseModel

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/servicemodel/resources">

<Id>Numeric</Id>

<DevicesCount>Numeric</DevicesCount>

</DeviceCountFilterCriteriaResponseModel>

JSON

{

"DevicesCount" : Numeric,

"id" : Numeric

}

Response Tag Details

Tag Type Description

DevicesCount Numeric Number of enrolled devices

id Numeric Unique identifier of the device

Chapter 6: Device Management

410

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Smart Group details

Functionality – Retrieves the smart group details created in an organization group.

HTTP Method – GET

API URI – https://host/api/mdm/smartgroups/{id}

Request Body – NA

Response Payload

XML

<Name>String</Name>

<Devices>Numeric</Devices>

<Assignments>Numeric</Assignments>

<Exclusions>Numeric</Exclusions>

<Name>String</Name>

<SmartGroupID>Numeric</SmartGroupID>

<CriteriaType>String</CriteriaType>

<ManagedByOrganizationGroupId>Numeric</ManagedByOrganizationGroupId>

<Name>String</Name>

<Id>Numeric</Id>

</OrganizationGroup>

</OrganizationGroups>

<Name>String</Name>

<Id>Numeric</Id>

</UserGroup>

</UserGroups>

<Tags>

<Tag>

<Id>String</Id>

</Tag>

</Tags>

<string>String</string>

</Ownerships>

<string>String</string>

</Platforms>

<string>String</string>

</Models>

Chapter 6: Device Management

411

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<DeviceType>String</DeviceType>

<Operator>String</Operator>

<Value>String</Value>

</OperatingSystem>

</OperatingSystems>

<User>

<Id>Numeric</Id>

<Name>String</Name>

</User>

</UserAdditions>

<Id>Numeric</Id>

<Name>String/Name>

</Device>

</DeviceAdditions>

<User>

<Id>Numeric</Id>

<Name>String</Name>

</User>

</UserExclusions>

<Id>Numeric</Id>

<Name>String</Name>

</Device>

</DeviceExclusions>

</SmartGroup>

JSON

{

"Name" : "String",

"Devices":Numeric,

"Exclusions":Numeric,

"Assignments":Numeric,

"SmartGroupID":Numeric,

"CriteriaType" : "String",

"ManagedByOrganizationGroupId":Numeric,

"OrganizationGroups":[{

"Name":"String",

"Id":Numeric

}],

"UserGroups":[{

"Name":"String",

"Id":Numeric

Chapter 6: Device Management

412

VMware AirWatch REST API Guide | v.2016.04 | April 2017

}],

"Ownerships":["String"],

"Platforms":["String"],

"Models":["String"],

"OperatingSystems":[{

"DeviceType":"String",

"Operator":"String",

"Value":"String"

}],

"Tags":[{

"Id":"String",

}],

"UserAdditions":[{

"Id":Numeric

"Name":"String"

}],

"DeviceAdditions":[{

"Id":Numeric,

"Name":"String"

}],

"UserExclusions":[{

"Id":Numeric,

"Name":"String"

}],

"DeviceExclusions":[{

"Id":Numeric,

"Name":"String"

}]

}

Response Tag Details

Tag Type Description

Name String Unique name of the smart group

Devices Numeric Number of devices filtered by the smart group

Exclusions Numeric Number of devices that are excluded from the smart group’s list

of devices

Assignments Numeric Number of application assignments made to the smart group

CriteriaType String Unique smart group type configured to the smart group

SmartGroupID Numeric Unique numeric ID of the smart group

ManagedByOrganizationGroupId Numeric Unique identification of the organization group where the smart

group is managed

ManagedByOrganizationGroupName String Name of the organization group where the smart group is

managed

Chapter 6: Device Management

413

VMware AirWatch REST API Guide | v.2016.04 | April 2017

OrganizationGroups Id Numeric Unique identification of the organization group from which

devices are filtered

UserGroups Id Numeric Unique identification of the user groups assigned to the smart

group

Ownerships String The ownership type of the devices

Platforms String The platform of the device. Refer Tables for complete list of

device platforms

Models String The model of the device. Refer Tables for complete list of device

models

OperatingSystems DeviceType String The platform of the device. Refer Tables for complete list of

device platforms

OperatingSystems Operator String Operator applied to the operating system value. Allowed values

are "Equals", "GreaterThan", "LessThan",

"GreaterThanOrEqualTo", and "LessThanOrEqualTo"

OperatingSystems Value String The value of the operating system. Refer Tables for the complete

list of operating systems

UserAdditions Id Numeric Unique identification of the enrollment users whose devices

need to be added to the smart group in addition to the devices

added by the smart group filters

UserAdditions Name String Name of the enrollment users whose devices need to be added

to the smart group in addition to the devices added by the smart

group filters

DeviceAdditions Id Numeric Unique identification of the devices that need to be added to the

smart group in addition to the devices added by the smart group

filters

DeviceAdditions Name String The friendly name of the devices that need to be added to the

smart group in addition to the devices added by the smart group

filters

UserExclusions Id Numeric Unique identification of the enrollment users whose devices

need to be removed from the smart group device list

UserExclusions Name String The name of the enrollment users whose devices need to be

removed from the smart group device list

DeviceExclusions Id Numeric ID of the devices that need to be removed from the smart group

device list

DeviceExclusions Name String Friendly name of the devices that need to be removed from the

smart group device list

Chapter 6: Device Management

414

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Device Associated Smart Groups

Functionality – Retrieves all the smart groups associated with the device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/smartgroups

URI Parameters

Tag Type Description

id Numeric Unique device identifier

Request Payload – NA

Response Payload

XML

<DeviceSmartGroups xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/servicemodel/resources">

<SmartGroupId>Numeric</SmartGroupId>

<SmartGroupName>String</SmartGroupName>

</SmartGroup>

</DeviceSmartGroups>

JSON

{

"SmartGroup" : [

{

"SmartGroupId" : {

"Value" : Numeric

"SmartGroupName" : "String"

}

]

}

Chapter 6: Device Management

415

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Tag Details

Tag Type Description

Value Numeric The numeric value of the smart group identifier

SmartGroupName String The smart group name

Chapter 6: Device Management

416

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Security Information

Functionality – Retrieves the security information of the device identified by device ID.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/security

The user can retrieve security information of the device using the following parameter:

lAlternate Device Id – https://host/api/mdm/devices/security?searchby={searchby}&id={id}

oPattern (Contains) Match Parameter – searchby, id

URI Parameters

Tag Type Description

searchBy String The alternate id type [Macaddress, Udid, Serialnumber, ImeiNumber]

id String Device alternate id

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/security

lSerial Number –https://host/api/mdm/devices/serialnumber/{serialnumber}/security

lUDID – https://host/api/mdm/devices/udid/{udid}/security

Request Body – NA

Response Payload

XML

<IsCompromised xmlns="http://www.air-

watch.com/servicemodel/resources">Boolean</IsCompromised>

<DataProtectionEnabled xmlns="http://www.air-

watch.com/servicemodel/resources">Boolean</DataProtectionEnabled>

<BlockLevelEncryption xmlns="http://www.air-

watch.com/servicemodel/resources">Boolean</BlockLevelEncryption>

<FileLevelEncryption xmlns="http://www.air-

watch.com/servicemodel/resources">Boolean</FileLevelEncryption>

<IsPasscodePresent xmlns="http://www.air-

watch.com/servicemodel/resources">Boolean</IsPasscodePresent>

<IsPasscodeCompliant xmlns="http://www.air-

watch.com/servicemodel/resources">Boolean</IsPasscodeCompliant>

</DeviceSecurityInfo>

Chapter 6: Device Management

417

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"IsCompromised":Boolean,

"DataProtectionEnabled":Boolean,

"BlockLevelEncryption":Boolean,

"FileLevelEncryption":Boolean,

"IsPasscodePresent":Boolean,

"IsPasscodeCompliant":Boolean

}

Response Tag Details

Tag Type Description

IsCompromised Boolean Indicates if the device is compromised

DataProtectionEnabled Boolean Indicates if Data Protection is Enabled on the device

BlockLevelEncryption Boolean Indicates if Block Level encryption is enabled on the device

FileLevelEncryption Boolean Indicates if File Level encryption is enabled on the device

IsPasscodePresent Boolean Indicates if Passcode is present on the device

IsPasscodeCompliant Boolean Indicates if the devices complies to the passcode compliance policy

Chapter 6: Device Management

418

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Change Device Passcode (*Refactored)

Functionality – Changes the passcode of device which is used for unlocking it.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/changepasscode. This URI will be deprecated soon. Start

using the *Supported API URI .

*Supported API URI – https://host/api/mdm/devices/commands/id/changepasscode (HTTP Method Used – POST)

You can also change the device passcode using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/commands/changepasscode?searchby={searchBy}&id=

{id}

URL Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id Device identifier for which passcode needs to be changed

passcode New passcode value which needs to be set in the device

deviceid The alternate id

Response Obtained – NA

Request Payload

XML

<Passcode>String</Passcode>

</DevicePasscode>

JSON

{

"Passcode":"String"

}

Request Tag Details

Tag Mandatory Description

Passcode No New passcode value which needs to be set in the device

Chapter 6: Device Management

419

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Clear Passcode on the Device (*Refactored)

Functionality – Clears passcode of the device.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/clearpasscode. This URI will be deprecated soon. Start using

the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/{deviceid}/commands (HTTP Method Used – POST)

URI Parameters

Tag Description

deviceid AirWatch Device Id

command The command to execute [Lock, EnterpriseWipe, DeviceWipe, DeviceQuery,

ClearPasscode, SyncDevice, StopAirPlay].

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/clearpasscode

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/clearpasscode

lUDID – https://host/api/mdm/devices/UDID/{UDID}/clearpasscode

Request Body – NA

Response Obtained – NA

Chapter 6: Device Management

420

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Enterprise Wipe a Device (*Refactored)

Functionality – Sends an Enterprise Wipe command to the device identified by device ID.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/enterprisewipe. This URI will be deprecated soon. Start using

the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/deviceid/commands (HTTP Method Used – POST)

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/enterprisewipe

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/enterprisewipe

lUDID – https://host/api/mdm/devices/UDID/{UDID}/enterprisewipe

Response Obtained – NA

Request payload – NA

Chapter 6: Device Management

421

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Enterprise Wipe in Bulk (*Refactored)

Functionality – Sends an Enterprise Wipe command to multiple devices identified by device ID and alternate id.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/enterprisewipe. This URI will be deprecated soon. Start using the

*Supported API URI.

*Supported API URI – https://host/api/mdm/devices/commands/enterprisewipe (HTTP Method Used – POST)

You can enterprise wipe bulk devices using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/commands/enterprisewipe?searchby=deviceid

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, IMEI number)

id id of the device for which remote control action needs to be initiated

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/enterprisewipe

lSerial Number – https://host/api/mdm/devices/serialnumber/enterprisewipe

lUDID – https://host/api/mdm/devices/UDID/enterprisewipe

Request Payload

XML

<Value>Numeric</Value>

</BulkValues>

</BulkInput>

JSON

{

"BulkValues":{"value": [Numeric,Numeric]}

}

Chapter 6: Device Management

422

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

Value Yes (at least 1) Desired device parameter. "DeviceID","MAC Address", "Serial Number"

or "UDID"

Chapter 6: Device Management

423

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Find Device (*Refactored)

Functionality – Sends a Find Device command to the device.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/finddevice. This URI will be deprecated soon. Start using the

*Supported API URI.

*Supported API URI – https://host/api/mdm/devices/deviceid/commands/finddevice (HTTP Method Used – POST)

You can also find a device using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/commands/finddevice?searchby={searchby}&id={id}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id The alternate ID

finddevice The find device request

deviceid AirWatch Device Id

Response Obtained – NA

Request Payload

XML

<Platform>String</Platform>

<Application>String</Application>

<Message>String</Message>

<NumberOfRepetitions>Numeric</NumberOfRepetitions>

<GapBetweenRepetitions>Numeric</GapBetweenRepetitions>

</FindDevice>

JSON

{

"Platform":"String",

"Application":"String",

"Message":" String",

"NumberOfRepetitions":Numeric,

"GapBetweenRepetitions":Numeric

Chapter 6: Device Management

424

VMware AirWatch REST API Guide | v.2016.04 | April 2017

}

Request Tag Details

Tag Mandatory Description

Platform Yes The device platform. For example, Apple, Android etc.

Application Yes The command is sent to the AirWatch Agent

Message Yes Desired message to be sent to the device

NumberOfRepetitions Yes Desired message to be sent to the device

GapBetweenRepetitions Yes Gap between each repetition of the beep

Chapter 6: Device Management

425

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Lock Device (*Refactored)

Functionality – Sends a Lock Device command to the device identified by device ID.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/lockdevice. This URI will be deprecated soon. Start using the

*Supported API URI.

*Supported API URI – https://host/api/mdm/devices/deviceid/commands

URI Parameters

Tag Description

id device id

command The command to execute [Lock, EnterpriseWipe, DeviceWipe, DeviceQuery,

ClearPasscode, SyncDevice, StopAirPlay].

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/lockdevice

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/lockdevice

lUDID – https://host/api/mdm/devices/UDID/{UDID}/lockdevice

Request Body – NA

Response Obtained – NA

Chapter 6: Device Management

426

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Lock Devices in Bulk (*Refactored)

Functionality – Locks a list of devices.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/lockdevice. This URI will be deprecated soon. Start using the

*Supported API URI.

*Supported API URI – https://host/api/mdm/devices/{deviceid}/commands

URI Parameters

Tag Description

id Alternate id

command The command to execute (lock, enterpriseWipe, devicewipe, devicequery,

clearpasscode, syncDevice, stopAirPlay)

Searchby The alternate id type (macaddress, Udid, serialnumber, imeinumber)

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/lockdevice

lSerial Number – https://host/api/mdm/devices/serialnumber/lockdevice

lUDID – https://host/api/mdm/devices/UDID/lockdevice

Request Payload

XML

<Value>Numeric</Value>

</BulkValues>

</BulkInput>

JSON

{

"BulkValues":{"value": [Numeric,Numeric]}

}

Chapter 6: Device Management

427

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

Value Yes(at least 1) Desired device parameter. "DeviceID","MAC Address", "Serial Number"

or "UDID"

Response Payload

XML

<BulkResponse xmlns="http://www.air-

watch.com/servicemodel/resources"xmlns:xsd="http://www.w3.org/2001/XMLSchem

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<TotalItems>Numeric</TotalItems>

<AcceptedItems>Numeric</AcceptedItems>

<FailedItems>Numeric</FailedItems>

<ActivityId>String</ActivityId>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>Numeric</ItemValue>

<Message>String</Message>

</Fault>

</Faults>

</BulkResponse>

JSON

{

"TotalItems": Numeric,

"AcceptedItems": Numeric,

"FailedItems": Numeric,

"Faults": {

"Fault": [

{

"ErrorCode": Numeric,

"ItemValue": Numeric,

"Message": "String"

}]

}

Chapter 6: Device Management

428

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Tag Details

Tag Type Description

TotalItems Numeric Total number of device parameters sent in the request

AcceptedItems Numeric Number of devices to which the lock command was successfully sent

FailedItems Numeric Number of devices that could not be locked

Faults Array Array of the "Fault" tag describing each detail of each failed instance

ErrorCode Numeric HTTP status code for the failed element

Message String Reason for the device not being locked

Chapter 6: Device Management

429

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Query Device (*Refactored)

Functionality – Sends a Query Device command to the device identified by device ID.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/query. This URI will be deprecated soon. Start using the

*Supported API URI.

*Supported API URI – https://host/api/mdm/devices/deviceid/commands

URI Parameters

Tag Description

id Device Id

command The command to execute [Lock, EnterpriseWipe, DeviceWipe, DeviceQuery,

ClearPasscode, SyncDevice, StopAirPlay].

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/query

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/query

lUDID – https://host/api/mdm/devices/UDID/{UDID}/query

lIMEI Number – https://host/api/mdm/devices/imeinumber/{imei}/query

Request Body – NA

Response Obtained – NA

Chapter 6: Device Management

430

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Device Wipe (*Refactored)

Functionality – Sends a Device Wipe command to the device identified by device ID.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/devicewipe. This URI will be deprecated soon. Start using the

*Supported API URI.

*Supported API URI – https://host/api/mdm/devices/deviceid/commands

URI Parameters

Tag Description

id AirWatch Device Id

command The command to execute [Lock, EnterpriseWipe, DeviceWipe, DeviceQuery,

ClearPasscode, SyncDevice, StopAirPlay].

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/devicewipe

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/devicewipe

lUDID – https://host/api/mdm/devices/UDID/{UDID}/devicewipe

Response Obtained – NA

Request payload – NA

Chapter 6: Device Management

431

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Device

Functionality – Deletes the device information from the AirWatch Console and un-enrolls the device.

HTTP Method – DELETE

API URI – https://host/api/mdm/devices/{id}

You can delete a device using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices?searchby={searchby}&id={id}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id The alternate id of the device

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}

lUDID – https://host/api/mdm/devices/UDID/{UDID}

Response Obtained – NA

Request payload – NA

Chapter 6: Device Management

432

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Devices in Bulk (*Refactored)

Functionality – Deletes multiple devices identified by device ID or alternate ID.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/delete. This URI will be deprecated soon. Start using the

*Supported API URI.

*Supported API URI – https://host/api/mdm/devices/bulk?searchby={searchby}

URI Parameters

Tag Description

searchby OPTIONAL. The alternate id type [Macaddress, Udid, Serialnumber, ImeiNumber] If

not included, device id is used.

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/delete

lSerial Number – https://host/api/mdm/devices/serialnumber/delete

lUDID – https://host/api/mdm/devices/UDID/delete

Request Payload

XML

<Value>Numeric</Value>

</BulkValues>

</BulkInput>

JSON

{

"BulkValues":{"value": [Numeric,Numeric]}

}

Request Tag Details

Tag Mandatory Description

Chapter 6: Device Management

433

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Value Yes(at least 1) Desired device parameter. "DeviceID","MAC Address", "Serial Number"

or "UDID"

Response Payload

XML

<BulkResponse xmlns="http://www.air-

watch.com/servicemodel/resources"xmlns:xsd="http://www.w3.org/2001/XMLSchem

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<TotalItems>Numeric</TotalItems>

<AcceptedItems>Numeric</AcceptedItems>

<FailedItems>Numeric</FailedItems>

<ActivityId>String</ActivityId>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>Numeric</ItemValue>

<Message>String</Message>

</Fault>

</Faults>

</BulkResponse>

JSON

{

"TotalItems": Numeric,

"AcceptedItems": Numeric,

"FailedItems": Numeric,

"Faults": {

"Fault": [

{

"ErrorCode": Numeric,

"ItemValue": Numeric,

"Message": "String"

}]

}

Response Tag Details

Tag Type Description

Chapter 6: Device Management

434

VMware AirWatch REST API Guide | v.2016.04 | April 2017

TotalItems Numeric Total number of device parameters sent in the request

AcceptedItems Numeric Number of devices to which delete command was successfully sent

FailedItems Numeric Number of devices that could not be deleted

Faults Array Array of the "Fault" tag describing each detail of each failed instance

ErrorCode Numeric HTTP status code for the failed element

Message String Reason for the device for not being deleted

Chapter 6: Device Management

435

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Sync Device (*Refactored)

Functionality – Sends a Device Sync command to the device identified by device ID.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/syncdevice. This URI will be deprecated soon. Start using the

*Supported API URI.

*Supported API URI – https://host/api/mdm/devices/deviceid/commands

URI Parameters

Tag Description

id device id

command The command to execute [Lock, EnterpriseWipe, DeviceWipe, DeviceQuery,

ClearPasscode, SyncDevice, StopAirPlay].

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/syncdevice

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/syncdevice

lUDID – https://host/api/mdm/devices/UDID/{UDID}/syncdevice

Request – NA

Response Obtained – NA

Chapter 6: Device Management

436

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Send Email to the Device Enrollment User (*Refactored)

Functionality – Sends an email to the device enrollment user.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/sendmessage/email. This URI will be deprecated soon. Start

using the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/{id}/messages/email (HTTP Method Used – POST)

The user can also send an email to the enrollment user using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/messages/email?searchby={searchby}&id={id}

Deprecated API URIs:

lSerial Number – https://host/api/mdm/devices/serialnumber/{serialnumber}/sendmessage/email

lUDID – https://host/api/mdm/devices/udid/{udid}/sendmessage/email

lMac address – https://host/api/mdm/devices/macaddress/{macaddress}/sendmessage/email

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id The alternate ID of the device

email The email to send

Response Obtained – NA

Note: To make any email related API calls, it is necessary to have SMTP permissions set on the API server.

Request Payload

XML

<MessageBody>String</MessageBody>

<ToAddress>String</ToAddress>

<Subject>String</Subject>

</Email>

Chapter 6: Device Management

437

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"MessageBody":"String",

"ToAddress":"String",

"Subject":"String"

}

Request Tag Details

Tag Mandatory Description

MessageBody No The content of the message

ToAddress Yes The recipients email address

Subject No The subject of the email

Chapter 6: Device Management

438

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Send Email in Bulk (*Refactored)

Functionality – Sends the desired email to devices identified by devices ID.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/sendmessage/email. This URI will be deprecated soon. Start using

the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/messages/bulkemail?searchby={searchby} (HTTP Method Used –

POST)

Deprecated API URIs:

lSerial Number – https://host/api/devices/serialnumber/sendmessage/email

lUDID – https://host/api/devices/udid/sendmessage/email

lMac address – https://host/api/devices/macaddress/sendmessage/email

URI Parameters

Tag Description

searchby The id type (Macaddress, Udid, Serialnumber, ImeiNumber, Deviceid)

Response Obtained – NA

Note: To make any email related API calls, it is necessary to have SMTP permissions set on the API server.

Request Payload

XML

<MessageBody>String</MessageBody>

<ToAddress>Text value</ToAddress>

<Subject>String</Subject>

<Value>Numeric</Value>

</BulkValues>

</EmailMessage>

Chapter 6: Device Management

439

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"MessageBody":"String",

"ToAddress": "String",

"Subject":"String",

"BulkValues":{"value": "String","String"}

}

Request Tag Details

Tag Mandatory Description

MessageBody Yes The content of the message

Subject Yes Subject of the email

Value Yes(at least 1) Desired device parameter. "DeviceID","MAC Address", "Serial Number"

or "UDID"

Chapter 6: Device Management

440

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Send SMS to the Device (*Refactored)

Functionality – Sends the SMS to the device enrollment user.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/sendmessage/sms. This URI will be deprecated soon. Start

using the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/id/messages/sms (HTTP Method Used – POST)

The user can send SMS to a device using the following parameters:

lAlternate device ID type – https://host/api/mdm/devices/messages/sms?searchby={searchby}&id={id}

Deprecated API URIS:

lSerial Number – https://host/api/mdm/devices/serialnumber/{serialnumber}/sendmessage/sms

lUDID – https://host/api/mdm/devices/udid/{udid}/sendmessage/sms

lMac address – https://host/api/mdm/devices/macaddress/{macaddress}/sendmessage/sms

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id The alternate ID of the device

sms The SMS message to send

Response Obtained – NA

Request Payload

XML

<MessageBody>String</MessageBody>

<PhoneNumber>String</PhoneNumber>

</Sms>

Important: When the Phone Number tag is not specified the mobile number of the device is used to send the SMS.

Chapter 6: Device Management

441

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"MessageBody":"String",

"PhoneNumber":"String"

}

Request Tag Details

Tag Mandatory Description

MessageBody Yes The content of the message to be sent to the device

PhoneNumber No Phone number of the device

Chapter 6: Device Management

442

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Send SMS in Bulk (*Refactored)

Functionality – Sends the SMS to a list of devices.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/sendmessage/sms. This URI will be deprecated soon. Start using

the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/messages/bulksms?searchby=deviceid (HTTP Method Used –

POST)

Deprecated API URIs:

lSerial Number – https://host/api/mdm/devices/serialnumber/sendmessage/sms

lUDID – https://host/api/mdm/devices/udid/sendmessage/sms

lMac address – https://host/api/mdm/devices/macaddress/sendmessage/sms

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

Response Obtained – NA

Request Payload

XML

<MessageBody>String</MessageBody>

<PhoneNumber>String</PhoneNumber>

<Value>Numeric</Value>

</BulkValues>

</BulkInput>

JSON

{

"MessageBody":"String",

"PhoneNumber":"String",

"BulkValues":{"value": "String", "String"}

}

Chapter 6: Device Management

443

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

MessageBody Yes Content of the message to be sent to the devices

Application Yes Application to which the push message needs to be sent. For

example,AirWatch Agent

Value Yes (at least 1) Desired device parameter. For example, "DeviceID", "MAC Address",

"Serial Number", "IMEI Number", or "UDID"

Chapter 6: Device Management

444

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Send Push Message to the Device (*Refactored)

Functionality – Sends a push message from the AirWatch Console to the device.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/sendmessage

This URI will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/messages/commands/id/message (HTTP Method Used – POST)

You can also send push notification to a device using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/messages/push?searchby={searchby}&id={id}

Deprecated API URIs:

lSerial Number – https://host/api/mdm/devices/serialnumber/{serialnumber}/sendmessage/push

lUDID – https://host/api/mdm/devices/udid/{udid}/sendmessage/push

lMac address – https://host/api/mdm/devices/macaddress/{macaddress}/sendmessage/push

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id The alternate ID of the device

Response Obtained – NA

Request Payload

XML

<MessageBody>String</MessageBody>

<MessageType>String><MessageType>

<Application>String</Application>

</GenericMessage>

JSON

{

"MessageBody":"String",

"MessageType":"String",

"Application":"String"

Chapter 6: Device Management

445

VMware AirWatch REST API Guide | v.2016.04 | April 2017

}

Request Tag Details

Tag Mandatory Description

MessageBody Yes Content of the message to send to the device

Application Yes Application to which the notification is pushed (AirWatch Agent,

AirWatch Content Locker)

MessageType Yes Type of the message (Email, SMS. and Push)

Chapter 6: Device Management

446

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Bulk Push Message to the Devices (*Refactored)

Functionality – Sends the desired push notifications to a list of devices.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/sendmessage/push. This URI will be deprecated soon. Start using

the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/messages/bulkpush?searchby={searchby} (HTTP Method Used –

POST)

Deprecated API URIs:

lSerial Number – https://host/api/devices/serialnumber/sendmessage/push

lUDID – https://host/api/devices/udid/sendmessage/push

lMac address – https://host/api/devices/macaddress/sendmessage/push

URIParameters

Tag Description

searchby The id type (Macaddress, Udid, Serialnumber, ImeiNumber, DeviceId)

Request Payload

XML

<PushNotificationMessage xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns="http://www.air-watch.com/servicemodel/resources">

<MessageBody>String</MessageBody>

<MessageType>String><MessageType>

<Application>String</Application>

<Value>Numeric</Value>

</BulkValues>

</PushNotificationMessage>

JSON

{

"MessageBody":"String",

"Application":"String",

"MessageType":"String",

Chapter 6: Device Management

447

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"BulkValues":{"value":[

"String",

"String"

]

}

Request Tag Details

Tag Mandatory Description

MessageBody Yes The content of the message to send to the devices

Application Yes Application to which the push message needs to be sent. Example,

AirWatch Agent

Value Yes (at least 1) Desired device parameter. "DeviceID", "MAC Address", "Serial

Number", "IMEI Number" or "UDID"

Chapter 6: Device Management

448

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Push Notification (*Refactored)

Functionality – Sends a push notification to the device identified by device ID. If not enrolled, sends an SMS message

instead.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/sendmessage. This URI will be deprecated soon. Start using

the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/messages/{id}/message (HTTP Method Used – POST)

You can also send push notification using the following parameter:

lAlternate device Id – https://host/api/mdm/devices/messages/message?searchby={searchby}&id={id}

URI Parameters

Tag Description

id The alternate device id

command The command to execute [Lock, EnterpriseWipe, DeviceWipe, DeviceQuery,

ClearPasscode, SyncDevice, StopAirPlay].

Searchby The alternate id type [DeviceId, Macaddress, Udid, Serialnumber].

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/sendmessage

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/sendmessage

lUDID – https://host/api/mdm/devices/UDID/{UDID}/sendmessage

Response Obtained – NA

Request Payload

XML

<MessageBody>String</MessageBody>

<MessageType>String</MessageType>

<ApplicationName>String</ApplicationName>

</GenericMessage>

Chapter 6: Device Management

449

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"MessageBody":"String",

"MessageType" : "String",

"ApplicationName":"String"

}

Request Tag Details

Tag Mandatory Description

MessageBody Yes Content of the message to be sent to the device

ApplicationName Yes Application name to which the push message needs to be sent. For

example - AirWatch Agent

MessageType Yes Type of the message

Chapter 6: Device Management

450

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Execute Device Commands

Functionality – Executes command for the device.

HTTP Method – POST

API URI – https://host/api/mdm/devices/{deviceid}/commands?command={command}

You can execute device commands using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/commands?command={command}&searchby=

{searchby}&id={id}

URI Parameters

Tag Description

command The command to execute (lock, unenroll, remotewipe, devicequery, clearpasscode,

syncdevice, enterpriseWipe, deviceWipe, stopAirplay, scheduleosupdate)

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber, Easid)

id The alternate id

Response Obtained – NA

Request Body – NA

Chapter 6: Device Management

451

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Execute Bulk Device Commands

Functionality – Executes command for device by alternate id.

HTTP Method – POST

API URI – https://host/api/mdm/devices/commands/bulk?command={command}&searchby={searchby}

URI Parameters

Tag Description

command The command to execute (enterpriseWipe, lockdevice, scheduleosupdate)

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

Request Payloads

XML

<Value>String</Value>

</BulkValues>

</BulkInput>

JSON

{

"BulkValues":{

"Value":["String"]

}

Request Tag Details

Tag Mandatory Description

Value Yes Unique ID of the newly created device command

Chapter 6: Device Management

452

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Payload

XML

<TotalItems>Numeric</TotalItems>

<AcceptedItems>Numeric</AcceptedItems>

<FailedItems>Numeric</FailedItems>

<ActivityId>String</ActivityId>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

</Faults>

</BulkResponse>

JSON

{

"AcceptedItems":Numeric,

"FailedItems":Numeric,

"Faults":{

"Fault":[{

"ErrorCode":Numeric,

"ItemValue":"String",

"Message":"String"

}]

"TotalItems":Numeric

}

Response Tag Details

Tag Type Description

AcceptedItems Numeric Number of commands successfully executed

FailedItems Numeric Number of commands that are not executed

Fault Numeric XML/JSON block providing the details of the commands that could not

be executed

Message String Reason for the commands for not being executed

TotalItems Numeric Total number of commands sent in the request

Chapter 6: Device Management

453

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Schedule OS Update Command

Functionality – Executes the schedule Os update command on specified iOS device which is supervised, DEP, and has

version >= 9.

HTTP Method – POST

API URI – https://host/api/mdm/devices/commands/scheduleosupdate?searchby={searchBy}&id={id}&installaction=

{installAction}

URI Parameters

Tag Description

id The alternate id

searchby The alternate id type (macaddress, udid, serialnumber, imeiNumber, easId,

deviceId)

installaction The install action type [default, downloadOnly, installASAP]

Response Obtained – NA

Request Body – NA

Chapter 6: Device Management

454

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Bulk Schedule OS Update Command

Functionality – Executes the Schedule Os Update command on list of iOS devices which are supervised, DEP and has

version >= 9.

HTTP Method – POST

API URI – https://host/api/mdm/devices/commands/bulk/scheduleosupdate?searchby={searchBy}&installaction=

{installAction}

URI Parameters

Tag Description

searchby The alternate id type (macaddress, udid, serialnumber, imeiNumber, easId,

deviceId)

installaction Install action type (default, downloadOnly, installASAP)

Request Payload

XML

<BulkInput xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/servicemodel/resources">

<Value>String</Value>

</BulkValues>

</BulkInput>

JSON

{

"BulkValues" : {

"Value" : [

"String",

"String"

]

}

Chapter 6: Device Management

455

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

Value Yes Unique ID of the newly created device command

Response Payload

XML

<BulkResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/servicemodel/resources">

<TotalItems>Numeric</TotalItems>

<AcceptedItems>Numeric</AcceptedItems>

<FailedItems>Numeric</FailedItems>

<ActivityId>String</ActivityId>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

</Faults>

</BulkResponse>

JSON

{

"TotalItems" : Numeric,

"AcceptedItems" : Numeric,

"FailedItems" : Numeric,

"Faults" : {

"Fault" : [

{

"ErrorCode" : Numeric,

"ItemValue" : "String",

"Message" : "String"

{

"ErrorCode" : Numeric,

"ItemValue" : "String",

Chapter 6: Device Management

456

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"Message" : "String"

}

]

}

Response Tag Details

Tag Type Description

AcceptedItems Numeric Number of commands successfully executed

FailedItems Numeric Number of commands that are not executed

Fault Numeric XML/JSON block providing the details of the commands that could not

be executed

Message String Reason for the commands for not being executed

TotalItems Numeric Total number of commands sent in the request

Chapter 6: Device Management

457

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Start Airplay

Functionality – Executes start airplay for a specific device.

HTTP Method – POST

API URI – https://host/api/mdm/devices/{deviceid}/commands/startairplay

URI Parameters

Tag Description

device id The unique identification number of the device

Response Obtained – NA

Request Payload

XML

<StartAirPlay xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/servicemodel/resources">

<DestinationName>String</DestinationName>

<DestinationDeviceId>String</DestinationDeviceId>

<Passcode>String</Passcode>

<Scantime>String</Scantime>

</StartAirPlay>

JSON

{

"DestinationName" : "String",

"DestinationDeviceId" : "String",

"Passcode" : "String",

"Scantime" : "String"

}

Chapter 6: Device Management

458

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

DestinationName Yes Name of the destination device

DestinationDeviceId Yes Unique identification number of the destination device

Passcode Yes Passcode of the device

Scantime Yes Scantime to perform airplay

Chapter 6: Device Management

459

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Send Remote Control Action Command (*Refactored)

Functionality – Initiates the remote control action for the device identified by device ID, by sending the command string

to Device-Agent through AWCM.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{id}/remotecontrol. This URI will be deprecated soon. Start using

the *Supported API URI .

*Supported API URI – https://host/api/mdm/devices/commands/remotecontrol (HTTP Method Used – POST)

You can also send remote action command to devices using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/commands/remotecontrol?searchby={searchby}&id={id}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, IMEI number)

id id of the device for which remote control action needs to be initiated

Deprecated API URI:

lMac address – https://host/api/mdm/devices/macaddress/{macaddress}/remotecontrol

lSerial Number – https://host/api/mdm/devices/serialnumber/{serialnumber}/remotecontrol

lUDID – https://host/api/mdm/devices/udid/{udid}/remotecontrol

Request Payload – NA

Response Obtained – NA

Chapter 6: Device Management

460

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Add Note to the Device (*Refactored)

Functionality – Creates a note for the device identified by device ID.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{deviceid}/addnote. This URI will be deprecated soon. Start using

the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/{deviceId}/notes

The user can add notes to a device using the following parameter:

lAlternate Device id – https://host/api/mdm/devices/notes?searchby={searchby}&id={id}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id Device alternate id

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/addnote

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/addnote

lUDID – https://host/api/mdm/devices/UDID/{UDID}/addnote

Response Obtained – NA

Request Payload

XML

<DeviceId>Numeric </DeviceId>

<Note>String</Note>

</DeviceNotes>

JSON

{

"DeviceId": Numeric ,

"Note":" String "

}

Chapter 6: Device Management

461

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

DeviceId Yes Unique identification of the device

Note Yes Text of the note

Chapter 6: Device Management

462

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Note From the Device

Functionality – Deletes the specified note identified by its note ID from the device.

HTTP Method – DELETE

API URI – https://host/api/mdm/devices/{deviceid}/notes/{noteid}

The user can delete notes from the device using the following parameter:

lAlternate Device id – https://host/api/mdm/devices/notes/{noteid}?searchby={searchby}&id={id}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id Device alternate id

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/notes/{noteid}

lSerial Number –https://host/api/mdm/devices/serialnumber/{SerialNumber}/notes/{noteid}

lUDID – https://host/api/mdm/devices/UDID/{UDID}/notes/{noteid}

Request Body – NA

Response Obtained – NA

Chapter 6: Device Management

463

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Notes From the Device

Functionality – Retrieves details of all the notes from the device.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{id}/notes

The user can retrieve notes from the device using the following parameter:

lAlternate Device id – https://host/api/mdm/devices/notes?searchby={searchby}&id={id}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id Device alternate id

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/notes

lSerial Number – https://host/api/mdm/devices/serialnumber/{SerialNumber}/notes

lUDID – https://host/api/mdm/devices/UDID/{UDID}/notes

Request Body – NA

Response Payload

XML

<DeviceId>String<DeviceId>

<Id>Numeric</Id>

<DeviceId>Numeric</DeviceId>

<TagId>Numeric</TagId>

<Note>String</Note>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</DeviceNotes>

</DeviceNotesSearchResult>

Chapter 6: Device Management

464

VMware AirWatch REST API Guide | v.2016.04 | April 2017

JSON

{

"DeviceId":{ Numeric},

"DeviceNotes":[{

"Id": Numeric,

"DeviceId": Numeric,

"TagId": Numeric,

"Note":" String ",

"CreatedOn":" Datetime ",

"ModifiedOn":" Datetime "

}]

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique identification of the device

Id Numeric Unique identification of the note

TagId Numeric Unique identification of the tag associated with the note

Note String Text of the note

CreatedOn Datetime Time stamp of note creation

ModifiedOn Datetime Time stamp of last modified date of the note

Chapter 6: Device Management

465

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve a Specific Note From the Device

Functionality – Retrieves a particular note for the device identified by device ID.

HTTP Method – GET

API URI – https://host/api/mdm/devices/{deviceid}/notes/{noteid}

The user can retrieve a specific note from a device using the following parameter:

lAlternate Device id – https://host/api/mdm/devices/notes/{noteid}?searchby={searchby}&id={id}

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/notes/{noteid}

lSerial Number –https://host/api/mdm/devices/serialnumber/{serialnumber}/notes/{noteid}

lUDID – https://host/api/mdm/devices/udid/{udid}/notes/{noteid}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id Device alternate id

Request Body – NA

Response Payload

XML

<Id>Numeric</Id>

<DeviceId>Numeric</DeviceId>

<Note>String</Note>

<CreatedOn>Datetime</CreatedOn>

<ModifiedOn>Datetime</ModifiedOn>

</DeviceNotes>

JSON

{

"Id":Numeric,

"DeviceId":Numeric,

"Note":"String",

"CreatedOn":"Datetime",

Chapter 6: Device Management

466

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"ModifiedOn":"Datetime"

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique identification of the device

Id Numeric Unique identification of the note

Note String Text of the note

CreatedOn Datetime Time stamp of note creation

ModifiedOn Datetime Time stamp of last modified date of the note

Chapter 6: Device Management

467

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Note onto the Device (*Refactored)

Functionality – Updates details of the specified note on the device.

HTTP Method – POST

Deprecated API URI – https://host/api/mdm/devices/{deviceid}/notes/{noteid}/update. This URI will be deprecated

soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/{deviceId}/notes/{noteid} (HTTP Method Used – PUT)

You can also update notes on a device using the following parameter:

lAlternate Device id – https://host/api/mdm/devices/notes/{noteid}?searchby={searchby}&id={id}

URI Parameters

Tag Description

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id Device alternate id

Deprecated API URIs:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/notes/{noteid}/update

lSerial Number –https://host/api/mdm/devices/serialnumber/{SerialNumber}/notes/{noteid}/update

lUDID – https://host/api/mdm/devices/UDID/{UDID}/notes/{noteid}/update

Request Payload

XML

<Id>Numeric</Id>

<DeviceId>Numeric</DeviceId>

<Note>String</Note>

</DeviceNotes>

JSON

{

"DeviceId" : Numeric,

"Id" : Numeric,

"Note":"String"

}

Chapter 6: Device Management

468

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

Note Yes Text of the note

Id Yes Unique identifier of the note

DeviceId Yes Unique identifier of the device

Chapter 6: Device Management

469

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Device Details

Functionality – Searches for devices using the query information provided.

HTTP Method – GET

API URI – https://host/api/mdm/devices/search?user={user}&model={model}&platform={platform}&lastseen=

{lastseen}&ownership={ownership}&Igid={Igid}&compliantstatus={compliantstatus}&seensince={seensince}&page=

{page}&pagesize={pagesize}&orderby={orderby}&sortorder={sortorder}

lExact Match Parameter – model, platform, ownership, compliancestatus, sortorder

lPattern (Contains) Match Parameter – user, lastseen, Igid, seensince, page, pagesize, orderby

Request Body – NA

URI Parameters

Tag Type Description

user String Enrolled username

model String Device model

platform String Device platform

lastseen Datetime Last seen date string

ownership String Device ownership

Igid Integer Organization group to be searched, user's OG is considered if not sent

compliantstatus Boolean Complaint status

seensince Datetime Specifies the date filter for device search, which retrieves the devices

that are seen after this date

page Numeric Page number

pagesize Numeric Records per page

orderby String Order by column name

sortorder String Sorting order. Values ASC or DESC. Defaults to ASC.

Accepted DateTime formats: "yyyy/MM/dd", "yyyy-MM-dd", "MM/dd/yyyy", "MM-dd-yyyy", "yyyy/MM/dd

HH:mm:ss.fff", "yyyy-MM-dd HH:mm:ss.fff", "MM/dd/yyyy HH:mm:ss.fff", "MM-dd-yyyy HH:mm:ss.fff",

"yyyy/MM/ddTHH:mm:ss.fff", "yyyy-MM-ddTHH:mm:ss.fff", "MM/dd/yyyyTHH:mm:ss.fff", "MM-dd-

yyyyTHH:mm:ss.fff", "yyyy-MM-dd HH-mm-ss-tt"

Chapter 6: Device Management

470

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Payload

XML

<Page>Numeric</Page>

<PageSize >Numeric</PageSize>

<Total>Numeric</Total>

<Id>Numeric</Id>

<Udid>String</Udid>

<SerialNumber>String</SerialNumber>

<MacAddress>String</MacAddress>

<Imei>String</Imei>

<EasId>String</EasId>

<AssetNumber>String</AssetNumber>

<DeviceFriendlyName>String</DeviceFriendlyName>

<LocationGroupId>String</LocationGroupId>

<LocationGroupName>String</LocationGroupName>

<UserName>String</UserName>

<UserEmailAddress>String</UserEmailAddress>

<Ownership>String</Ownership>

<PlatformId title="String">String</PlatformId>

<Platform>String</Platform>

<ModelId title="String">String</ModelId>

<Model>String</Model>

<PhoneNumber>String</PhoneNumber>

<OperatingSystem>String</OperatingSystem>

<LastSeen>Datetime</LastSeen>

<EnrollmentStatus>String</EnrollmentStatus>

<ComplianceStatus>Boolean</ComplianceStatus>

<CompromisedStatus>Boolean</CompromisedStatus>

<LastEnrolledOn>Datetime</LastEnrolledOn>

<LastComplianceCheckOn>Datetime</LastComplianceCheckOn>

<LastCompromisedCheckOn>Datetime</LastCompromisedCheckOn>

<Id xmlns="">Numeric</Id>

<CompliantStatus>Boolean</CompliantStatus>

<PolicyName>String</PolicyName>

<PolicyDetail>String</PolicyDetail>

<LastComplianceCheck>Datetime</LastComplianceCheck>

<NextComplianceCheck>Datetime</NextComplianceCheck>

<ActionType>String</ActionType>

</ActionTaken>

<ActionType>String</ActionType>

</ActionTaken>

</DeviceCompliance>

Chapter 6: Device Management

471

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</ComplianceSummary>

<IsSupervised>Boolean</IsSupervised>

</Devices>

</Devices><DeviceSearchResult>

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"Devices":{

"Id":Numeric,

"Udid":"String",

"SerialNumber":"String",

"MacAddress":"String",

"Imei":"String",

"AssetNumber":"String",

"DeviceFriendlyName":"String",

"LocationGroupId":{

"LocationGroupName":"String",

"UserId":{

"UserName":"String",

"UserEmailAddress":"String",

"Ownership":"String",

"PlatformId":{

"Platform":"String",

"ModelId":{

"Model":"String",

"OperatingSystem":"String",

"PhoneNumber":"String",

"LastSeen":"Datetime",

"EasId":"String",

"EnrollmentStatus":"String",

"ComplianceStatus":"Boolean",

"CompromisedStatus":Boolean,

"LastEnrolledOn":"Datetime",

"LastComplianceCheckOn":"Datetime",

"LastCompromisedCheckOn":"Datetime",

"ComplianceSummary":[{

"Id":Numeric,

"CompliantStatus":Boolean,

"PolicyName":"String"

"PolicyDetail":"String",

Chapter 6: Device Management

472

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"LastComplianceCheck":"Datetime",

"NextComplianceCheck":"Datetime",

"ActionTaken":{

"ActionType":String

}

}],

"IsSupervised":Boolean

}

Response Tag Details

Tag Type Description

Id Numeric Unique identification number of the device

Udid String UDID of the device

SerialNumber String Serial number of the device

MacAddress String MAC address of the Device

Imei String IMEI number of the device

AssetNumber String Asset number of the device

DeviceFriendlyName String Friendly name assigned to the device

LocationGroupId String Unique identification of the organization group to which the device is

assigned

LocationGroupName String Name of the organization group to which the device is assigned

UserId String Id of the enrollment user to whom the device is assigned

UserName String Name of the enrollment user to whom the device is assigned

UserEmailAddress String Email address of the enrollment user

Ownership String Ownership type of the device. Values: Corporate-Shared, Corporate-

Dedicated, Employee Owned

PlatformId String Unique identification associated with the platform

Platform String Name of the device platform

ModelId String Unique identification associated with the model

Model String OEM model name

OperatingSystem String Version of the operating system on the model

PhoneNumber String Phone number of the device

LastSeen Datetime Last seen time stamp of the device

EnrollmentStatus String Current enrollment status of the device. Enrolled, Unenrolled etc

Chapter 6: Device Management

473

VMware AirWatch REST API Guide | v.2016.04 | April 2017

ComplianceStatus Boolean Overall compliance status of the device

CompromisedStatus Boolean Compromised status of the device. Values: True/False

LastEnrolledOn Datetime Time stamp of the last enrollment of the device

LastComplianceCheckOn Datetime Time stamp of the last compliance check

LastCompromisedCheckOn Datetime Time stamp of the last compromised status check

Id Numeric Unique identification of the device

CompliantStatus Boolean Compliance status of the device

PolicyName String Name of the compliance policy

PolicyDetail String Details of the compliance policy

LastComplianceCheck Datetime Time stamp of the last compliance check

NextComplianceCheck Datetime Scheduled time of the next compliance check

ActionTaken String Compliance policy action taken on the device

ActionType String Type of compliance action taken on the device

IsSupervised Boolean Specifies if the device is supervised or not

Page Numeric Page number of the search result

PageSize Numeric Number of profile details shown on each page

Total Numeric Total number of profiles on the device

C# Sample Code

using System;

using System.IO;

using System.Net;

using System.Text;

using System.Xml.Serialization;

namespace AirwatchApiClient

{

class Program

{

#region Constants

private const string USER_NAME = "UserName1";

private const string PASSWORD = "Password1";

private const string API_TENANT_CODE = "API-Key";

private const string HOST = "https://host";

private const string MIME_TYPE = "application/xml";

#endregion

public static void InitializeRequest(HttpWebRequest request)

{

request.Headers.Add("aw-tenant-code", API_TENANT_CODE);

Chapter 6: Device Management

474

VMware AirWatch REST API Guide | v.2016.04 | April 2017

request.Credentials = new NetworkCredential(USER_NAME, PASSWORD);

request.KeepAlive = false;

request.AddRange(1024);

request.Timeout = 10000;

}

public static void DeviceSearch()

{

try

{

var firstname = "";

var lastname = "";

var emailaddress = "";

var organizationgroupid = "";

var role = "";

var username = "";

var orderby = "";

var page = "";

var pagesize = "";

var sortorder = "";

var request =

WebRequest.Create(HOST + string.Format

("/api/system/admins/search?firstname={0}&lastname={1}&email=

{2}&organizationgroupid={3}&role={4}&" +

"username={5}&orderby={6}&page={7}&pagesize={8}&sortorder=

{9}", firstname, lastname, emailaddress, organizationgroupid,

role, username, orderby, page, pagesize, sortorder)) as

HttpWebRequest;

request.Method = "GET";

InitializeRequest(request);

request.Accept = MIME_TYPE;

var response = (HttpWebResponse)request.GetResponse();

var streamReader = new StreamReader(response.GetResponseStream

());

Console.WriteLine(streamReader.ReadToEnd());

streamReader.Close();

response.Close();

}

catch (WebException e)

{

if (e.Response != null)

{

var errorMessageStream = e.Response.GetResponseStream();

string message = new StreamReader

(errorMessageStream).ReadToEnd();

Console.WriteLine(message);

}

else

{

Console.WriteLine(e.Message);

}

Chapter 6: Device Management

475

VMware AirWatch REST API Guide | v.2016.04 | April 2017

catch (Exception e)

{

Console.WriteLine(e.Message);

}

Chapter 6: Device Management

476

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Compliance Policy

Functionality – Searches for the compliance policies with the search parameters passed.

HTTP Method – GET

API URI – https://host/api/mdm/compliancepolicy/search?organizationgroupid={ogid}&page={page}&pagesize=

{pagesize}

Request Body – NA

URI Parameters

Tag Type Description

ogid Numeric Organization group id which is similar to selected organization

group selected in console.

page Numeric page number

pagesize Numeric Maximum results which should be returned in each page

Response Payload

XML

<CompliancePolicySearchResult xmlns="http://www.air-

watch.com/servicemodel/resources">

<Page>Numeric</Page>

<PageSize>Numeric</PageSize>

<Total>Numeric</Total>

<DevicePolicyId>Numeric</DevicePolicyId>

<Name>String</Name>

<Description>String</Description>

<IsActive>Boolean</IsActive>

<RootLocationGroupName>String</RootLocationGroupName>

<RootLocationGroupId>Numeric</RootLocationGroupId>

<Platform>String</Platform>

<CompliantDevices>Numeric</CompliantDevices>

<NonCompliantDevices>Numeric</NonCompliantDevices>

<AssignedDevices>Numeric</AssignedDevices>

</CompliancePolicy>

<DevicePolicyId>Numeric</DevicePolicyId>

<Name>String</Name>

<Description>String</Description>

<IsActive>Boolean</IsActive>

<RootLocationGroupName>String</RootLocationGroupName>

<RootLocationGroupId>Numeric</RootLocationGroupId>

<Platform>String</Platform>

<CompliantDevices>Numeric</CompliantDevices>

Chapter 6: Device Management

477

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<NonCompliantDevices>Numeric</NonCompliantDevices>

<AssignedDevices>Numeric</AssignedDevices>

</CompliancePolicy>

</CompliancePolicySearchResult>

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"CompliancePolicy":[{

"AssignedDevices":Numeric,

"CompliantDevices":Numeric,

"Description":"String",

"DevicePolicyId":Numeric,

"IsActive":Boolean,

"Name":"String",

"NonCompliantDevices":Numeric,

"Platform":"String",

"RootLocationGroupId":Numeric,

"RootLocationGroupName":"String"

}]

}

Response Tag Details

Tag Type Description

Page Numeric The specific page number to be retrieved

PageSize Numeric Maximum records per page to be displayed

Total Numeric Total number of records present in the search result

CompliancePolicy String Type of the compliance policy to be searched for

AssignedDevices Numeric Number of devices assigned with the compliance policy

CompliantDevices Numeric Number of devices that are compliant

Description String Description of the compliance policy

DevicePolicyId Numeric Unique identification number of the device policy

IsActive Boolean True / False

Name String Name of the compliance policy

NonCompliantDevices Numeric Number of non-compliant devices

Platform String Platform of the device

Chapter 6: Device Management

478

VMware AirWatch REST API Guide | v.2016.04 | April 2017

RootLocationGroupId Numeric Unique identification number of the root location group where the

compliance policy is configured

RootLocationGroupName String Name of the root location group where the compliance policy is

configured

Chapter 6: Device Management

479

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Device Extensive Search

Functionality – Search results containing the devices and their product assignment information.

HTTP Method – GET

API URI – https://host/api/mdm/devices/extensivesearch?organizationgroupid={organizationgroupid}&platform=

{platform}&startdatetime={startdatetime}&enddatetime={enddatetime}&deviceid={deviceid}&customattributes=

{customattributeslist}&enrollmentstatus={enrollmentstatus}&enrollmentstatuschangefrom=

{statuschangestarttime}&enrollmentstatuschangeto={statuschangeendtime}&page={page}&pagesize={pagesize}

lExact Match Parameter – platform, enrollmentstatus

lPattern (Contains) Match Parameter – organizationgroupid, startdatetime, enddatetime,deviceid,

customattributes, enrollmentstatuschangefrom, enrollmentstatuschangeto, page, pagesize

Request Body – NA

URI Parameters

Tag Type Description

organizationgroupid Numeric Organization Group to be searched, user's OG is considered if not sent

platform String Device platform

customattributeslist String Custom attribute names

startdatetime Datetime Filters devices such that devices with last seen after this date will be

returned

enddatetime Datetime Filters devices such that devices with last seen till this date will be

returned

deviceid Numeric Device Identifier

enrollmentstatus Boolean Filters devices based on their EnrollmentStatus

statuschangestarttime Datetime Filters the devices for which EnrollmentStatus has changed from

enrollmentstatuschangefrom datetime [Valid only in case of

enrollmentStatus filter = enrolled or unenrolled]

statuschangeendtime Datetime Filters the devices for which EnrollmentStatus has changed till

enrollmentstatuschangeto datetime [Valid only in case of

enrollmentStatus filter = enrolled or unenrolled]

page Numeric The specific page number to get

pagesize Numeric Max records per page

Accepted DateTime formats: "yyyy/MM/dd", "yyyy-MM-dd", "MM/dd/yyyy", "MM-dd-yyyy", "yyyy/MM/dd

HH:mm:ss.fff", "yyyy-MM-dd HH:mm:ss.fff", "MM/dd/yyyy HH:mm:ss.fff", "MM-dd-yyyy HH:mm:ss.fff",

Chapter 6: Device Management

480

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"yyyy/MM/ddTHH:mm:ss.fff", "yyyy-MM-ddTHH:mm:ss.fff", "MM/dd/yyyyTHH:mm:ss.fff", "MM-dd-

yyyyTHH:mm:ss.fff", "yyyy-MM-dd HH-mm-ss-tt"

Response Payload

XML

<DeviceExtensiveSearchResult xmlns="http://www.air-

watch.com/servicemodel/resources">

<DeviceId>Numeric</DeviceId>

<Udid>String</Udid>

<DeviceFriendlyName>String</DeviceFriendlyName>

<OrganizationGroupId>Numeric</OrganizationGroupId>

<UserName>String</UserName>

<LastSeen>Datetime</LastSeen>

<EnrollmentDate>Datetime</EnrollmentDate>

<Compliant>Boolean</Compliant>

<AssetNumber>String</AssetNumber>

<EnrollmentStatus>Boolean</EnrollmentStatus>

<UnEnrolledDate>Datetime</UnEnrolledDate>

<ConnectionType>String</ConnectionType>

<IPAddress>String</IPAddress>

<MACAddress>String</MACAddress>

</NetworkInfo>

</DeviceNetworkInfo>

<ProductId>Numeric</ProductId>

<Name>String</Name>

<Status>String</Status>

</Product>

</Products>

<SmartGroupId>Numeric</SmartGroupId>

<Name>String</Name>

</SmartGroup>

</SmartGroups>

<Name>String</Name>

<Value>String</Value>

</DeviceCustomAttribute>

</CustomAttributes>

</DeviceDetailsExt>

Chapter 6: Device Management

481

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</Devices>

</DeviceExtensiveSearchResult>

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"Devices":[{

"AssetNumber":"String",

"Compliant":Boolean,

"CustomAttributes":[{

"Name":"String",

"Value":"String"

}],

"DeviceFriendlyName":"String",

"DeviceId":Numeric,

"DeviceNetworkInfo":[{

"ConnectionType":"String",

"IPAddress":"String",

"MACAddress":"String"

}],

"EnrollmentDate":"Datetime",

"EnrollmentStatus":"Boolean",

"LastSeen":"Datetime",

"OrganizationGroupId":Numeric,

"Products":[{

"Name":"String",

"ProductId":Numeric,

"Status":"String"

}],

"SerialNumber":"String",

"SmartGroups":[{

"Name":"String",

"SmartGroupId":Numeric

}],

"Udid":"String",

"UnEnrolledDate":"Datetime",

"UserName":"String"

}]

}

Response Tag Details

Tag Type Description

DeviceId Numeric Unique numeric ID of the device

Chapter 6: Device Management

482

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Udid String UDID of the device

DeviceFriendlyName String Friendly name of the device

OrganizationGroupId Numeric Unique identification of the organization group from where the devices

are filtered

UserName String Username of the device

LastSeen Datetime Last seen time stamp of the device

EnrollmentDate Datetime Time stamp of the device enrollment date

Compliant Boolean Status of the device compliant policy

DeviceNetworkInfo

ConnectionType

String Name of the connection displayed on the device

DeviceNetworkInfo IPAddress String IP address of the device

DeviceNetworkInfo

MACAddress

String MAC address of the device

ProductId Numeric Unique identification number of the product

Products Name String Name of the product

Products Status String Status of the product

SmartGroupId Numeric Unique identification number of the Smart group

SmartGroupId Name String Name of the smart group

CustomAttributes Name String Name of the custom attributes

CustomAttributes Value String Value of the custom attributes

EnrollmentStatus String Enrollment status on the device

UnEnrolledDate Datetime Time stamp of the device last enrollment date

Chapter 6: Device Management

483

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Security Information

Functionality – Searches for device security information.

HTTP Method – GET

API URI – https://host/api/mdm/devices/securityinfosearch?organizationgroupid={organizationgroupid}&user=

{user}&model={model}&platform={platform}&lastseen={lastseen}&ownership={ownership}&compliantstatus=

{compliantstatus}&seensince={seensince}&page={page}&pagesize={pagesize}

lExact Match Parameter – model, platform, ownership, compliantstatus

lPattern (Contains) Match Parameter – organizationgroupid, user, lastseen, seensince, page, pagesize

Request Body – NA

URI Parameters

Tag Type Description

organizationgroupid Numeric Organization group to be searched, user's OG is considered if not sent

user String Enrolled username

model String Device model

platform String Device platform

lastseen Datetime Last seen date string

ownership String Ownership type of the device

compliantstatus Boolean Complaint status [True or False]

seensince Datetime Specifies the date filter for device search, which retrieves the devices

that are seen after this date

page Numeric The specific page number to get

pagesize Numeric Max records per page

Response Payload

XML

<DeviceSecurityInfoSearchResult xmlns="http://www.air-

watch.com/servicemodel/resources">

<Page>Numeric</Page>

<PageSize>Numeric</PageSize>

<Total>Numeric</Total>

<DeviceId>Numeric</DeviceId>

<CompromisedStatus>Boolean</CompromisedStatus>

Chapter 6: Device Management

484

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<EncryptionStatus>Boolean</EncryptionStatus>

<PasscodeStatus>Boolean</PasscodeStatus>

<PasscodeComplianceStatus>Boolean</PasscodeComplianceStatus>

</SecurityInfo>

</DeviceSecurityInfoSearchResult>

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"SecurityInfo":[{

"CompromisedStatus":"Boolean",

"DeviceId":Numeric,

"EncryptionStatus":"Boolean",

"PasscodeComplianceStatus":"Boolean",

"PasscodeStatus":"Boolean"

}]

}

Response Tag Details

Tag Type Description

Page Numeric Page number of the search result

PageSize Numeric Number of content details shown on each page

Total Numeric Total number of documents on the device

CompromisedStatus Boolean Compromised status of the device. Values: True/False

DeviceId Numeric Unique identification number of the device to be searched for

EncryptionStatus Boolean Encryption status of the device. Values: True/False

PasscodeComplianceStatus Boolean Passcode compliance status of the device

PasscodeStatus Boolean Passcode status of the device

Chapter 6: Device Management

485

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Network Information

Functionality – Returns device network information along with corresponding device ID.

HTTP Method – GET

API URI – https://host/api/mdm/devices/networkinfosearch?user={user}&model={model}&platform=

{platform}&lastseen={lastseen}&ownership={ownership}&lgid={lgid}&compliantstatus={compliantstatus}&seensince=

{seensince}&page={page}&pagesize={pagesize}&sortorder={sortorder}

lExact Match Parameter – model, platform, ownership, compliancestatus, sortorder

lPattern (Contains) Match Parameter – user, lastseen, lgid, seensince, page, pagesize

Request Body – NA

URI Parameters

Tag Type Description

user String Username of the Enrolled user

model String Device model

platform String Device platform

lastseen Datetime Last seen date string

ownership String Defines the ownership typeof the device

lgid Numeric Unique numeric Identifier of the Organization Group

compliantstatus Boolean Complaint status.(true/false)

seensince Datetime Specifies the date filter for device network info search, which retrieves

the devices that are seen after this date

page Numeric Page number

pagesize Numeric Records per page

sortorder String Sorting order. Values ASC or DESC. Defaults to ASC

Response Payload

XML

<NetworkInfoSearchResult xmlns="http://www.air-

watch.com/servicemodel/resources">

<Page>Numeric</Page>

<PageSize>Numeric</PageSize>

<Total>Numeric</Total>

Chapter 6: Device Management

486

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Id xmlns="">Numeric</Id>

<WifiIPAddress>String</WifiIPAddress>

<CellularIPAddress>String</CellularIPAddress>

<EthernetIPAddress>String</EthernetIPAddress>

</IPAddress>

</DeviceNetworkDetail>

</DeviceNetworkDetails>

</NetworkInfoSearchResult>

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"DeviceNetworkDetails":[{

"Id":{

"Value": Numeric,

"IPAddress":{

"WifiIPAddress":"String",

"CellularIPAddress":"String",

"EthernetIPAddress":"String"

}

}]

}

Response Tag Details

Tag Type Description

Page Numeric Page number of the retrieved response

PageSize Numeric Size of the current page

Total Numeric Total Results obtained from the search

DeviceNetwork Id Numeric Unique identification number of the Network

DeviceNetwork IPAddress String IP address of the device network

WifiIPAddress String The IP address of the Wi-Fi connectivity

CellularIPAddress String The IP address for cellular connectivity

EthernetIPAddress String The IP address for Ethernet connectivity

Chapter 6: Device Management

487

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Device Extensive Search (Lite)

Functionality – Search results containing the devices and their product assignment information (Lite Version).

HTTP Method – GET

API URI – https://host/api/mdm/devices/litesearch?organizationgroupid={organizationgroupid}&platform=

{platform}&startdatetime={startdatetime}&enddatetime={enddatetime}&deviceid={deviceid}&customattributes=

{customattributeslist}&page={page}&pagesize={pagesize}

lExact Match Parameter – platform

lPattern (Contains) Match Parameter – organizationgroupid, startdatetime, enddatetime, deviceid,

customattributes, page, pagesize

Request Body – NA

URI Parameters

Tag Type Description

organizationgroupid Numeric Organization Group to be searched, user's OG is considered if not sent

platform String Device platform

customattributeslist String Custom attribute names

startdatetime Datetime Filters devices such that devices with last seen after this date will be

returned

enddatetime Datetime Filters devices such that devices with last seen till this date will be

returned

deviceid Numeric Device Identifier

page Numeric The specific page number to get

pagesize Numeric Max records per page

Accepted DateTime formats: "yyyy/MM/dd", "yyyy-MM-dd", "MM/dd/yyyy", "MM-dd-yyyy", "yyyy/MM/dd

HH:mm:ss.fff", "yyyy-MM-dd HH:mm:ss.fff", "MM/dd/yyyy HH:mm:ss.fff", "MM-dd-yyyy HH:mm:ss.fff",

"yyyy/MM/ddTHH:mm:ss.fff", "yyyy-MM-ddTHH:mm:ss.fff", "MM/dd/yyyyTHH:mm:ss.fff", "MM-dd-

yyyyTHH:mm:ss.fff", "yyyy-MM-dd HH-mm-ss-tt"

Chapter 6: Device Management

488

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Payload

XML

<DeviceExtensiveLiteSearchResult xmlns="http://www.air-

watch.com/servicemodel/resources">

<Page>Numeric</Page>

<PageSize>Numeric</PageSize>

<Total>Numeric</Total>

<DeviceId>Numeric</DeviceId>

<Udid>String</Udid>

<DeviceFriendlyName>String</DeviceFriendlyName>

<OrganizationGroupId>Numeric</OrganizationGroupId>

<ConnectionType>String</ConnectionType>

<IPAddress>String</IPAddress>

<MACAddress>String</MACAddress>

</NetworkInfo>

</DeviceNetworkInfo>

<LastSeen>Datetime</LastSeen>

<Name>String</Name>

<Value>String</Value>

</DeviceCustomAttribute>

</CustomAttributes>

</DeviceExtLite>

</Devices>

</DeviceExtensiveLiteSearchResult>

JSON

{

"Page":Numeric,

"PageSize":Numeric,

"Total":Numeric,

"Devices":[{

"CustomAttributes":[{

"Name":"String",

"Value":"String"

}],

"DeviceFriendlyName":"String",

"DeviceId":Numeric,

"DeviceNetworkInfo":[{

"ConnectionType":"String",

Chapter 6: Device Management

489

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"IPAddress":"String",

"MACAddress":"String"

}],

"LastSeen":"Datetime",

"OrganizationGroupId":Numeric,

"Udid":"String"

}]

}

Response Tag Details

Tag Type Description

CustomAttributes Name String Name of the custom attribute to be searched for

CustomAttributes Value String Value of the custom attribute passed to be searched for

DeviceFriendlyName String Friendly name of the device

DeviceId Numeric Unique identification number of the device

ConnectionType String Type of connection enabled by the payload

IPAddress String IP address of the device network

MACAddress String MAC address of the device network

LastSeen Datetime Last seen time stamp of the device

OrganizationGroupId Numeric Unique location group number of the device

Udid String UDID of the device

Chapter 6: Device Management

490

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Custom Attribute Search

Functionality – Searches for device custom attributes.

HTTP Method – GET

API URI – https://host/api/mdm/devices/customattribute/search?organizationgroupid=

{organizationgroupid}&deviceid={deviceid}&serialnumber={serialnumber}&startdatetime=

{startdatetime}&enddatetime={enddatetime}

lPattern (Contains) Match Parameter – organizationgroupid, deviceid, serialnumbe, startdatetime, enddatetime

Request Body – NA

URI Parameters

Tag Type Description

organizationgroupid Numeric Organization group to be searched, user's OG is considered if

not sent.

deviceid Numeric Device ID to search for

serialnumber String Device serial number to search for

startdatetime Datetime DateTime, filters the custom attributes which are modified

by after this datetime

enddatetime Datetime DateTime, filters the custom attributes which are modified

by before this datetime

Response Payload

XML

<DeviceCustomAttributeChangeResult xmlns="http://www.air-

watch.com/servicemodel/resources">

<DeviceID>Numeric</DeviceID>

<Udid>String</Udid>

<SerialNumber>String</SerialNumber>

<EnrollmentUserName>String</EnrollmentUserName>

<AssetNumber>String</AssetNumber>

<Name>String</Name>

<Application>String</Application>

<Value>String</Value>

<Source>String</Source>

</CustomAttributeChange>

</CustomAttributeChanges>

Chapter 6: Device Management

491

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</DeviceCustomAttributeChange>

</DeviceCustomAttributeChanges>

</DeviceCustomAttributeChangeResult>

JSON

{

"Devices":[{

"AssetNumber":"String",

"CustomAttributes":[{

"Application":"String",

"Name":"String",

"Value":"String"

"Source" : "String

}],

"DeviceId":Numeric,

"EnrollmentUserName":"String",

"SerialNumber":"String",

"Udid":"String"

}]

}

Response Tag Details

Tag Type Description

CustomAttributes Name String Name of the custom attribute to be searched for

AssetNumber String Asset number of the device

DeviceId Numeric Unique identification number of the device

EnrollmentUserName String Name of the device enrollment user

SerialNumber String Serial number of the device

Udid String UDID of the device

Chapter 6: Device Management

492

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Search Changes Made To Custom Attribute

Functionality – Searches for changes made to device custom attributes.

HTTP Method – GET

API URI – https://host/api/mdm/devices/customattribute/changereport?organizationgroupid=

{organizationgroupid}&deviceid={deviceid}&startdatetime={startdatetime}&enddatetime={enddatetime}

Request Body – NA

URI Parameters

Tag Type Description

organizationgroupid Numeric Organization group to be searched, user's OG is considered if

not sent.

deviceid Numeric Device ID to search for

startdatetime Datetime DateTime, filters the custom attributes which are modified

by after this datetime

enddatetime Datetime DateTime, filters the custom attributes which are modified

by before this datetime

Response Payload

XML

<DeviceCustomAttributeChangeResult

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/servicemodel/resources">

<DeviceID>String</DeviceID>

<FriendlyName>String</FriendlyName>

<CustomAttributeName>String</CustomAttributeName>

<OldValue>String</OldValue>

<NewValue>String</NewValue>

<ModifiedDate>String</ModifiedDate>

<LocationGroupID>String</LocationGroupID>

<LocationGroupName>String</LocationGroupName>

<ApplicationGroup>String</ApplicationGroup>

<Source>String</Source>

</CustomAttributeChange>

</CustomAttributeChanges>

</DeviceCustomAttributeChange>

</DeviceCustomAttributeChanges>

Chapter 6: Device Management

493

VMware AirWatch REST API Guide | v.2016.04 | April 2017

</DeviceCustomAttributeChangeResult>

JSON

{

"DeviceCustomAttributeChanges" : [

{

"DeviceID" : "String",

"FriendlyName" : "String",

"CustomAttributeChanges" : [

{

"CustomAttributeName" : "String",

"OldValue" : "String",

"NewValue" : "String",

"ModifiedDate" : "String",

"LocationGroupID" : "String",

"LocationGroupName" : "String",

"ApplicationGroup" : "String",

"Source" : "String"

}

]

}]

}

Response Tag Details

Tag Type Description

DeviceID String Unique identification number of the device

FriendlyName String Friendly name of the device

CustomAttributeName String Name of the device custom attribute

OldValue String Old value of the custom attribute

NewValue String New value of the custom attribute

ModifiedDate String Timestamp of the last modified date of the custom attribute

LocationGroupID String Unique identifier of the organization group

LocationGroupName String Name of the organization group

ApplicationGroup String Name of the application group

Source String Source from where the changes are made to the custom attribute

Chapter 6: Device Management

494

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Device Custom Attribute (*Refactored)

Functionality – Updates the device custom attribute value if already present for a device, else adds the same to the

device.

HTTP Method – PUT

Deprecated API URI – https://host/api/mdm/devices/{id}/updatecustomattributes. This will be deprecated soon. Start

using the Supported API URI.

*Supported API URI – https://host/api/mdm/devices/{id}/customattributes

You can also update device custom attributes using the following parameters:

lSerial Number – https://host/api/mdm/devices/serialnumber/{serialnumber}/customattributes

lAsset Number – https://host/api/mdm/devices/assetnumber/{assetnumber}/customattributes

Request Payload

XML

<CustomAttributeList xmlns="http://www.air-

watch.com/servicemodel/resources">

<Name>String</Name>

<Value>String</Value>

<ApplicationGroup>String</ApplicationGroup>

</DeviceCustomAttribute>

</CustomAttributes>

</CustomAttributeList>

JSON

{

"CustomAttributes":[{

"Name":"String",

"Value":"String",

"ApplicationGroup" : "String"

}]

}

Chapter 6: Device Management

495

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

Name Yes Name of the custom attribute to be updated

Value Yes Value of the custom attribute

ApplicationGroup Yes Application group of the device

Response Payload

XML

<TotalItems>Numeric</TotalItems>

<AcceptedItems>Numeric</AcceptedItems>

<FailedItems>Numeric</FailedItems>

<ActivityId>String</ActivityId>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

</Faults>

</BulkResponse>

JSON

{

"AcceptedItems":Numeric,

"FailedItems":Numeric,

"Faults":{

"Fault":[{

"ErrorCode":Numeric,

"ItemValue":"String",

"Message":"String"

}]

"TotalItems":Numeric

}

Chapter 6: Device Management

496

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Response Tag Details

Tag Type Description

TotalItems Numeric Total number of device parameters sent in the request

AcceptedItems Numeric Number of devices accepted for updating device custom attribute

FailedItems Numeric Number of devices that could not be updated with custom attribute

Faults Array Array of the "Fault" tag describing each detail of each failed instance

ErrorCode Numeric HTTP status code for the failed element

Message String Reason for the device not being updated

Chapter 6: Device Management

497

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Custom Attribute (*Refactored)

Functionality – Deletes the device custom attributes.

HTTP Method – Delete

Deprecated API URI – https://host/api/mdm/devices/{id}/deletecustomattributes. This will be deprecated soon. Start

using the Supported API URI.

*Supported API URI – https://host/api/mdm/devices/{id}/customattributes

You can delete the device custom attribute using the following parameter:

lSerial Number – https://host/api/mdm/devices/serialnumber/{serialnumber}/customattributes

Request Payloads

XML

<CustomAttributeList xmlns="http://www.air-

watch.com/servicemodel/resources">

<Name>String</Name>

<Value>String</Value>

<ApplicationGroup>String</ApplicationGroup>

</DeviceCustomAttribute>

</CustomAttributes>

</CustomAttributeList>

JSON

{

"CustomAttributes":[{

"Name":"String",

"Value":"String",

"ApplicationGroup":"String"

}]

}

Request Tag Details

Tag Mandatory Description

Value Yes The device parameter. For example, DeviceID , MAC Address , Serial

Number or UDID

Name Yes Name of the custom attribute to be updated

Chapter 6: Device Management

498

VMware AirWatch REST API Guide | v.2016.04 | April 2017

ApplicationGroup Yes Application group of the device

Response Payload

XML

<TotalItems>Numeric</TotalItems>

<AcceptedItems>Numeric</AcceptedItems>

<FailedItems>Numeric</FailedItems>

<ActivityId>String</ActivityId>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

<Fault>

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

</Faults>

</BulkResponse>

JSON

{

"AcceptedItems":Numeric,

"FailedItems":Numeric,

"Faults":{

"Fault":[{

"ErrorCode":Numeric,

"ItemValue":"String",

"Message":"String"

}]

"TotalItems":Numeric

}

Response Tag Details

Tag Type Description

Total Items Numeric Total number of delete device custom attribute requests sent

AcceptedItems Numeric Number of devices to which delete command was successfully sent

FailedItems Numeric Number of device custom attributes that could not be deleted

Chapter 6: Device Management

499

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Faults Array Array of the "Fault" tag describing each detail of each failed instance

Errorcode Numeric HTTP status code for the failed element

Message String Reason for the custom attribute delete not being performed

Chapter 6: Device Management

500

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Edit Device Details

Functionality – Edits the device details identified by device Id.

HTTP Method – POST

API URI – https://host/api/mdm/devices/{id}/editdevice

Response Body – NA

URI Parameters

Tag Type Description

id Numeric Device identifier for which details needs to be updated

device String Device details which needs to be updated

You can edit device details using the following parameters:

lMAC Address – https://host/api/mdm/devices/macaddress/{macaddress}/editdevice

lSerial Number –https://host/api/mdm/devices/serialnumber/{serialnumber}/editdevice

lUDID – https://host/api/mdm/devices/udid/{udid}/editdevice

Request Payload

XML

<AssetNumber>String</AssetNumber>

<DeviceFriendlyName>String</DeviceFriendlyName>

<Ownership>String</Ownership>

</Device>

JSON

{

"AssetNumber":"String",

"DeviceFriendlyName":"String",

"Ownership":"String"

}

Chapter 6: Device Management

501

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Request Tag Details

Tag Mandatory Description

AssetNumber No Asset number of the device

DeviceFriendlyName No Friendly name assigned to the device

Ownership No Ownership type of the device

Chapter 6: Device Management

502

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Managed Settings

Functionality – Sets the managed settings for an iOS device based on alternate id.

HTTP Method – POST

API URI – https://host/api/mdm/devices/managedsettings?searchby={searchby}&id={id}

Response Obtained – NA

URI Parameters

Tag Description

searchby The alternate id type (DeviceId, Macaddress, Udid, Serialnumber, ImeiNumber,

EasId)

id The alternate ID of the device

Request Payload

XML

<DeviceManagedSettings xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/servicemodel/resources">

<VoiceRoamingAllowed>Boolean</VoiceRoamingAllowed>

<DataRoamingAllowed>Boolean</DataRoamingAllowed>

<PersonalHotspotAllowed>Boolean</PersonalHotspotAllowed>

</DeviceManagedSettings>

JSON

{

"VoiceRoamingAllowed" : Boolean,

"DataRoamingAllowed" : Boolean,

"PersonalHotspotAllowed" : Boolean

}

Request Tag Details

Tag Mandatory Description

VoiceRoamingAllowed No Denotes if the voice roaming is enabled. Values: True, False

DataRoamingAllowed No Denotes if the data roaming is enabled. Values: True, False

PersonalHotspotAllowed No Denotes if the Personal Hotspot is enabled. Values: True, False

Chapter 6: Device Management

503

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Change Device Organization Group

Functionality – Changes the organization group to which the device is assigned.

HTTP Method – POST

Deprecated API URI – https://host/API/mdm/devices/{id}/changeorganizationgroup/{organizationgroupid}. This URI

will be deprecated soon. Start using the *Supported API URI.

*Supported API URI – https://host/api/mdm/devices/{id}/commands/changeorganizationgroup/{organizationgroupid}

(HTTP Method Used – PUT)

You can also change the device organization group using the following parameter:

lAlternate device ID type – https://host/api/mdm/devices/organizationgroup?searchby={searchby}&id={id}&ogid=

{ogid} (HTTP Method Used – POST). This URI will be deprecated soon. Start using the *Supported API URI.

l*Supported API URI – https://host/api/mdm/devices/commands/changeorganizationgroup?searchby=

{searchby}&id={id}&ogid={ogid} (HTTP Method Used – POST)

URI Parameters

Tag Description

OrganizationGroupID Unique identification of the target organization group where the device can be

moved

searchby The alternate id type (Macaddress, Udid, Serialnumber, ImeiNumber)

id The unique identification number of the device

Response Obtained – NA

Request payload – NA

Chapter 6: Device Management

504

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Create Offline Device Record

Functionality – Creates an offline device decord.

HTTP Method – POST

API URI – https://host/api/mdm/devices/createofflinedevice/{token}/token

URI Parameters

Tag Type Description

token String Enrollment token value

Request Body – NA

Response Payload

XML

<OfflineDeviceEntity xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/servicemodel/resources">

<Id xmlns="">Numeric</Id>

<DeviceRecordId>Numeric</DeviceRecordId>

</OfflineDeviceEntity>

JSON

{

"DeviceRecordId" : Numeric,

"Id" : {

"Value" : Numeric

}

Response Tag Details

Tag Type Description

DeviceRecordId Numeric Unique identifier of the device's record

Chapter 6: Device Management

505

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Create Relay Server

Functionality – Creates a new relay server provided that valid values are given.

HTTP Method – POST

API URI – https://host/api/mdm/relayservers

Request Payload

XML

<RelayServerDetails xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Name>String</Name>

<Description>String</Description>

<RelayServerTypeId>Numeric</RelayServerTypeId>

<RestrictContentDeliveryWindow>String</RestrictContentDeliveryWindow>

<StartTime>String</StartTime>

<EndTime>String</EndTime>

<RelayServerId>Numeric</RelayServerId>

<Active>String</Active>

</General>

<ManagedBy>String</ManagedBy>

<int>Numeric</int>

</StagingServer>

<int>Numeric</int>

</ProductionServer>

</Assignment>

<Protocol>Numeric</Protocol>

<Hostname>String</Hostname>

<Port>Numeric</Port>

<User>String</User>

<Password>String</Password>

<Path>String</Path>

<PassiveMode>String</PassiveMode>

<VerifyServer>String</VerifyServer>

</DeviceConnection>

<CopyValuesFromDeviceConnection>String</CopyValuesFromDeviceConnectio

<Protocol>Numeric</Protocol>

Chapter 6: Device Management

506

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Hostname>String</Hostname>

<Port>Numeric</Port>

<User>String</User>

<Password>String</Password>

<Path>String</Path>

<PassiveMode>String</PassiveMode>

<VerifyServer>String</VerifyServer>

</ConsoleConnection>

<PullLocalDirectory>String</PullLocalDirectory>

<PullDiscoveryText>String</PullDiscoveryText>

<PullFrequency>Numeric</PullFrequency>

</PullConnection>

</RelayServerDetails>

JSON

{

"General" : {

"Name" : "String",

"Description" : "String",

"RelayServerTypeId" : Numeric,

"RestrictContentDeliveryWindow" : "String",

"StartTime" : "String",

"EndTime" : "String",

"RelayServerId" : Numeric,

"Active" : "String"

"Assignment" : {

"ManagedBy" : "String",

"StagingServer" : [

Numeric,

Numeric

"ProductionServer" : [

Numeric,

Numeric

]

"DeviceConnection" : {

"Protocol" : Numeric,

"Hostname" : "String",

"Port" : Numeric,

"User" : "String",

"Password" : "String",

"Path" : "String",

"PassiveMode" : "String",

"VerifyServer" : "String"

Chapter 6: Device Management

507

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"ConsoleConnection" : {

"CopyValuesFromDeviceConnection" : "String",

"Protocol" : Numeric,

"Hostname" : "String",

"Port" : Numeric,

"User" : "String",

"Password" : "String",

"Path" : "String",

"PassiveMode" : "String",

"VerifyServer" : "String"

"PullConnection" : {

"PullLocalDirectory" : "String",

"PullDiscoveryText" : "String",

"PullFrequency" : Numeric

}

Request Tag Details

Tag Mandatory Description

Name Yes Name of the relay server

Description No Description of the relay server created

RelayServerTypeId Yes Unique identifier of the relay server type

RestrictContentDeliveryWindow No The time window which can be restricted for the content to be

delivered to the relay server

StartTime Yes Start of the time window for the content to be delivered to the

relay server

EndTime Yes End of the time window for the content to be delivered to the

relay server

RelayServerId Yes Unique identifier of the relay server

Active No Specify if the relay server active or not

ManagedBy Yes Unique Organization Group which manages the relay server

StagingServer No The organization group that uses the relay server for staging

ProductionServer No The organization group that uses the relay server for provisioning

content post enrollment

Protocol Yes Specify the protocol used for relay server to connect to devices

Hostname Yes Specify the host name for devices to connect to the relay server

Port Yes Specify the port number to connect devices with the relay server

User Yes User name to access the device to connect to the relay server

Chapter 6: Device Management

508

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Password Yes Password of the relay server to connect with devices

Path Yes Specify the path for devices to connect with the relay server

PassiveMode No The server selects the data port on behalf of the device

VerifyServer No Ensures that the connection is trusted and there are no SSLerrors

CopyValuesFromDeviceConnection Yes For the console connection, copy all the values from the device

connection details

Protocol Yes Specify the protocol used for the relay server to connect to the

console

Hostname Yes Specify the hostname for console to connect to the relay server

Port Yes Specify the port number for the relay server to connect with the

console

User Yes User name to access the console and connect to the relay server

Password Yes Password of the relay server connection with the console

Path Yes Specify the path for the console to connect with the relay server

PassiveMode No The server selects the data port on behalf of the device

VerifyServer No Ensures that the connection is trusted and there are no SSLerrors

PullLocalDirectory Yes For the pull connection, specify the pull local directory

PullDiscoveryText Yes Specify the text for the pull discovery

PullFrequency Yes Specify the pull frequency

Response Payload

XML

<int>Numeric</int>

JSON

Numeric

Response Tag Details

Tag Type Description

Value Numeric Newly created relay server id

Chapter 6: Device Management

509

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Create Relay Servers in Bulk

Functionality – Creates new relay servers in bulk.

HTTP Method – POST

API URI – https://host/api/mdm/relayservers/bulk

Request Payload

XML

<ArrayOfRelayServerDetailsModel xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<RelayServerDetails xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns="http://www.air-watch.com/webapi/resources">

<Name>String</Name>

<Description>String</Description>

<RelayServerTypeId>Numeric</RelayServerTypeId>

<RestrictContentDeliveryWindow>String</RestrictContentDeliveryWin

dow>

<StartTime>String</StartTime>

<EndTime>String</EndTime>

<RelayServerId>Numeric</RelayServerId>

<Active>String</Active>

</General>

<ManagedBy>String</ManagedBy>

<int>Numeric</int>

</StagingServer>

<int>Numeric</int>

</ProductionServer>

</Assignment>

<Protocol>Numeric</Protocol>

<Hostname>String</Hostname>

<Port>Numeric</Port>

<User>String</User>

<Password>String</Password>

<Path>String</Path>

<PassiveMode>String</PassiveMode>

<VerifyServer>String</VerifyServer>

</DeviceConnection>

Chapter 6: Device Management

510

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<CopyValuesFromDeviceConnection>String</CopyValuesFromDeviceConne

ction>

<Protocol>Numeric</Protocol>

<Hostname>String</Hostname>

<Port>Numeric</Port>

<User>String</User>

<Password>String</Password>

<Path>String</Path>

<PassiveMode>String</PassiveMode>

<VerifyServer>String</VerifyServer>

</ConsoleConnection>

<PullLocalDirectory>String</PullLocalDirectory>

<PullDiscoveryText>String</PullDiscoveryText>

<PullFrequency>Numeric</PullFrequency>

</PullConnection>

</RelayServerDetails>

</ArrayOfRelayServerDetailsModel>

JSON

{

"General" : {

"Name" : "String",

"Description" : "String",

"RelayServerTypeId" : Numeric,

"RestrictContentDeliveryWindow" : "String",

"StartTime" : "String",

"EndTime" : "String",

"RelayServerId" : Numeric,

"Active" : "String"

"Assignment" : {

"ManagedBy" : "String",

"StagingServer" : [

Numeric,

Numeric

"ProductionServer" : [

Numeric,

Numeric

]

"DeviceConnection" : {

"Protocol" : Numeric,

"Hostname" : "String",

"Port" : Numeric,

"User" : "String",

Chapter 6: Device Management

511

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"Password" : "String",

"Path" : "String",

"PassiveMode" : "String",

"VerifyServer" : "String"

"ConsoleConnection" : {

"CopyValuesFromDeviceConnection" : "String",

"Protocol" : Numeric,

"Hostname" : "String",

"Port" : Numeric,

"User" : "String",

"Password" : "String",

"Path" : "String",

"PassiveMode" : "String",

"VerifyServer" : "String"

"PullConnection" : {

"PullLocalDirectory" : "String",

"PullDiscoveryText" : "String",

"PullFrequency" : Numeric

}

Request Tag Details

Tag Mandatory Description

Name Yes Name of the relay server

Description No Description of the relay server created

RelayServerTypeId Yes Unique identifier of the relay server type

RestrictContentDeliveryWindow No The time window which can be restricted for the content to be

delivered to the relay server

StartTime Yes Start of the time window for the content to be delivered to the

relay server

EndTime Yes End of the time window for the content to be delivered to the

relay server

RelayServerId Yes Unique identifier of the relay server

Active No Specify if the relay server active or not

ManagedBy Yes Unique Organization Group which manages the relay server

StagingServer Yes Specifies the number of staging servers required

ProductionServer Yes Specifies the number of production servers required

Protocol Yes Specify the protocol used for the relay server to connect to

devices

Chapter 6: Device Management

512

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Hostname Yes Specify the hostname for devices to connect to the relay server

Port Yes Specify the port number to connect devices with the relay server

User Yes User name to enter into the device to connect to the relay server

Password Yes Password for the relay server connection with devices

Path Yes Specify the path for devices to connect with the relay server

PassiveMode No The server selects the data port on behalf of the device

VerifyServer No Ensures that the connection is trusted and there are no SSLerrors

CopyValuesFromDeviceConnection Yes For the console connection, copy all the values from the device

connection details

Protocol Yes Specify the protocol used for the relay server to connect to the

console

Hostname Yes Specify the hostname for console to connect to the relay server

Port Yes Specify the port number to connect console with the relay server

User Yes User name to access the console to connect to the relay server

Password Yes Password for the relay server connection with the console

Path Yes Specify the path for console to connect with the relay server

PassiveMode No The server selects the data port on behalf of the device

VerifyServer No Ensures that the connection is trusted and there are no SSLerrors

PullLocalDirectory Yes For the pull connection, specify the pull local directory

PullDiscoveryText Yes Specify the text for the pull discovery

PullFrequency Yes Specify the pull frequency

Response Payload

XML

<BulkResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<TotalItems xmlns="http://www.air-

watch.com/servicemodel/resources">1</TotalItems>

<AcceptedItems xmlns="http://www.air-

watch.com/servicemodel/resources">2</AcceptedItems>

<FailedItems xmlns="http://www.air-

watch.com/servicemodel/resources">3</FailedItems>

<ActivityId>String</ActivityId>

<Fault>

Chapter 6: Device Management

513

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<ErrorCode>Numeric</ErrorCode>

<ItemValue>String</ItemValue>

<Message>String</Message>

</Fault>

</Faults>

<RelayServerID>Numeric</RelayServerID>

<Name>String</Name>

</RelayServerModel>

</Created>

</BulkResponse>

JSON

{

"Created" : [

{

"RelayServerID" : Numeric,

"Name" : "String"

}

"TotalItems" : Numeric,

"AcceptedItems" : Numeric,

"FailedItems" : Numeric,

"Faults" : {

"Fault" : [

{

"ErrorCode" : Numeric,

"ItemValue" : "String",

"Message" : "String"

}

]

}

Response Tag Details

Tag Type Description

RelayServerID Numeric Unique identifier of the relay server

Name String Unique name of the relay server

TotalItems Numeric Total number of invite requests sent

AcceptedItems Numeric Number of invites successfully sent

FailedItems Numeric Number of invites not sent

Chapter 6: Device Management

514

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Faults Numeric This chunk of XML/JSON indicates the cause of failure in sending

invites.

ErrorCode Numeric HTTP status code for the failed element

Message String Reason for the relay server not being created in bulk

Chapter 6: Device Management

515

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Delete Relay Server

Functionality – Deletes the relay server.

HTTP Method – DELETE

API URI – https://host/api/mdm/relayservers/{serverId}

URI Parameters

Tag Description

serverId Unique identifier of the relay server to be deleted

Request Payload – NA

Response Payload – NA

Chapter 6: Device Management

516

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Retrieve Relay Server Details

Functionality – Retrieves the details of the existing relay server.

HTTP Method – GET

API URI – https://host/api/mdm/relayservers/{serverId}

URI Parameters

Tag Description

serverId Unique identifier of the relay server to be retrieved

Request Payload – NA

Response Payload

XML

<RelayServerDetails xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Name>String</Name>

<Description>String</Description>

<RelayServerTypeId>Numeric</RelayServerTypeId>

<RestrictContentDeliveryWindow>String</RestrictContentDeliveryWindow>

<StartTime>String</StartTime>

<EndTime>String</EndTime>

<RelayServerId>Numeric</RelayServerId>

<Active>String</Active>

</General>

<ManagedBy>String</ManagedBy>

<int>Numeric</int>

</StagingServer>

<int>Numeric</int>

</ProductionServer>

</Assignment>

<Protocol>Numeric</Protocol>

<Hostname>String</Hostname>

<Port>Numeric</Port>

<User>String</User>

<Password>String</Password>

Chapter 6: Device Management

517

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Path>String</Path>

<PassiveMode>String</PassiveMode>

<VerifyServer>String</VerifyServer>

</DeviceConnection>

<CopyValuesFromDeviceConnection>String</CopyValuesFromDeviceConnectio

<Protocol>Numeric</Protocol>

<Hostname>String</Hostname>

<Port>Numeric</Port>

<User>String</User>

<Password>String</Password>

<Path>String</Path>

<PassiveMode>String</PassiveMode>

<VerifyServer>String</VerifyServer>

</ConsoleConnection>

<PullLocalDirectory>String</PullLocalDirectory>

<PullDiscoveryText>String</PullDiscoveryText>

<PullFrequency>Numeric</PullFrequency>

</PullConnection>

</RelayServerDetails>

JSON

{

"General" : {

"Name" : "String",

"Description" : "String",

"RelayServerTypeId" : Numeric,

"RestrictContentDeliveryWindow" : "String",

"StartTime" : "String",

"EndTime" : "String",

"RelayServerId" : Numeric,

"Active" : "String"

"Assignment" : {

"ManagedBy" : "String",

"StagingServer" : [

Numeric,

Numeric

"ProductionServer" : [

Numeric,

Numeric

]

"DeviceConnection" : {

Chapter 6: Device Management

518

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"Protocol" : Numeric,

"Hostname" : "String",

"Port" : Numeric,

"User" : "String",

"Password" : "String",

"Path" : "String",

"PassiveMode" : "String",

"VerifyServer" : "String"

"ConsoleConnection" : {

"CopyValuesFromDeviceConnection" : "String",

"Protocol" : Numeric,

"Hostname" : "String",

"Port" : Numeric,

"User" : "String",

"Password" : "String",

"Path" : "String",

"PassiveMode" : "String",

"VerifyServer" : "String"

"PullConnection" : {

"PullLocalDirectory" : "String",

"PullDiscoveryText" : "String",

"PullFrequency" : Numeric

}

Response Tag Details

Tag Type Description

Name Yes Name of the relay server

Description No Description of the relay server

RelayServerTypeId Yes Unique identifier of the relay server type

RestrictContentDeliveryWindow No The time window which can be restricted for the content to be

delivered to the relay server

StartTime Yes Start of the time window for the content to be delivered to the

relay server

EndTime Yes End of the time window for the content to be delivered to the relay

server

RelayServerId Yes Unique identifier of the relay server

Active No Specifies if the relay server is active or not

ManagedBy Yes Unique organization group which manages the relay server

StagingServer Yes Specifies the number of staging servers required

Chapter 6: Device Management

519

VMware AirWatch REST API Guide | v.2016.04 | April 2017

ProductionServer Yes Specifies the number of production servers required

Protocol Yes Specifies the protocol used for relay server to connect to devices

Hostname Yes Specifies the hostname for devices to connect to the relay server

Port Yes Specifies the port number to connect devices with the relay server

User Yes User name to enter into the device to connect to the relay server

Password Yes Password for the relay server connection with devices

Path Yes Specify the path for devices to connect with the relay server

PassiveMode No The server selects the data port on behalf of the device

VerifyServer No Ensures that the connection is trusted and there are no SSLerrors

CopyValuesFromDeviceConnection Yes For the console connection, copy all the values from the device

connection details

Protocol Yes Specify the protocol used for the relay server to connect to the

console

Hostname Yes Specify the hostname for the console to connect to the relay

server

Port Yes Specify the port number to connect console with the relay server

User Yes User name to enter in the console to connect to the relay server

Password Yes Password for the relay server connection with the console

Path Yes Specify the path for console to connect with the relay server

PassiveMode No The server selects the data port on behalf of the device

VerifyServer No Ensures the connection is trusted and there are no SSLerrors

PullLocalDirectory Yes The specified pull local directory for the pull connection

PullDiscoveryText Yes The specified text for the pull discovery

PullFrequency Yes The specified frequency for the pull connection

Chapter 6: Device Management

520

VMware AirWatch REST API Guide | v.2016.04 | April 2017

Update Relay Server

Functionality – Updates the existing relay server details.

HTTP Method – PUT

API URI – https://host/api/mdm/relayservers

Response Obtained – NA

Request Payload

XML

<RelayServerDetails xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.air-

watch.com/webapi/resources">

<Name>String</Name>

<Description>String</Description>

<RelayServerTypeId>Numeric</RelayServerTypeId>

<RestrictContentDeliveryWindow>String</RestrictContentDeliveryWindow>

<StartTime>String</StartTime>

<EndTime>String</EndTime>

<RelayServerId>Numeric</RelayServerId>

<Active>String</Active>

</General>

<ManagedBy>String</ManagedBy>

<int>Numeric</int>

</StagingServer>

<int>Numeric</int>

</ProductionServer>

</Assignment>

<Protocol>Numeric</Protocol>

<Hostname>String</Hostname>

<Port>Numeric</Port>

<User>String</User>

<Password>String</Password>

<Path>String</Path>

<PassiveMode>String</PassiveMode>

<VerifyServer>String</VerifyServer>

</DeviceConnection>

<CopyValuesFromDeviceConnection>String</CopyValuesFromDeviceConnectio

Chapter 6: Device Management

521

VMware AirWatch REST API Guide | v.2016.04 | April 2017

<Protocol>Numeric</Protocol>

<Hostname>String</Hostname>

<Port>Numeric</Port>

<User>String</User>

<Password>String</Password>

<Path>String</Path>

<PassiveMode>String</PassiveMode>

<VerifyServer>String</VerifyServer>

</ConsoleConnection>

<PullLocalDirectory>String</PullLocalDirectory>

<PullDiscoveryText>String</PullDiscoveryText>

<PullFrequency>Numeric</PullFrequency>

</PullConnection>

</RelayServerDetails>

JSON

{

"General" : {

"Name" : "String",

"Description" : "String",

"RelayServerTypeId" : Numeric,

"RestrictContentDeliveryWindow" : "String",

"StartTime" : "String",

"EndTime" : "String",

"RelayServerId" : Numeric,

"Active" : "String"

"Assignment" : {

"ManagedBy" : "String",

"StagingServer" : [

"ProductionServer" : [

]

"DeviceConnection" : {

"Protocol" : Numeric,

"Hostname" : "String",

"Port" : Numeric,

"User" : "String",

"Password" : "String",

"Path" : "String",

"PassiveMode" : "String",

Chapter 6: Device Management

522

VMware AirWatch REST API Guide | v.2016.04 | April 2017

"VerifyServer" : "String"

"ConsoleConnection" : {

"CopyValuesFromDeviceConnection" : "String",

"Protocol" : Numeric,

"Hostname" : "String",

"Port" : Numeric,

"User" : "String",

"Password" : "String",

"Path" : "String",

"PassiveMode" : "String",

"VerifyServer" : "String"

"PullConnection" : {

"PullLocalDirectory" : "String",

"PullDiscoveryText" : "String",

"PullFrequency" : Numeric

}

Request Tag Details

Tag Mandatory Description

Name Yes Name of the relay server

Description No Description of the relay server

RelayServerTypeId Yes Unique identifier of the relay server type

RestrictContentDeliveryWindow No The time window which can be restricted for the content to be

delivered to the relay server.

StartTime Yes Start time of the relay server

EndTime Yes End time of the relay server

RelayServerId Yes Unique identifier of the relay server

Active No Is the relay server active or not.

ManagedBy Yes Unique organization group that manages the relay server

StagingServer Yes Specifies the number of staging servers required

ProductionServer Yes Specifies the number of production servers required

Protocol Yes Specifies the protocol used for relay server to connect to devices

Hostname Yes Specifies the hostname for devices to connect to the relay server

Port Yes Specifies the port number to connect devices with the relay

server

User Yes User name to enter into the device to connect to the relay server

Chapter 6: Device Management

523

VMware AirWatch REST API Guide | v.2016.04 | April 2017