Endpoint
/api/v2/tenants/{tenantId}/tasks/searchPath Parameters
tenantIdstring
Query Parameters
pageNointeger
pageSizeinteger
sortNamestring
isDescendingOrderboolean
queryStringstring
includestring
Responses
OK
descendingOrderboolean
nextPageboolean
nextPageNointeger
orderBystring
pageNointeger
pageSizeinteger
previousPageNointeger
resultsarray
Child Parameters
- results.alertIds
- results.allowedStatus
- results.assignedUser
- results.assigneeGroup
- results.attachedArticles
- results.attachedRequests
- Attach service requests to an incident. Use the search service requests to get list of service requests in a client.
- results.attachments
- Attach files related to the change request. Convert attachment files to byte stream with base64-encoding. The file size limit of an attachment is 50 MB.
- results.businessImpact
- results.category
- Add the change request under a category. Use the get API to get the list of categories.
- results.cc
- Cc email.
- results.changePlan
- Description of the change plan.
- results.changeRequest
- Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
- results.changeType
- Normal or Emergency depending on the Priority of a change request. For example, create a change type Emergency for change requests that must be processed immediately or if Priority of a request is High.
- results.channelId
- results.client
- results.closedSummary
- results.consoles
- results.createdDate
- results.createdUser
- results.customFields
- results.description
- Ticket description.
- results.dueDate
- results.extTicketId
- Attach third party ticket ID.
- results.id
- results.knowledgeArticleIds
- Attach knowledge base articles related to the change request for further reference. To get a knowledge base article ID: 1. Log into OpsRamp. 2. Click Knowledge Base. 3. Select the required article and then copy the article ID. 4. Provide the article ID in "knowledgeArticleIds" field. Example: "knowledgeArticleIds": 25, 16.
- results.location
- results.notes
- results.oldPriority
- results.oldStatus
- results.parentId
- Attach incident. Provide the incident ID as an attachment.
- results.participantUsers
- results.plannedEnd
- results.plannedStart
- results.policy
- results.priority
- Ticket priority with supported priority values: Low, Normal, High, Urgent, and Very Low.
- results.priorityUpdatedBy
- results.priorityUpdatedDate
- results.problem
- Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
- results.reOpenCount
- results.requester
- results.resolutionSummary
- results.resolveDate
- results.resources
- results.rollbackPlan
- Description of roll back plan.
- results.schedule
- results.serviceRestoreDate
- results.slaDetails
- results.source
- results.sourceEntityType
- results.sourceEntityTypeId
- results.sourcePolicyType
- results.sourcePolicyTypeId
- results.status
- results.statusFlow
- results.statusUpdatedBy
- results.statusUpdatedDate
- results.subCategory
- Add the change request under a sub-category. Use get categories to get the list of sub-categories.
- results.subject
- Ticket subject.
- results.tags
- results.testPlan
- Description of test plan.
- results.ticketArisedTime
- results.toEmail
- Email address of the user. An email notification is sent to the user.
- results.updatedDate
- results.urgency
- results.workEnd
- results.workStart
totalPagesinteger
totalResultsinteger
{
"descendingOrder": true,
"nextPage": false,
"orderBy": "ticket.id",
"pageNo": 1,
"pageSize": 10,
"previousPageNo": 0,
"results": [
{
"alertIds": [],
"assignedUser": {
"email": "brocadePAdmin@gmail.com",
"firstName": "Brocade",
"id": "USR0000000013",
"lastName": "Inc PAdmin",
"loginName": "brocadePAdmin@gmail.com"
},
"assigneeGroup": {
"description": "Brocade Inc Escalation Users",
"id": 6,
"name": "Brocade Inc Escalation Users"
},
"cc": "brocadeLab@gmail.com, escalationmails@gmail.com",
"client": {
"activated": true,
"id": 8,
"name": "Brocade Lab",
"uniqueId": "client_8"
},
"closedDate": "2016-08-12T08:19:01+0000",
"createdDate": "2016-08-15T08:18:20+0000",
"createdUser": {
"email": "escalationmails@gmail.com",
"firstName": "SA",
"lastName": "Admin",
"loginName": "superadmin"
},
"description": "Existing functionalities are more error prone, and needs to be upgraded.",
"endDate": "2016-08-31T04:05:00+0000",
"estimatedHours": 30,
"extTicketId": "000042526342",
"id": "TASK0000000252",
"oldPriority": "Urgent",
"oldStatus": "New",
"priority": "Urgent",
"priorityUpdatedBy": {
"email": "brocade@gmail.com",
"firstName": "Brocade",
"id": "USR0000000011",
"lastName": "Inc Admin",
"loginName": "brocadeInc@organization.com"
},
"priorityUpdatedDate": "2016-08-12T08:18:20+0000",
"reOpenCount": 0,
"reason": "Close Task",
"requester": {
"email": "brocade@gmail.com",
"firstName": "Brocade",
"id": "USR0000000011",
"lastName": "Inc Admin",
"loginName": "brocadeInc@organization.com"
},
"resources": [
{
"id": "481af404-33a6-4d61-af77-c483ca6641fa",
"name": "VTHLPT1000",
"type": "DEVICE"
},
{
"id": "SGP-7adf3762-f310-4c14-9ecd-443eb7c6c208",
"name": "VTH-SERVICES",
"type": "SERVICE"
},
{
"id": "DGP-8d44a504-fd4b-4a78-ba34-2dfdf3ffb85e",
"name": "VTH-ADMIN-DEVS",
"type": "DEVICE_GROUP"
}
],
"slaDetails": {
"resolutionBreach": false,
"resolutionBreachDate": "",
"resolutionTime": 41,
"responseBreach": false,
"responseBreachDate": "",
"responseTime": 40
},
"source": "PORTAL",
"startDate": "2016-08-17T11:30:00+0000",
"status": "Closed",
"statusUpdatedBy": {
"email": "escalationmails@gmail.com",
"firstName": "SA",
"lastName": "Admin",
"loginName": "superadmin"
},
"statusUpdatedDate": "2016-08-12T08:19:01+0000",
"subject": "Enhancement in existing functionalities",
"ticketArisedTime": "",
"timeSpent": 0,
"updatedDate": "2016-08-12T08:19:01+0000"
},
{
"alertIds": [],
"assignedUser": {
"email": "brocadePAdmin@gmail.com",
"firstName": "Brocade",
"id": "USR0000000013",
"lastName": "Inc PAdmin",
"loginName": "brocadePAdmin@gmail.com"
},
"assigneeGroup": {
"description": "Brocade Partner Users",
"id": 5,
"name": "Brocade Inc Users"
},
"cc": "brocade@gmail.com, escalationmails@gmail.com",
"client": {
"activated": true,
"id": 8,
"name": "Brocade Lab",
"uniqueId": "client_8"
},
"createdDate": "2016-08-14T08:14:34+0000",
"createdUser": {
"email": "escalationmails@gmail.com",
"firstName": "SA",
"lastName": "Admin",
"loginName": "superadmin"
},
"description": "Escalation policies enhancement",
"endDate": "2016-08-30T18:56:00+0000",
"estimatedHours": 30,
"extTicketId": "000042526342",
"id": "TASK0000000251",
"oldPriority": "Normal",
"oldStatus": "Open",
"priority": "Urgent",
"priorityUpdatedBy": {
"email": "escalationmails@gmail.com",
"firstName": "SA",
"lastName": "Admin",
"loginName": "superadmin"
},
"priorityUpdatedDate": "2016-08-12T08:15:17+0000",
"reOpenCount": 1,
"reason": "On Hold task",
"requester": {
"email": "brocadePAdmin@gmail.com",
"firstName": "Brocade",
"id": "USR0000000013",
"lastName": "Inc PAdmin",
"loginName": "brocadePAdmin@gmail.com"
},
"resources": [
{
"id": "a17d1896-d18a-4d3e-ae6e-e00465770119",
"name": "SVR-DEMO",
"type": "DEVICE"
},
{
"id": "b1483cfe-5f2e-46d5-8aaa-c294f90ba271",
"name": "VMSCAN-PC",
"type": "DEVICE"
}
],
"slaDetails": {
"resolutionBreach": false,
"resolutionBreachDate": "",
"resolutionTime": 61,
"responseBreach": false,
"responseBreachDate": "",
"responseTime": 60
},
"source": "PORTAL",
"startDate": "2016-08-12T18:30:00+0000",
"status": "On Hold",
"statusUpdatedBy": {
"email": "escalationmails@gmail.com",
"firstName": "SA",
"lastName": "Admin",
"loginName": "superadmin"
},
"statusUpdatedDate": "2016-08-12T08:16:25+0000",
"subject": "Add Support for Partner level alert escalation policies",
"suspendEndDate": "2016-08-24T08:16:00+0000",
"ticketArisedTime": "",
"timeSpent": 0,
"updatedDate": "2016-08-12T08:16:25+0000"
},
{
"alertIds": [],
"assignedUser": {
"email": "brocadeLab@gmail.com",
"firstName": "Brocade",
"id": "USR0000000014",
"lastName": "Lab",
"loginName": "brocadeLab@organization.com"
},
"assigneeGroup": {
"description": "All Brocade Lab Users group",
"id": 7,
"name": "Brocade Lab Users"
},
"cc": "escalationmails@gmail.com, brocade@gmail.com",
"client": {
"activated": true,
"id": 8,
"name": "Brocade Lab",
"uniqueId": "client_8"
},
"createdDate": "2016-08-12T11:22:28+0000",
"createdUser": {
"email": "escalationmails@gmail.com",
"firstName": "SA",
"lastName": "Admin",
"loginName": "superadmin"
},
"description": "Required to move client users to partner based on the filter criteria provided : \nfilter criteria : name not contians client",
"endDate": "2016-08-31T04:04:00+0000",
"estimatedHours": 10,
"extTicketId": "000042526342",
"id": "TASK0000000244",
"oldPriority": "Low",
"oldStatus": "Open",
"priority": "Normal",
"priorityUpdatedBy": {
"email": "escalationmails@gmail.com",
"firstName": "SA",
"lastName": "Admin",
"loginName": "superadmin"
},
"priorityUpdatedDate": "2016-08-12T08:06:18+0000",
"project": {
"id": 3,
"name": "ITSM Enhancements"
},
"reOpenCount": 1,
"reason": "Resolve Task",
"requester": {
"email": "escalationmails@gmail.com",
"firstName": "SA",
"lastName": "Admin",
"loginName": "superadmin"
},
"resolvedDate": "2016-08-12T08:08:38+0000",
"resources": [
{
"id": "a17d1896-d18a-4d3e-ae6e-e00465770119",
"name": "SVR-DEMO",
"type": "DEVICE"
},
{
"id": "ad0a218d-7512-435c-9b58-614470ee8658",
"name": "WORK-PC",
"type": "DEVICE"
}
],
"slaDetails": {
"resolutionBreach": false,
"resolutionBreachDate": "",
"resolutionTime": 1197960,
"responseBreach": false,
"responseBreachDate": "",
"responseTime": 1197943
},
"source": "PORTAL",
"startDate": "2016-07-13T04:43:00+0000",
"status": "Resolved",
"statusUpdatedBy": {
"email": "escalationmails@gmail.com",
"firstName": "SA",
"lastName": "Admin",
"loginName": "superadmin"
},
"statusUpdatedDate": "2016-08-12T08:08:38+0000",
"subject": "Move Client Users to Partner Users",
"ticketArisedTime": "",
"timeSpent": 40,
"updatedDate": "2016-08-12T08:10:17+0000"
}
],
"totalPages": 1,
"totalResults": 3
}{
"descendingOrder": true,
"nextPage": true,
"nextPageNo": 0,
"orderBy": "string",
"pageNo": 0,
"pageSize": 0,
"previousPageNo": 0,
"results": [
{
"alertIds": [
null
],
"allowedStatus": [
{
"id": "string",
"name": "string",
"reasonsDefined": true,
"reasonsEnabled": true
}
],
"assignedUser": {
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"loginName": "string",
"phoneNumber": "string"
},
"assigneeGroup": {
"description": "string",
"id": 0,
"name": "string",
"userCount": 0
},
"attachedArticles": [
{
"id": 0,
"subject": "string"
}
],
"attachedRequests": [
{
"id": "string"
}
],
"attachments": [
{
"file": "string",
"name": "string"
}
],
"businessImpact": {
"createdBy": {
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"loginName": "string",
"phoneNumber": "string"
},
"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"name": "string",
"uniqueId": "string",
"updatedBy": {
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"loginName": "string",
"phoneNumber": "string"
},
"updatedDate": "2019-08-24T14:15:22Z"
},
"category": {
"id": 0
},
"cc": "string",
"changePlan": "string",
"changeRequest": {
"id": "string"
},
"changeType": "string",
"channelId": "string",
"client": {
"activated": true,
"createdTime": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"uniqueId": "string",
"updatedTime": "string"
},
"closedSummary": "string",
"createdDate": "2019-08-24T14:15:22Z",
"createdUser": {
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"loginName": "string",
"phoneNumber": "string"
},
"customFields": [
{
"classCode": "TASK",
"defaultValue": "",
"description": "all partners",
"displayLabel": "text field",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000003808",
"mandatory": false,
"name": "text_field_3808",
"value": "available"
},
{
"classCode": "TASK",
"defaultValue": "",
"description": "testing numeric",
"displayLabel": "numeric",
"editable": true,
"fieldType": "TYPE_NUMBER",
"id": "UDF0000003810",
"mandatory": false,
"name": "numeric_3810",
"value": "120"
},
{
"classCode": "TASK",
"defaultValue": "",
"description": "Test case",
"displayLabel": "drop-down-api-lab",
"editable": true,
"fieldType": "TYPE_DROPDOWN",
"id": "UDF0000003790",
"mandatory": false,
"name": "drop_down_api_lab_3790",
"options": [
{
"label": "first",
"value": "1"
},
{
"label": "second",
"value": "2"
}
],
"selectedOption": {
"label": "first",
"value": "1"
},
"value": "1"
},
{
"classCode": "TASK",
"defaultValue": "Test Text",
"description": "test case for text field",
"displayLabel": "text-api-lab",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000003791",
"mandatory": false,
"name": "text_api_lab_3791",
"value": "request custom field - text-updated"
},
{
"classCode": "TASK",
"defaultValue": "multi \nline \ntext",
"description": "test case for multi line text",
"displayLabel": "multi line text-api-lab",
"editable": true,
"fieldType": "TYPE_TEXTAREA",
"id": "UDF0000003792",
"mandatory": false,
"name": "multi_line_text_api_lab_3792",
"value": "text"
},
{
"classCode": "TASK",
"defaultValue": "1",
"description": "numeric test case",
"displayLabel": "Numeric-api-lab",
"editable": true,
"fieldType": "TYPE_NUMBER",
"id": "UDF0000003793",
"mandatory": false,
"name": "numeric_api_lab_3793",
"value": "1"
},
{
"classCode": "TASK",
"defaultValue": "0",
"description": "test case for check box",
"displayLabel": "checkbox-api-lab",
"editable": true,
"fieldType": "TYPE_CHECKBOX",
"id": "UDF0000003794",
"mandatory": false,
"name": "checkbox_api_lab_3794",
"options": [
{
"label": "yes",
"value": "1"
}
],
"selectedOption": {
"label": "yes",
"value": "1"
},
"value": "1"
},
{
"classCode": "TASK",
"defaultValue": "2016-02-26T00:00:00+0000",
"description": "test case for date field",
"displayLabel": "Date-ap-lab",
"editable": true,
"fieldType": "TYPE_DATE",
"id": "UDF0000003795",
"mandatory": false,
"name": "date_ap_lab_3795",
"value": "2016-02-26T00:00:00+0000"
},
{
"classCode": "TASK",
"defaultValue": "2016-02-26T12:13:00+0000",
"description": "test case for Date and time",
"displayLabel": "dateTime-api-lab",
"editable": true,
"fieldType": "TYPE_DATETIME",
"id": "UDF0000003796",
"mandatory": false,
"name": "datetime_api_lab_3796",
"value": "2016-02-26T12:13:00+0000"
}
],
"description": "string",
"dueDate": "string",
"extTicketId": "string",
"id": "string",
"knowledgeArticleIds": [
0
],
"location": "string",
"notes": "string",
"oldPriority": "string",
"oldStatus": "string",
"parentId": "string",
"plannedEnd": "2019-08-24T14:15:22Z",
"plannedStart": "2019-08-24T14:15:22Z",
"policy": {
"active": true,
"createdDate": "string",
"executionOrder": 0,
"id": 0,
"name": "string",
"policyType": "string",
"updatedDate": "string"
},
"priority": "string",
"priorityUpdatedBy": {
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"loginName": "string",
"phoneNumber": "string"
},
"priorityUpdatedDate": "2019-08-24T14:15:22Z",
"problem": {
"id": "string"
},
"reOpenCount": 0,
"requester": {
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"loginName": "string",
"phoneNumber": "string"
},
"resolutionSummary": "string",
"resolveDate": "2019-08-24T14:15:22Z",
"resources": [
{
"aliasName": "string",
"hostName": "string",
"id": "string",
"metaData": {},
"name": "string",
"resourceName": "string",
"resourceType": "string",
"type": "string"
}
],
"rollbackPlan": "string",
"serviceRestoreDate": "2019-08-24T14:15:22Z",
"slaDetails": {
"resolutionBreach": true,
"resolutionBreachDate": "string",
"resolutionTime": 0,
"responseBreach": true,
"responseBreachDate": "string",
"responseTime": 0,
"slaPolicy": {
"active": true,
"businessSchedule": {
"endTime": "string",
"friday": true,
"id": 0,
"monday": true,
"saturday": true,
"shiftType": 0,
"startTime": "string",
"sunday": true,
"thursday": true,
"tuesday": true,
"wednesday": true
},
"createdBy": {
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"loginName": "string",
"phoneNumber": "string"
},
"createdDate": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"priority": "string",
"requestType": "string",
"resolutionBreachTime": 0,
"resolutionReminders": [
{
"cc": "string",
"reminderTime": 0
}
],
"responseBreachTime": 0,
"responseReminders": [
{
"cc": "string",
"percentage": 0,
"reminderTime": 0
}
],
"timezone": {
"code": "string",
"id": "string",
"label": "string",
"name": "string"
},
"updatedBy": {
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"loginName": "string",
"phoneNumber": "string"
},
"updatedDate": "2019-08-24T14:15:22Z",
"withinBussinessHours": true
}
},
"source": "string",
"sourceEntityType": "string",
"sourceEntityTypeId": "string",
"sourcePolicyType": "string",
"sourcePolicyTypeId": "string",
"status": "string",
"statusFlow": [
{
"createdDate": "2019-08-24T14:15:22Z",
"notes": "string",
"reason": "string",
"status": "string",
"timeSpent": 0,
"updatedBy": {
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"loginName": "string",
"phoneNumber": "string"
}
}
],
"statusUpdatedBy": {
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"loginName": "string",
"phoneNumber": "string"
},
"statusUpdatedDate": "2019-08-24T14:15:22Z",
"subCategory": {
"id": 0
},
"subject": "string",
"tags": "string",
"testPlan": "string",
"ticketArisedTime": "string",
"toEmail": "string",
"updatedDate": "2019-08-24T14:15:22Z",
"urgency": {
"id": 0
},
"workEnd": "2019-08-24T14:15:22Z",
"workStart": "2019-08-24T14:15:22Z"
}
],
"totalPages": 0,
"totalResults": 0
}