Workspace ONE UEM APIs

https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/
Admin
Workspace ONE UEM APIs provide a collection of RESTful APIs that allow external programs to...
Tokens:1,855,227
Snippets:7,980
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example cURL Request for Profile Installation

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/g6d2ha8/new-installs-the-profile-on-device

An example cURL request demonstrating how to install a profile using the API. It includes the endpoint URL and the necessary JSON payload.

```cURL
curl --location --globoff '{{baseUrl}}/mdm/profiles/:profileid/install' \
--header 'Content-Type: application/json' \
--data '{ 
  "DeviceId": 1, 
  "Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b", 
  "SerialNumber": "LGH871c18f631a", 
  "MacAddress": "0x848506B900BA" 
}'
```

--------------------------------

### Successful Response Example

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/d7xribn/new-gets-the-installation-counts-for-an-internal-app-across-versions

This is an example of a successful JSON response when retrieving installation counts. It shows the `app_version_level_counts` array, detailing assigned, installed, and sideloaded counts for each application version.

```json
{
  "app_version_level_counts": [
    {
      "application_version": "2.0",
      "assigned_count": 101,
      "installed_count": 20,
      "sideloaded_count": 13
    }
  ]
}
```

--------------------------------

### Example cURL Request for Application Installation

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/a2p1swr/new-install-the-specified-purchased-application-on-the-device

This cURL example shows a typical request to install a purchased application. It includes the endpoint URL with a placeholder for the application UUID and the JSON payload specifying the target device.

```curl
curl --location --globoff '{{baseUrl}}/apps/purchased/:applicationUuid/install' \
--header 'Content-Type: application/json' \
--data '{ 
  "device_uuid": "b3df35f5-b36e-49cf-83a6-438cef467dba",
  "device_udid": "827BE1C5AEC05C378C61C44103E9D3FCB2EC354D",
  "serial_number": "BLCA34786H",
  "mac_address": "485A3F880798"
}'
```

--------------------------------

### cURL Example for Installing a Profile

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/9lme0tp/new-installs-the-profile-on-device

This cURL command demonstrates how to send a POST request to the install profile endpoint. Ensure you replace {{baseUrl}} and :profileid with your actual values. The Content-Type header must be application/json, and the body contains the device installation details.

```cURL
curl --location --globoff '{{baseUrl}}/profiles/:profileid/install' \
--header 'Content-Type: application/json' \
--data '{ 
  "DeviceId": 1,
  "Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
  "SerialNumber": "LGH871c18f631a",
  "MacAddress": "0x848506B900BA" 
}'
```

--------------------------------

### cURL Example for Installing Internal Application

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/w6bx2bk/installs-the-specified-internal-application-on-a-device

This cURL command demonstrates how to send a POST request to install an internal application. Ensure you replace {{baseUrl}} and :applicationid with your specific values.

```bash
curl --location --globoff '{{baseUrl}}/mam/apps/internal/:applicationid/install' \
--header 'Content-Type: application/json' \
--data '{ 
  "DeviceId": 1,
  "Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
  "SerialNumber": "LGH871c18f631a",
  "MacAddress": "0x848506B900BA" 
}'
```

--------------------------------

### Install Profile cURL Request

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/mo9xyn2/installs-the-profile-on-device

Example of how to send an install profile command to a device using cURL. Ensure to replace '{{baseUrl}}' and ':id' with actual values.

```curl
curl --location --globoff '{{baseUrl}}/devices/:id/commands/installprofile' \
--header 'Content-Type: application/json' \
--data '[ 
	{ 
		"payloadType": "in dolor oc",
		"payloadID": "irure",
		"payloadAttributes": {
			"in_4": {}
		}
	},
	{
		"payloadType": "irure minim dolor ad",
		"payloadID": "sed",
		"payloadAttributes": {
			"labore8": {},
			"deserunt9d": {}
		}
	}
]'
```

--------------------------------

### Product Download and Install Statistics Response (JSON)

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/678debh/retrieves-the-product-installation-and-download-statistics

Example JSON response structure for product download and install statistics. This includes device information and job statistics.

```json
{
  "ProductDownloadAndInstallStatistics": [
    {
      "DeviceID": 1,
      "FriendlyName": "conor QNX Qnx 6.5.0 1234",
      "SerialNumber": "ZSASQL1234",
      "ProductName": "Conor1",
      "ComplianceState": "Compliant",
      "JobStatistics": [
        {
          "DeviceProductJobId": 1,
          "LastDownloadDate": "07/17/17",
          "DownloadDuration": "10:23:10",
          "LastInstallDate": "07/17/15",
          "LastJobStatus": "Completed"
        }
      ]
    }
  ]
}
```

--------------------------------

### Example Request and Response for Android Work Settings

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/tik76fu/gets-the-android-work-settings-for-passed-location-group

This snippet shows an example cURL request to get Android Work Settings and a sample JSON response. The response includes details such as ServiceAccountEmail, EnterpriseId, and Setup Mode.

```cURL
curl --location --globoff '{{baseUrl}}/groups/:id/androidwork' \
--header 'Accept: application/json;version=1'
```

```json
{
  "ServiceAccountEmail": "Text value",
  "ServiceAccountClientId": "Text value",
  "ServiceAccountAdminEmail": "Text value",
  "EnterpriseId": "Text value",
  "AndroidWorkSetUpMode": "Text value",
  "CertificateSubjectName": "Text value",
  "PrimaryDomain": "Text value",
  "id": 1234,
  "uuid": "3e0392e9-0a08-467d-82e9-05a73ef95e69"
}
```

--------------------------------

### cURL Example for Installing Purchased Application

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/g2tvgu1/install-the-purchased-application-on-the-device

This cURL command demonstrates how to send a POST request to install a purchased application. Ensure you replace '{{baseUrl}}' and ':applicationid' with your actual values. The Content-Type header must be set to application/json.

```curl
curl --location --globoff '{{baseUrl}}/mam/apps/purchased/:applicationid/install' \
--header 'Content-Type: application/json' \
--data '{
  "DeviceId": 1,
  "Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
  "SerialNumber": "LGH871c18f631a",
  "MacAddress": "0x848506B900BA" 
}'
```

--------------------------------

### Get Important Updates for Windows PC Platform

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/chnfsl8/returns-important-updates-for-windows-pc-platform

Fetches a list of supported actions for important updates on the Windows PC platform. Example actions include 'Install Updates Automatically' and 'Download updates but let the user decide when to install them'.

```APIDOC
## GET /mdm/picklists/windowspcimportantupdates

### Description
Gets a list of supported actions for important updates for the Windows PC platform. These actions define how updates are handled, such as automatic installation or user-controlled installation.

### Method
GET

### Endpoint
{{baseUrl}}/mdm/picklists/windowspcimportantupdates

### Authorization
OAuth 2.0

### Request Example
```curl
curl --location --globoff '{{baseUrl}}/mdm/picklists/windowspcimportantupdates' \
--header 'Accept: application/json;version=1'
```

### Response
#### Success Response (200)
- **Description** (string) - A description of the update action.
- **Key** (string) - The key identifier for the update action.

#### Response Example
```json
[
  {
    "Description": "ut esse tempor",
    "Key": "non incididunt"
  },
  {
    "Description": "amet velit nisi voluptate",
    "Key": "irure eiusmod"
  }
]
```
```

--------------------------------

### GET /mdm/products/productdownloadandinstallstatistics

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/yutfaoq/retrieves-the-product-installation-and-download-statistics

Retrieves the product installation and download statistics for a given organization group. You can filter the results by specifying a start and end time, and control pagination with page and page size parameters.

```APIDOC
## GET /mdm/products/productdownloadandinstallstatistics

### Description
Retrieves the product installation and download statistics. This endpoint allows filtering by organization group, time range, and pagination.

### Method
GET

### Endpoint
{{baseUrl}}/mdm/products/productdownloadandinstallstatistics

### Parameters
#### Query Parameters
- **organizationgroupid** (string) - Optional - Organization group identifier.
- **starttime** (DateTime) - Optional - Filters the result where Product's Last modified date on device is greater than or equal to starttime value.
- **endtime** (DateTime) - Optional - Filters the result where Product's Last modified date on device is lesser than or equal to endtime value.
- **page** (integer) - Optional - Specific page number to get. 0 based index.
- **pagesize** (integer) - Optional - Maximum records per page. Default 500.

### Response
#### Success Response (200)
- **ProductDownloadAndInstallStatistics** (array) - An array of objects, where each object contains details about product downloads and installations.
  - **DeviceID** (integer)
  - **FriendlyName** (string)
  - **SerialNumber** (string)
  - **ProductName** (string)
  - **ComplianceState** (string)
  - **JobStatistics** (array)
    - **DeviceProductJobId** (integer)
    - **LastDownloadDate** (string)
    - **DownloadDuration** (string)
    - **LastInstallDate** (string)
    - **LastJobStatus** (string)

### Request Example
```curl
curl --location --globoff '{{baseUrl}}/products/productdownloadandinstallstatistics' \
--header 'Accept: application/json;version=1'
```

### Response Example
```json
{
  "ProductDownloadAndInstallStatistics": [
    {
      "DeviceID": 1,
      "FriendlyName": "conor QNX Qnx 6.5.0 1234",
      "SerialNumber": "ZSASQL1234",
      "ProductName": "Conor1",
      "ComplianceState": "Compliant",
      "JobStatistics": [
        {
          "DeviceProductJobId": 1,
          "LastDownloadDate": "07/17/17",
          "DownloadDuration": "10:23:10",
          "LastInstallDate": "07/17/15",
          "LastJobStatus": "Completed"
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Install Application cURL Example

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/ij2rquq/install-the-purchased-application-on-the-device

This cURL command demonstrates how to send a POST request to install a purchased application on a device. It includes the endpoint URL, content type, and the request body.

```curl
curl --location --globoff '{{baseUrl}}/apps/purchased/:applicationid/install' \
--header 'Content-Type: application/json' \
--data '{ 
  "DeviceId": 1,
  "Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
  "SerialNumber": "LGH871c18f631a",
  "MacAddress": "0x848506B900BA"
}'
```

--------------------------------

### cURL Example for Installing Public Application

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/6uh322t/installs-the-specified-public-application-on-a-device

Use this cURL command to send a request to install a public application on a device. Replace placeholders like {{baseUrl}} and :applicationid with actual values.

```bash
curl --location --globoff '{{baseUrl}}/apps/public/:applicationid/install' \
--header 'Content-Type: application/json' \
--data '{ 
	"DeviceId": 1,
	"Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
	"SerialNumber": "LGH871c18f631a",
	"MacAddress": "0x848506B900BA"
}'
```

--------------------------------

### Response Body Example

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/l0pvrqu/new-get-content-status-counts

This JSON structure represents a successful response from the 'New - Get content status counts' API. It includes counts for installed, uninstalled, assigned, acknowledged, and viewed devices, along with content details.

```json
{
  "content_uuid": "337004b8-3601-47e7-8867-4a0c79f8a699",
  "name": "Text value",
  "installed_device_count": 3,
  "uninstalled_device_count": 4,
  "assigned_device_count": 5,
  "acknowledged_count": 6,
  "viewed_count": 7,
  "required": true
}
```

--------------------------------

### GET New - Gets the devices where OEM Update Summary is installed

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/44mmy1i/new-gets-the-devices-where-oem-update-summary-is-installed-status-would-be-either-failed-or-success

This endpoint retrieves devices that have the OEM Update Summary installed. You can filter the results to include only devices where the installation status is either 'failed' or 'success'.

```APIDOC
## GET /api/v1/OemUpdatesV1/New

### Description
Retrieves a list of devices where the OEM Update Summary is installed, with the option to filter by installation status (failed or success).

### Method
GET

### Endpoint
/api/v1/OemUpdatesV1/New

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filters the results to include devices with a specific installation status. Accepted values are 'failed' or 'success'.

### Response
#### Success Response (200)
- **devices** (array) - A list of devices matching the query criteria.
  - **deviceId** (string) - The unique identifier for the device.
  - **oemUpdateStatus** (string) - The installation status of the OEM Update Summary ('failed' or 'success').
  - **lastChecked** (string) - The timestamp when the status was last checked.

#### Response Example
```json
{
  "devices": [
    {
      "deviceId": "device-123",
      "oemUpdateStatus": "success",
      "lastChecked": "2023-10-27T10:00:00Z"
    },
    {
      "deviceId": "device-456",
      "oemUpdateStatus": "failed",
      "lastChecked": "2023-10-27T10:05:00Z"
    }
  ]
}
```
```

--------------------------------

### cURL Example for Installing Public Application

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/9vu44xk/installs-the-specified-public-application-on-a-device

This cURL command demonstrates how to send a POST request to install a public application. Replace '{{baseUrl}}' and ':applicationid' with your specific values. The request body must be in JSON format.

```curl
curl --location --globoff '{{baseUrl}}/apps/public/:applicationid/install' \
--header 'Content-Type: application/json' \
--data '{ 
  "DeviceId": 1,
  "Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
  "SerialNumber": "LGH871c18f631a",
  "MacAddress": "0x848506B900BA"
}'
```

--------------------------------

### cURL Example for Installing Internal Application

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/3nsz4gy/installs-the-specified-internal-application-on-a-device

This cURL command demonstrates how to send a POST request to install an internal application. It includes the endpoint URL, content type, and the request body with device details.

```curl
curl --location --globoff '{{baseUrl}}/apps/internal/:applicationid/install' \
--header 'Content-Type: application/json' \
--data '{ 
	"DeviceId": 1,
	"Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
	"SerialNumber": "LGH871c18f631a",
	"MacAddress": "0x848506B900BA"
}'
```

--------------------------------

### Example Request for Pinned Host

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/8zilnuw/query-for-pinned-hosts-by-udid

This example demonstrates the request format for querying a pinned host by its GUID. It uses a placeholder for the base URL and the host GUID.

```cURL
curl --location --globoff --request DELETE '{{baseUrl}}/sslpinning/pinnedhost/:hostGuid'
```

--------------------------------

### Get VPN Types by Platform Request Example

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/pyzn4ag/gets-vpn-types-by-platform

This is an example of the cURL request to get VPN types by platform. Ensure the `Accept` header includes the correct API version.

```cURL
curl --location --globoff '{{baseUrl}}/picklists/platforms/:platform/vpntypes' \
--header 'Accept: application/json;version=1'
```

--------------------------------

### cURL Example for Installing Public Application

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/ha9l1zz/installs-the-specified-public-application-on-a-device

This cURL command demonstrates how to send a POST request to install a public application on a device. It includes the API endpoint and the JSON request body.

```curl
curl --location --globoff '{{baseUrl}}/mam/apps/public/:applicationid/install' \
--header 'Content-Type: application/json' \
--data '{ 
  "DeviceId": 1,
  "Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
  "SerialNumber": "LGH871c18f631a",
  "MacAddress": "0x848506B900BA"
}'
```

--------------------------------

### Example Response for Deployment Counts

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/mzmz7j0/new-gets-the-deployment-counts-for-an-internal-or-public-app

This is a sample JSON response indicating the application version and the counts for assigned, installed, and sideloaded deployments.

```json
{
  "application_version": "2.0",
  "assigned_count": 101,
  "installed_count": 20,
  "sideloaded_count": 13
}
```

--------------------------------

### Get BranchCache Statistics Request Example

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/kvnxx8c/new-gets-the-branchcache-statistics-for-the-application-bundle-identifier

This example demonstrates how to make a GET request to the BranchCache statistics endpoint using cURL. It includes the necessary URL and headers for the request.

```shell
curl --location --globoff '{{baseUrl}}/mam/apps/internal/peerdistribution/branchcache/:bundleid' \
--header 'Accept: application/json;version=2'
```

--------------------------------

### Example cURL Request

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/2gb4gu7/returns-the-details-of-the-device-for-which-provisioning-is-in-progress

An example cURL request to retrieve device provisioning status. This command targets a specific product ID and specifies the desired response format.

```cURL
curl --location --globoff '{{baseUrl}}/products/:id/inprogress' \
--header 'Accept: application/json;version=2'
```

--------------------------------

### Get Device Count for Application Actions (Request Example)

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/fy3bblx/new-gets-the-device-count-for-the-application-actions

This is an example of the request to get the device count for application actions. Ensure to replace `{{baseUrl}}` and `:uuid` with the correct values.

```cURL
curl --location --globoff '{{baseUrl}}/apps/:uuid/actioncounts' \
--header 'Accept: application/json;version=1'
```

--------------------------------

### Example JSON Response for Product File Actions

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/50o614m/get-specified-product-file-actions-by-product-id

This is an example of the JSON response structure you can expect when successfully retrieving product file actions. It includes details about files and installation/uninstallation manifests.

```json
{
  "FilesActionsDetails": [
    {
      "Id": 1,
      "Name": "DownloadFileAction",
      "Description": "Platform = 9000, Bundle Name = B9204",
      "Version": 2,
      "Platform": "Windows Rugged",
      "OrganizationGroupId": 3,
      "ModifiedOn": "01-01-2017 00:00:00",
      "Files": [
        {
          "FileId": 1,
          "Name": "Background.png",
          "Path": "\\NewPackages\\Temp_Content\\images\\backgrounds\\Background.png"
        }
      ],
      "InstallManifests": [
        {
          "ActionType": "CreateFolder",
          "Critical": "Continue",
          "FilePathAndName": "\\NewPackages\\Content",
          "SourceFilePathAndName": "\\NewPackages\\Content",
          "TargetFilePathAndName": "\\NewPackages\\Content",
          "PathAndNameOfFolder": "\\NewPackages\\Content",
          "TargetFolderPathAndName": "\\NewPackages\\Content",
          "CommandLineAndArgumentsToRun": "\"\\Program Files\\Airwatch\\awprofileimport.exe\" \"\\Profile.xml\"",
          "TimeOut": "-1",
          "ProcessOrAppToTerminate": "iptools.exe",
          "NameOfProgramToUninstall": "/sdcard/iptools.apk",
          "AirwatchMdmAgentUpgradeFile": "AirWatchAgent_7.3.0.167_AirWatchService_2.2.0.7_0.9.apf",
          "ExecuteAsRoot": "True",
          "Wait": "false",
          "OsFile": "FullPackageUpdate_User_Keys_Release_2017.zip",
          "InstallUnManagedApp": "/sdcard/hello.apk",
          "UnInstallUnManagedApp": "com.ddm.iptools",
          "ScriptFilePathAndName": "\\Content\\Temp\\Script.sh",
          "ScriptToExecute": "shellexec.sh",
          "SoftwareToInstall": "Application.app",
          "InstallFilePath": "/UATest/googlechrome.dmg",
          "CustomSettingsFile": "custom.xml"
        }
      ],
      "UninstallManifests": [
        {}
      ]
    }
  ]
}
```

--------------------------------

### Get Content Gateway Configurations Request Example

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/6u9aqpg/new-gets-the-content-gateway-configurations

This is an example of the request to get content gateway configurations. It includes the base URL, group ID, and the required Accept header.

```cURL
curl --location --globoff '{{baseUrl}}/V2/groups/:groupId/contentgateway' \
--header 'Accept: application/json;version=1'
```

--------------------------------

### Example Request and Response for OEM Update Summary

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/ls3ijer/new-gets-the-count-of-oemupdate-summary-installed-in-devices-for-a-given-release-id-version

This snippet shows an example cURL request and its corresponding JSON response for the OEM update summary. The response includes counts for successful and failed installations.

```cURL
curl --location --globoff '{{baseUrl}}/mdm/oem-updates/v1/groups/:uuid/summary/status?release_id=&version='
--header 'Accept: application/json;version=1'
```

```json
[
  {
    "release_id": "mollit ex irure reprehenderit",
    "version": "mollit cupidatat",
    "success_count": -45582596,
    "failed_count": -65693844
  },
  {
    "release_id": "fugiat voluptate velit qui Duis",
    "version": "officia laborum",
    "success_count": -54002746,
    "failed_count": 25195654
  }
]
```

--------------------------------

### Get PayloadKeys Response Example

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/65s219p/gets-payloadkeys

Example JSON response for a successful Get PayloadKeys request. It includes detailed general settings for a profile, such as ProfileId, Name, Version, and assignment details.

```json
{
  "General": {
    "ProfileId": 1,
    "AfwOemSettingsEnabled": true,
    "AfwOemType": 0,
    "Name": "Text value",
    "Description": "Text value",
    "ProfileScope": "Production",
    "Version": 4,
    "CreateNewVersion": true,
    "AssignmentType": "Auto",
    "ProfileContext": "Text value",
    "EnableProvisioning": true,
    "IsActive": true,
    "IsManaged": true,
    "Password": "Text value",
    "AllowRemoval": "Always",
    "AssignedSmartGroups": [
      {
        "SmartGroupId": 1,
        "Name": "Text value"
      }
    ],
    "ExcludedSmartGroups": [
      {
        "SmartGroupId": 0
      }
    ],
    "ManagedLocationGroupID": 12,
    "AssignedGeofenceArea": [
      1
    ],
    "AssignedSchedule": [
      1
    ],
    "ProfileUuid": "9d3e2211-24be-494a-916b-f4f20d6f68bc",
    "IsProvisionedForOobe": true
  }
}
```

--------------------------------

### Get Rating Apps Configuration Example (cURL)

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/3n3yv01/gets-the-values-that-can-be-configured-for-rating-apps-ratingapps-in-apple-restrictions-profile

An example cURL request to fetch rating app configurations. This command sends a GET request with the specified Accept header to the API endpoint.

```shell
curl --location --globoff '{{baseUrl}}/mdm/picklists/appleratingapps' \
--header 'Accept: application/json;version=1'
```

--------------------------------

### cURL Example for Registering Device

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/t6h3w7f/register-a-device-to-enrollment-user

This cURL command demonstrates how to send a POST request to register a device to an enrollment user. Ensure to replace `{{baseUrl}}` and `:id` with your specific environment URL and user ID.

```bash
curl --location --globoff '{{baseUrl}}/users/:id/registerdevice' \
--header 'Content-Type: application/json' \
--data-raw '{ \
	"LocationGroupId": 1, \
	"FriendlyName": "TestUser\'s iPhone", \
	"Ownership": "E", \
	"PlatformId": 2, \
	"ModelId": 3, \
	"OperatingSystemId": 4, \
	"Udid": "ea856771ba6277bfca16528a79c5ce1f", \
	"SerialNumber": "RZ1G124JZ6W", \
	"Imei": "351822059334112", \
	"AssetNumber": "ea856771ba6277bfca16528a79c5ce1f", \
	"MessageType": 0, \
	"MessageTemplateId": "1", \
	"SIM": "Sim Details", \
	"ToEmailAddress": "noreply@vmware.com", \
	"ToPhoneNumber": "4044787500", \
	"Tags": [ \
		{ \
			"Name": "Text value" \
		} \
	], \
	"CustomAttributes": [ \
		{ \
			"uuid": "a91047d5-9c93-4707-a1b8-9cf828a973b5" \
		} \
	], \
	"IsMigration": true, \
	"uuid": "a7a41fcf-2ab6-4099-b735-f081e5769711" \
}'
```

--------------------------------

### Get Installed OemUpdate Summary Count

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/iu6d03j/new-gets-the-count-of-oemupdate-summary-installed-in-devices-for-a-given-summaryid

Fetches the count of devices where a specific OemUpdate Summary is installed.

```APIDOC
## GET /mdm/groups/:uuid/oemupdates/summary/:summaryUuid/status

### Description
Gets the count of OemUpdate Summary installed in devices for a given summaryID.

### Method
GET

### Endpoint
{{baseUrl}}/mdm/groups/:uuid/oemupdates/summary/:summaryUuid/status

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier for the group.
- **summaryUuid** (string) - Required - The unique identifier for the OemUpdate Summary.

### Response
#### Success Response (200)
- **count** (integer) - The number of devices with the specified OemUpdate Summary installed.
```

--------------------------------

### Get macOS Passcode Autolock Options Request Example

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/652f9dh/gets-the-values-that-can-be-configured-for-passcode-autolock-in-minutes-maxinactivity-in-apple-macos-passcode-profile

This is an example of the cURL request to get the configurable values for passcode autolock in minutes for Apple macOS passcode profiles. It specifies the endpoint and the desired API version.

```cURL
curl --location --globoff '{{baseUrl}}/mdm/picklists/appleosxpasscodeautolock' \
--header 'Accept: application/json;version=1'
```

--------------------------------

### Get Devices with OEM Update Summary

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/xubihrx/new-gets-the-devices-where-oem-update-summary-is-installed-status-would-be-either-failed-or-success

Fetches devices where the OEM Update Summary is installed, filtering by installation status.

```APIDOC
## GET /mdm/oem-updates/v1/groups/:uuid/summary/devices

### Description
Retrieves a list of devices that have the OEM Update Summary installed. The status of the installation can be either 'failed' or 'success'.

### Method
GET

### Endpoint
/mdm/oem-updates/v1/groups/:uuid/summary/devices

### Query Parameters
- **release_id** (string) - Optional - The ID of the OEM update release.
- **version** (string) - Optional - The version of the OEM update.
- **status** (string) - Optional - The installation status of the OEM update. Accepted values are 'failed' or 'success'.
```

--------------------------------

### GET /mdm/picklists/windowspcencryptedvolume

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/fgkgqei/returns-encrypted-volume-for-windows-pc-platform

Gets a list of encrypted volumes for encryption profile. Example : Complete Hard Disk, System Partition.

```APIDOC
## GET /mdm/picklists/windowspcencryptedvolume

### Description
Retrieves a list of available encrypted volume types for Windows PC encryption profiles. This can include options like 'Complete Hard Disk' or 'System Partition'.

### Method
GET

### Endpoint
{{baseUrl}}/mdm/picklists/windowspcencryptedvolume

### Parameters
#### Query Parameters
- **version** (string) - Optional - Specifies the API version. Example: `version=1`

### Headers
- **Accept**: `application/json;version=1`

### Authorization
OAuth 2.0

### Response
#### Success Response (200 OK)
- **Description** (string) - A description of the encrypted volume type.
- **Key** (string) - The key identifier for the encrypted volume type.

### Response Example
```json
[
  {
    "Description": "aliqua fugiat ad in",
    "Key": "dolor laboris reprehenderit in"
  },
  {
    "Description": "labore mollit cupidatat",
    "Key": "ut culpa consequat"
  }
]
```
```

--------------------------------

### cURL Example for Creating a Product

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/aicfuzw/creates-a-new-product

This cURL command demonstrates how to send a POST request to create a new product, including the necessary headers and JSON payload.

```bash
curl --location --globoff '{{baseUrl}}/products/create' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json;version=1' \
--data '{ 
	"PlatformID": 5,
	"Name": "Example",
	"ManagedByOrganizationGroupID": "570",
	"Description": "Just an example.",
	"Active": false,
	"Manifest": {
		"Action": [
			{
				"ActionTypeID": 1,
				"ItemID": 1,
				"Persist": false,
				"AppTunneling": false,
				"AndroidLegacyVpnProfileUuid": "2b359d1c-d3e9-493f-8fa0-48d86fbbfeda",
				"AndroidForWorkVpnProfileUuid": "fd96d357-e4fd-4284-83af-ebd788869ec0"
			}
		]
	},
	"TotalAssigned": 0,
	"Compliant": 0,
	"InProgress": 0,
	"Failed": 0,
	"ActivationDateTime": "01/01/2017 10:00:00",
	"DeactivationDateTime": "01/01/2017 10:00:00",
	"PauseResume": true,
	"DeploymentMode": 0,
	"DevicePolicyTypeID": 2,
	"AutoRetry": true,
	"DeviceReprocess": true,
	"DevicePolicyUuid": "10ee8610-40eb-419e-817d-e4689bef0f6e",
	"IsExpedited": true,
	"Version": 4,
	"ProductETag": "70B0B586520046C685CF218BCC10D828"
}'
```

--------------------------------

### Get Devices with Installed OEM Update Summary

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/zqy5tm5/new-gets-the-devices-where-oem-update-summary-is-installed-status-would-be-either-failed-or-success

Fetches devices that have a specific OEM Update Summary installed, indicating whether the installation succeeded or failed. Supports pagination through query parameters.

```APIDOC
## GET /mdm/groups/:uuid/oemupdates/summary/:summaryUuid/devices

### Description
Returns the devices where the OEM Update is installed (status would be either failed or success).

### Method
GET

### Endpoint
{{baseUrl}}/mdm/groups/:uuid/oemupdates/summary/:summaryUuid/devices

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Specific page number to get. 0 based index.
- **pageSize** (integer) - Optional - Maximum records per page. Default 50.

#### Path Parameters
- **uuid** (string) - Required - Organization group UUID to perform the operation on.
- **summaryUuid** (string) - Required - Unique value of the OEM Update Summary detail to perform the operation on.

### Request Example
```json
{
  "example": "curl --location --globoff '{{baseUrl}}/mdm/groups/:uuid/oemupdates/summary/:summaryUuid/devices' \
--header 'Accept: application/json;version=1'"
}
```

### Response
#### Success Response (200)
- **deviceIdList** (array) - List of device IDs.
- **id** (integer) - The ID of the OEM Update Summary.
- **uuid** (string) - The UUID of the OEM Update Summary.

#### Response Example
```json
[
  {
    "deviceIdList": [
      91722814,
      -32414372
    ],
    "id": -64973566,
    "uuid": "00000000-0000-0000-0000-000000000000"
  },
  {
    "deviceIdList": [
      -19879877,
      14882717
    ],
    "id": -94223231,
    "uuid": "00000000-0000-0000-0000-000000000000"
  }
]
```
```

--------------------------------

### Execute Start AirPlay

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/25em5mk/executes-start-airplay-for-a-specific-device

Initiates the AirPlay feature for a designated device.

```APIDOC
## POST /api/v1/commands/executes-start-airplay-for-a-specific-device

### Description
Executes the start AirPlay command for a specific device.

### Method
POST

### Endpoint
/api/v1/commands/executes-start-airplay-for-a-specific-device

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
This endpoint requires a request body to specify the device and any AirPlay parameters.

### Request Example
```json
{
  "deviceId": "string",
  "airplayOptions": {
    "targetDevice": "string",
    "password": "string"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the command execution.
- **message** (string) - Provides details about the command execution result.

#### Response Example
```json
{
  "status": "Success",
  "message": "AirPlay command initiated successfully for device."
}
```
```

--------------------------------

### Example Response for Get Products

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/5ote2r6/get-the-products-based-on-application-id

This is an example of a successful JSON response when retrieving product assignments. It lists ProductID and AssignmentDate for each assigned product.

```json
[
  {
    "ProductID": 78238832,
    "AssignmentDate": "tempor deserunt"
  },
  {
    "ProductID": 5972557,
    "AssignmentDate": "sunt eu aliquip"
  }
]
```

--------------------------------

### cURL Example for Starting AirPlay

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/20ognx5/executes-start-airplay-for-a-specific-device

This cURL command demonstrates how to send the start AirPlay request to a specific device. Ensure you replace '{{baseUrl}}' and ':deviceid' with your actual base URL and device ID.

```curl
curl --location --globoff '{{baseUrl}}/mdm/devices/:deviceid/commands/startairplay' \
--header 'Content-Type: application/json' \
--data '{ 
  "DestinationName": "abc",
  "DestinationDeviceId": "11:22:33:23:12:14",
  "Passcode": "123",
  "Scantime": "30"
}'
```

--------------------------------

### cURL Example for Creating an Enrollment Token

Source: https://www.postman.com/workspace-one-uem/workspace-one-uem-apis/request/n9zbol7/new-create-an-enrollment-token

This cURL command demonstrates how to send a POST request to create an enrollment token. Ensure the Content-Type and Accept headers are correctly set.

```bash
curl --location --globoff '{{baseUrl}}/enrollment-tokens' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json;version=4' \
--data-raw '{
  "organization_group_uuid": "8a3f4382-f293-4f57-ac63-887fde83fdb7",
  "enrollment_user_uuid": "a978de12-6ed5-4332-9c0b-f1e0ce5c4c41",
  "friendly_name": "BLCXY445TH",
  "ownership_type": "CORPORATE_DEDICATED",
  "device_type": "UNKNOWN",
  "model_id": 2,
  "operating_system_id": 3,
  "device_udid": "827BE1C5AEC05C378C61C44103E9D3FCB2EC354D",
  "serial_number": "BLCA34786H",
  "model_number": "BLCA34786H",
  "imei": "351822059334112",
  "asset_number": "AQOPJ76G",
  "sid": "Text value",
  "message_template_uuid": "ffa65b17-613c-402f-b728-a4fb0bb60b30",
  "sim": "SIM Details",
  "to_email_address": "support@vmware.com",
  "to_phone_number": "919898989898",
  "is_migration": true,
  "message_type": "Email",
  "tags": [
    {
      "name": "TagOne"
    }
  ],
  "custom_attributes": [
    {
      "name": "identity.deviceModel",
      "value": "TC25",
      "application": "com.vmware.agent.identity.xml"
    }
  ]
}'
```
Tokens:
Raw