Get Task Report
Request
URI
POST
https://{api_host}/dt-rest/v100/task/manager/taskReport
COPY
Request Body
DtTaskFilterImpl
of type(s)
application/json
Optional
{
"id": "string",
"limit": 0,
"limitOneTaskTypePerPool": false,
"fromDate": "string",
"toDate": "string",
"taskId": "string",
"taskIdList": [
"string"
],
"poolId": [
0
],
"taskStatus": [
"string"
],
"offset": 0,
"sortOrderItems": [
{
"sortingAttribute": "string",
"sortingType": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"self": {
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
},
"location": "string",
"DtLink": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
string
id
Optional
id
integer As int32
As int32
limit
Optional
limit
boolean
limitOneTaskTypePerPool
Optional
limitOneTaskTypePerPool
string As date-time
As date-time
fromDate
Optional
fromDate
string As date-time
As date-time
toDate
Optional
toDate
string
taskId
Optional
taskId
array of
string
taskIdList
Optional
taskIdList
array of
integer
poolId
Optional
poolId
array of
string
taskStatus
Optional
taskStatus
Possible values are :
OTHER,
RUNNING,
SUCCESSFUL,
FAILED,
QUEUED,
CANCELLING,
CANCELLED,
PARTIAL_SUCCESSFUL,
integer As int32
As int32
offset
Optional
offset
string
location
Optional
location
Responses
200
successful operation
Returns
DtTaskReport
of type(s)
*/*
{
"taskCount": 0,
"tasks": [
{
"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"
}
]
}
],
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
integer As int64
As int64
taskCount
Optional
taskCount
string
id
Optional
id
Dt Task Manager Operations
POST
Cancel Tasks
GET
Create Task Filter
POST
Get Child Tasks
GET
Get Supported Links
POST
Get Task Report
POST
Get Tasks