URL
GET https://{api-url}/api/v2/tenants/{tenantId}/tasks/{taskId}Sample URLs
https://{api-url}/api/v2/tenants/client_1000/tasks/TASK0000000244Notes
- The response contains time spent (timeSpent) and estimated hours (estimatedHours) both in minutes format.
- Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
Status code
200 OK
Sample response
{
"id": "TASK0000000244",
"subject": "Set SLA Reminders",
"description": "SLA Reminders for Client A",
"status": "Resolved",
"oldStatus": "Open",
"priority": "Normal",
"oldPriority": "Low",
"requester": {
"loginName": "John.Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com"
},
"assignedUser": {
"id": "USR0000000014",
"loginName": "James.Rivers",
"lastName": "Rivers",
"firstName": "James",
"email": "james.rivers@myorganization.com"
},
"assigneeGroup": {
"id": 7,
"name": "Brocade Lab Users",
"description": "All Brocade Lab Users group"
},
"resources": [{
"id": "481af404-33a6-4d61-af77-c483ca6641fa",
"name": "VTHLPT1000",
"type": "EBS",
"metaData": {},
"resourceType": "EBS",
"hostName": "",
"resourceName": "vol-07f80c5e8ffc69b40",
"aliasName": "EBS alias"
},
{
"id": "e3ef168f-dbb7-43f6-ad6a-c052a85be34f",
"name": "abc",
"type": "Desktop",
"metaData": {},
"resourceType": "Desktop",
"hostName": "",
"resourceName": "abc",
"aliasName": "Desktop alias"
}
],
"customFields": [{
"id": "UDF0000003808",
"classCode": "TASK",
"displayLabel": "text field",
"name": "text_field_3808",
"fieldType": "TYPE_TEXT",
"mandatory": false,
"editable": true,
"description": "all partners",
"value": "available",
"defaultValue": ""
},
{
"id": "UDF0000003810",
"classCode": "TASK",
"displayLabel": "numeric",
"name": "numeric_3810",
"fieldType": "TYPE_NUMBER",
"mandatory": false,
"editable": true,
"description": "testing numeric",
"value": "120",
"defaultValue": ""
},
{
"id": "UDF0000003790",
"classCode": "TASK",
"displayLabel": "drop-down-api-lab",
"name": "drop_down_api_lab_3790",
"fieldType": "TYPE_DROPDOWN",
"mandatory": false,
"editable": true,
"description": "Test case",
"options": [{
"label": "first",
"value": "1"
},
{
"label": "second",
"value": "2"
}
],
"value": "1",
"defaultValue": "",
"selectedOption": {
"label": "first",
"value": "1"
}
},
{
"id": "UDF0000003791",
"classCode": "TASK",
"displayLabel": "text-api-lab",
"name": "text_api_lab_3791",
"fieldType": "TYPE_TEXT",
"mandatory": false,
"editable": true,
"description": "test case for text field",
"value": "request custom field - text-updated",
"defaultValue": "Test Text"
},
{
"id": "UDF0000003792",
"classCode": "TASK",
"displayLabel": "multi line text-api-lab",
"name": "multi_line_text_api_lab_3792",
"fieldType": "TYPE_TEXTAREA",
"mandatory": false,
"editable": true,
"description": "test case for multi line text",
"value": "text",
"defaultValue": "multi \nline \ntext"
},
{
"id": "UDF0000003793",
"classCode": "TASK",
"displayLabel": "Numeric-api-lab",
"name": "numeric_api_lab_3793",
"fieldType": "TYPE_NUMBER",
"mandatory": false,
"editable": true,
"description": "numeric test case",
"value": "1",
"defaultValue": "1"
},
{
"id": "UDF0000003794",
"classCode": "TASK",
"displayLabel": "checkbox-api-lab",
"name": "checkbox_api_lab_3794",
"fieldType": "TYPE_CHECKBOX",
"mandatory": false,
"editable": true,
"description": "test case for check box",
"options": [{
"label": "yes",
"value": "1"
}],
"value": "1",
"defaultValue": "0",
"selectedOption": {
"label": "yes",
"value": "1"
}
},
{
"id": "UDF0000003795",
"classCode": "TASK",
"displayLabel": "Date-ap-lab",
"name": "date_ap_lab_3795",
"fieldType": "TYPE_DATE",
"mandatory": false,
"editable": true,
"description": "test case for date field",
"value": "2016-02-26T00:00:00+0000",
"defaultValue": "2016-02-26T00:00:00+0000"
},
{
"id": "UDF0000003796",
"classCode": "TASK",
"displayLabel": "dateTime-api-lab",
"name": "datetime_api_lab_3796",
"fieldType": "TYPE_DATETIME",
"mandatory": false,
"editable": true,
"description": "test case for Date and time",
"value": "2016-02-26T12:13:00+0000",
"defaultValue": "2016-02-26T12:13:00+0000"
}
],
"cc": "service.admin@myorganization.com, support@myorganization.com",
"ticketArisedTime": "",
"createdUser": {
"loginName": "John.Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com"
},
"reason": "Resolve Task",
"alertIds": [],
"reOpenCount": 1,
"createdDate": "2016-07-29T11:22:28+0000",
"allowedStatus": [{
"id": "1",
"name": "New",
"reasonsEnabled": false,
"reasonsDefined": false
},
{
"id": "2",
"name": "Open",
"reasonsEnabled": true,
"reasonsDefined": true
},
{
"id": "3",
"name": "Pending",
"reasonsEnabled": true,
"reasonsDefined": false
},
{
"id": "5",
"name": "Closed",
"reasonsEnabled": true,
"reasonsDefined": true
},
{
"id": "6",
"name": "On Hold",
"reasonsEnabled": true,
"reasonsDefined": false
}
],
"client": {
"id": 8,
"uniqueId": "client_8",
"name": "Brocade Lab",
"activated": true
},
"updatedDate": "2016-08-12T08:10:17+0000",
"priorityUpdatedBy": {
"loginName": "James.Rivers",
"lastName": "Rivers",
"firstName": "James",
"email": "james.rivers@myorganization.com"
},
"priorityUpdatedDate": "2016-08-12T08:06:18+0000",
"statusUpdatedBy": {
"loginName": "James.Rivers",
"lastName": "Rivers",
"firstName": "James",
"email": "james.rivers@myorganization.com"
},
"statusUpdatedDate": "2016-08-12T08:08:38+0000",
"resolvedDate": "2016-08-12T08:08:38+0000",
"slaDetails": {
"resolutionTime": 1197960,
"responseTime": 1197943,
"responseBreach": false,
"resolutionBreach": false,
"responseBreachDate": "",
"resolutionBreachDate": ""
},
"source": "PORTAL",
"startDate": "2016-07-13T04:43:00+0000",
"endDate": "2016-08-31T04:04:00+0000",
"estimatedHours": 10,
"timeSpent": 40,
"statusFlow": [{
"status": "New",
"timeSpent": 1492634,
"createdDate": "2016-07-25T12:42:19+0000",
"updatedBy": {
"loginName": "John.Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@domain.com"
}
},
{
"status": "Resolved",
"reason": "Resolving as fixed",
"notes": "resolution summary",
"timeSpent": 18,
"createdDate": "2016-08-11T19:19:33+0000",
"updatedBy": {
"loginName": "James.Rivers",
"lastName": "Rivers",
"firstName": "James",
"email": "james.rivers@myorganization.com",
"phoneNumber": "085597783"
}
},
{
"status": "Open",
"reason": "Re-Opening as not fixed",
"timeSpent": 27,
"createdDate": "2016-08-11T19:19:51+0000",
"updatedBy": {
"loginName": "John.Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com",
"phoneNumber": "085597783"
}
},
{
"status": "Resolved",
"reason": "Validated with changes and Resolving as fixed",
"notes": "resolution summary",
"createdDate": "2016-11-22T10:04:50+0000",
"updatedBy": {
"id": "USR0000000018",
"loginName": "James.Rivers",
"lastName": "Rivers",
"firstName": "James",
"email": "james.rivers@myorganization.com"
}
}
],
"knowledgeArticleIds": [
30, 10
],
"attachedArticles": [{
"id": 30,
"subject": "Service Level Agreement Template"
},
{
"id": 10,
"subject": "Service Level Agreement Metrics"
}
]
}