WindowsComponent | Parallels REST API

List

Retrieve Default Windows Custom Component

GET/api/VDIDefaultSettings/Optimization/WindowsComponent

Query parameters

Response

Success

Body

typeDetailsType (enum)

Details Type

0 = Predefined,1 = Custom

componentNamenullable string

Windows Components Name

displayNamenullable string

Windows Components Display Name

aliasesnullable string

Windows Components Aliases

Request

const response = await fetch('/api/VDIDefaultSettings/Optimization/WindowsComponent', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "componentName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

Add

Adds a default Windows Component Custom to optimization.

POST/api/VDIDefaultSettings/Optimization/WindowsComponent

Query parameters

Body

Windows Componenct Custom Settings.

aliasesnullable string

Windows Components Alias

displayNamenullable string

Windows Components Diplay Name

componentNamenullable string

Windows Components Name

Response

Created

Request

const response = await fetch('/api/VDIDefaultSettings/Optimization/WindowsComponent', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Removes Default Windows Component Custom From Optimization.

DELETE/api/VDIDefaultSettings/Optimization/WindowsComponent

Query parameters

Body

Windows Componenct Custom Settings

componentNamenullable string

Windows Component Name

Response

No Content

Request

const response = await fetch('/api/VDIDefaultSettings/Optimization/WindowsComponent', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}