Delete Pool And All Contents
Request
URI
DELETE
https://{api_host}/dt-rest/v100/infrastructure/pool/desktop/{id}/delete/all
COPY
Path Parameters
string
id
Required
id
Responses
200
Returns
DtPoolTask
of type(s)
*/*
{
"type": "string",
"agentVersion": "string",
"vmName": "string",
"status": "string",
"pattern": {
"templateId": "string",
"desktopManagerName": "string",
"lastUpdated": "string",
"deleted": false,
"dataCenterName": "string",
"dependantPoolIds": [
"string"
],
"dataCenters": [
{
"defaultDomain": "string",
"vmgrId": "string",
"description": "string",
"friendlyName": "string",
"frontNetworkId": "string",
"frontNetworkType": "string",
"ipAddressBlock": "string",
"subnetMask": "string",
"gateway": "string",
"vmgrUIDs": [
"string"
],
"assignedOrganizationIds": [
0
],
"lastUpdate": "string",
"ntpServers": [
"string"
],
"backBoneNetworkId": "string",
"backBoneNetworkType": "string",
"dnsServer": "string",
"cimuserPassword": "string",
"creationDate": "string",
"appliancePassword": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"desktopManagerId": "string",
"basedOn": "string",
"diskSize": 0,
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"desktopPoolId": "string",
"statusDescription": "string",
"percentageComplete": 0,
"agentDisplayName": "string",
"startDate": "string",
"pool": {
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
},
"taskHistory": [
{
"state": "string",
"description": "string",
"dateUpdated": "string",
"errorCode": "string",
"objectId": "string",
"taskId": "string",
"percentageCompleted": 0,
"dateUpdatedLocaleString": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"cancellable": false,
"taskPatternsOrVmIds": [
"string"
],
"hasChildTasks": false,
"createdBy": "string",
"assignmentType": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
string
type
Optional
type
string
agentVersion
Optional
agentVersion
string
vmName
Optional
vmName
string
status
Optional
status
Possible values are :
OTHER,
RUNNING,
SUCCESSFUL,
FAILED,
QUEUED,
CANCELLING,
CANCELLED,
PARTIAL_SUCCESSFUL,
string
desktopPoolId
Optional
desktopPoolId
string
statusDescription
Optional
statusDescription
integer As int32
As int32
percentageComplete
Optional
percentageComplete
string
agentDisplayName
Optional
agentDisplayName
string As date-time
As date-time
startDate
Optional
startDate
boolean
cancellable
Optional
cancellable
array of
string
taskPatternsOrVmIds
Optional
taskPatternsOrVmIds
boolean
hasChildTasks
Optional
hasChildTasks
string
createdBy
Optional
createdBy
string
assignmentType
Optional
assignmentType
string
id
Optional
id
202
Returns
DtPoolTask
of type(s)
*/*
{
"type": "string",
"agentVersion": "string",
"vmName": "string",
"status": "string",
"pattern": {
"templateId": "string",
"desktopManagerName": "string",
"lastUpdated": "string",
"deleted": false,
"dataCenterName": "string",
"dependantPoolIds": [
"string"
],
"dataCenters": [
{
"defaultDomain": "string",
"vmgrId": "string",
"description": "string",
"friendlyName": "string",
"frontNetworkId": "string",
"frontNetworkType": "string",
"ipAddressBlock": "string",
"subnetMask": "string",
"gateway": "string",
"vmgrUIDs": [
"string"
],
"assignedOrganizationIds": [
0
],
"lastUpdate": "string",
"ntpServers": [
"string"
],
"backBoneNetworkId": "string",
"backBoneNetworkType": "string",
"dnsServer": "string",
"cimuserPassword": "string",
"creationDate": "string",
"appliancePassword": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"desktopManagerId": "string",
"basedOn": "string",
"diskSize": 0,
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"desktopPoolId": "string",
"statusDescription": "string",
"percentageComplete": 0,
"agentDisplayName": "string",
"startDate": "string",
"pool": {
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
},
"taskHistory": [
{
"state": "string",
"description": "string",
"dateUpdated": "string",
"errorCode": "string",
"objectId": "string",
"taskId": "string",
"percentageCompleted": 0,
"dateUpdatedLocaleString": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"cancellable": false,
"taskPatternsOrVmIds": [
"string"
],
"hasChildTasks": false,
"createdBy": "string",
"assignmentType": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
string
type
Optional
type
string
agentVersion
Optional
agentVersion
string
vmName
Optional
vmName
string
status
Optional
status
Possible values are :
OTHER,
RUNNING,
SUCCESSFUL,
FAILED,
QUEUED,
CANCELLING,
CANCELLED,
PARTIAL_SUCCESSFUL,
string
desktopPoolId
Optional
desktopPoolId
string
statusDescription
Optional
statusDescription
integer As int32
As int32
percentageComplete
Optional
percentageComplete
string
agentDisplayName
Optional
agentDisplayName
string As date-time
As date-time
startDate
Optional
startDate
boolean
cancellable
Optional
cancellable
array of
string
taskPatternsOrVmIds
Optional
taskPatternsOrVmIds
boolean
hasChildTasks
Optional
hasChildTasks
string
createdBy
Optional
createdBy
string
assignmentType
Optional
assignmentType
string
id
Optional
id
Dt Desktop Pool Operations
PUT
Assign Group
PUT
Assign User To Pool
DELETE
Delete
DELETE
Delete Pool And All Contents
GET
Get
GET
Get All Virtual Machines
GET
Get Groups Of Pool
GET
Get Patterns
GET
Get Remote Applications
GET
Get User Desktop Mappings
GET
Get Users Assigned By Admin
GET
Get Users Of Pool
GET
Get Virtual Machines
GET
Is VM Refresh Required
PUT
Remove Group
PUT
Remove Group And Auto Assigned Pattern Mappings
PUT
Remove Group And Create User Pool Mappings
PUT
Remove User From Pool
PUT
Update
PUT
Update Without Group Entitlements
POST
Validate Update Request