Convert To Desktop
Request
URI
POST
https://{api_host}/dt-rest/v100/infrastructure/pattern/gold/{id}/convert/desktop
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 Gold Pattern Operations
POST
Convert To Desktop
POST
Copy From Gold Pattern
GET
Create Agent Update Filter
POST
Delete
POST
Delete Backup
GET
Get
GET
Get Applications
GET
Get Available Agent Update Details
POST
Get Available Agent Update Details
GET
Get Available Agent Update On Pattern
GET
Get Backup Count
GET
Get Backup Info
GET
Get Data Centers
GET
Get Desktop Manager Id
GET
Get Pools
POST
Get Update Agent Status On Pattern
GET
Get Virtual Machine
POST
Perform Backup
POST
Perform Rollback
PUT
Rename
PUT
Rename Pattern
GET
Session Farms
PUT
Update
POST
Update Agents On Gold Pattern
GET
Validate For Gold Pattern
GET
Validate Gold Pattern For Element