Endpoint
/api/v2/tenants/{tenantId}/serviceRequests/search
Path Parameters
tenantId
string

Describes the clientId of the tenant

Query Parameters
pageNo
integer

pageSize
integer

sortName
string

isDescendingOrder
boolean

queryString
string

include
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

nextPageNo
integer

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.alertIds
results.allowedStatus
results.application
Application from which the problem is generated.
results.assignedUser
results.assigneeGroup
results.attachedArticles
results.attachments
results.category
results.cc
Cc email.
results.changeRequest
Attach a problem related to the problem.
results.channelId
results.client
results.closedDate
results.closedSummary
results.createdDate
results.createdUser
results.customFields
results.description
Description of the problem.
results.estimatedHours
Estimated time for resolving a problem. For example, a user estimates 3 hours for completion of a problem, the user provides value as "estimatedHours": "3".
results.estimatedMinutes
Estimated time for resolving a problem. For example, a user estimates 45 minutes for completion of a task, then user provides value as "estimatedMinutes": "45".
results.extTicketId
Attach an external ticket ID to the problem.
results.id
results.knowledgeArticleIds
(Optional) Attach knowledge base articles related to the problem 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.knownIssue
results.notes
results.oldPriority
results.oldStatus
results.priority
Priority of the problem.
results.priorityUpdatedBy
results.priorityUpdatedDate
results.reOpenCount
results.reason
results.requester
results.resolvedDate
results.resources
results.rootCause
Root cause of the problem.
results.slaDetails
results.source
results.status
Status of problem. Follow the steps to update the status of problem: 1. Use the get problem API to check: 2. Status flow transitions of problem.The status flows are defined in the field allowedStatus. Example: "name" : "Update" 3. Option to provide reasons to change the status is enabled."reasonsEnabled" : "true" indicates, reason is mandatory while changing the status."reasonsEnabled" : "false" indicates reason is optional. 4. If status change reasons are defined, use the get status change reasons to get the list of reasons. Provide the reasons configured in status "Update".
results.statusFlow
results.statusUpdatedBy
results.statusUpdatedDate
results.subCategory
results.subject
Subject of the problem.
results.suspendEndDate
results.tags
results.ticketArisedTime
results.timeSpent
results.updatedDate
results.workaround
Temporary solution to solve the problem.
totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "ticket.id",
  "pageNo": 2,
  "pageSize": 13,
  "previousPageNo": 1,
  "results": [
    {
      "alertIds": [],
      "assignedUser": {
        "email": "brocade@opsramp.com",
        "firstName": "Brocade",
        "id": "USR0000000011",
        "lastName": "Inc Admin",
        "loginName": "brocadeInc@opsramp.com"
      },
      "assigneeGroup": {
        "description": "Brocade Partner Users",
        "id": 5,
        "name": "Brocade Inc Users"
      },
      "category": {
        "id": 14,
        "name": "Service Urgency Level",
        "uniqueId": "SCAT-662b16e1-5373-44b2-a648-a8dc7cbb3fca"
      },
      "cc": "brocade@opsramp.com, escalationmails@opsramp.com",
      "client": {
        "activated": true,
        "id": 8,
        "name": "Brocade Lab",
        "uniqueId": "client_8"
      },
      "createdDate": "2016-07-24T11:02:53+0000",
      "createdUser": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "description": "VLC software is required to get the demo videos for learning development processing.",
      "id": "SRQ0000000099",
      "oldPriority": "Low",
      "oldStatus": "Pending",
      "priority": "Normal",
      "priorityUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "priorityUpdatedDate": "2016-08-12T07:47:15+0000",
      "reOpenCount": 0,
      "reason": "Done, Hence moving service request to resolved",
      "requester": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "resolvedDate": "2016-08-12T07:47:46+0000",
      "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"
        }
      ],
      "serviceCatalogItemId": "0",
      "slaDetails": {
        "resolutionBreach": false,
        "resolutionBreachDate": "",
        "resolutionTime": 1629879,
        "responseBreach": false,
        "responseBreachDate": "",
        "responseTime": 1629892
      },
      "source": "PORTAL",
      "status": "Resolved",
      "statusUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "statusUpdatedDate": "2016-08-12T07:47:46+0000",
      "subCategory": {
        "id": 17,
        "name": "High",
        "uniqueId": "SCAT-26d14886-c60e-4774-9aa4-76a465962404"
      },
      "subject": "VLC Software Required",
      "ticketArisedTime": "",
      "updatedDate": "2016-08-12T07:47:46+0000"
    },
    {
      "alertIds": [],
      "assignedUser": {
        "email": "opsLabBusiness@opsramp.com",
        "firstName": "BLab",
        "id": "USR0000000023",
        "lastName": "Business User",
        "loginName": "opsLabBusiness@opsramp.com"
      },
      "assigneeGroup": {
        "description": "All brocade lab escalation users",
        "id": 8,
        "name": "Brocade Lab Escalation Users"
      },
      "category": {
        "id": 14,
        "name": "Service Urgency Level",
        "uniqueId": "SCAT-b18d6c9c-72ee-4e6f-9009-632ea0fe3a8b"
      },
      "cc": "brocade@opsramp.com, brocadePAdmin@opsramp.com",
      "client": {
        "activated": true,
        "id": 8,
        "name": "Brocade Lab",
        "uniqueId": "client_8"
      },
      "createdDate": "2016-07-24T11:02:01+0000",
      "createdUser": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "description": "As wi-fi is not much effective with the development environment, we are requesting for lan services",
      "extTicketId": "BMCXC00907",
      "id": "SRQ0000000098",
      "oldPriority": "Normal",
      "oldStatus": "Resolved",
      "priority": "High",
      "priorityUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "priorityUpdatedDate": "2016-08-12T07:48:45+0000",
      "reOpenCount": 1,
      "reason": "Done, Hence moving service request to resolved",
      "requester": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "resources": [
        {
          "id": "b1483cfe-5f2e-46d5-8aaa-c294f90ba271",
          "name": "VMSCAN-PC",
          "type": "DEVICE"
        },
        {
          "id": "5bc778e3-b08e-49b4-8a64-5a919dbca83d",
          "name": "vnetvm",
          "type": "DEVICE"
        }
      ],
      "serviceCatalogItemId": "0",
      "slaDetails": {
        "resolutionBreach": false,
        "resolutionBreachDate": "",
        "resolutionTime": 1630246,
        "responseBreach": false,
        "responseBreachDate": "",
        "responseTime": 1630025
      },
      "source": "PORTAL",
      "status": "Open",
      "statusUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "statusUpdatedDate": "2016-08-12T07:49:18+0000",
      "subCategory": {
        "id": 17,
        "name": "High",
        "uniqueId": "SCAT-26d14886-c60e-4774-9aa4-76a465962404"
      },
      "subject": "LAN Service Request",
      "ticketArisedTime": "",
      "updatedDate": "2016-08-12T07:49:18+0000"
    },
    {
      "alertIds": [],
      "assignedUser": {
        "email": "opsLab@opsramp.com",
        "firstName": "Brocade",
        "id": "USR0000000014",
        "lastName": "Lab",
        "loginName": "opsLab@opsramp.com"
      },
      "assigneeGroup": {
        "description": "All Brocade Lab Users group",
        "id": 7,
        "name": "Brocade Lab Users"
      },
      "category": {
        "id": 14,
        "name": "Service Urgency Level",
        "uniqueId": "SCAT-26d14886-c60e-4774-9aa4-76a465962404"
      },
      "cc": "brocade@opsramp.com",
      "client": {
        "activated": true,
        "id": 8,
        "name": "Brocade Lab",
        "uniqueId": "client_8"
      },
      "closedDate": "2016-08-12T07:51:09+0000",
      "createdDate": "2016-07-24T11:01:13+0000",
      "createdUser": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "description": "According to the auditing process done recently, we have followed the standards by turning of the wi-fi for mobiles and and all.\nWe just want to renew it again to process further.",
      "extTicketId": "BMCXC00907",
      "id": "SRQ0000000097",
      "oldPriority": "High",
      "oldStatus": "Resolved",
      "priority": "Urgent",
      "priorityUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "priorityUpdatedDate": "2016-08-12T07:50:09+0000",
      "reOpenCount": 0,
      "reason": "SR Close",
      "requester": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "resolvedDate": "2016-08-12T07:50:29+0000",
      "resources": [
        {
          "id": "06898fdf-8e96-49d3-94d9-4c262540b11e",
          "name": "VM1",
          "type": "DEVICE"
        },
        {
          "id": "037361e1-71ff-4e11-8ec9-688b4aa6b262",
          "name": "VM2",
          "type": "DEVICE"
        }
      ],
      "serviceCatalogItemId": "0",
      "slaDetails": {
        "resolutionBreach": false,
        "resolutionBreachDate": "",
        "resolutionTime": 1630156,
        "responseBreach": false,
        "responseBreachDate": "",
        "responseTime": 1630155
      },
      "source": "PORTAL",
      "status": "Closed",
      "statusUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "statusUpdatedDate": "2016-08-12T07:51:09+0000",
      "subCategory": {
        "id": 15,
        "name": "Low",
        "uniqueId": "SCAT-662b16e1-5373-44b2-a648-a8dc7cbb3fca"
      },
      "subject": "Wi-Fi services should be allowed to mobile phones",
      "ticketArisedTime": "",
      "updatedDate": "2016-08-12T07:51:09+0000"
    },
    {
      "alertIds": [],
      "assignedUser": {
        "email": "opsLabBusiness@opsramp.com",
        "firstName": "BLab",
        "id": "USR0000000023",
        "lastName": "Business User",
        "loginName": "opsLabBusiness@opsramp.com"
      },
      "assigneeGroup": {
        "description": "All brocade lab escalation users",
        "id": 8,
        "name": "Brocade Lab Escalation Users"
      },
      "category": {
        "id": 14,
        "name": "Service Urgency Level",
        "uniqueId": "SCAT-26d14886-c60e-4774-9aa4-76a465962404"
      },
      "cc": "brocade@opsramp.com, escalationmails@opsramp.com",
      "client": {
        "activated": true,
        "id": 8,
        "name": "Brocade Lab",
        "uniqueId": "client_8"
      },
      "createdDate": "2016-07-24T10:58:51+0000",
      "createdUser": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "description": "As of windows 10 is available, we required those on all platforms",
      "id": "SRQ0000000096",
      "oldPriority": "Urgent",
      "oldStatus": "Open",
      "priority": "Very Low",
      "priorityUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "priorityUpdatedDate": "2016-08-12T07:52:10+0000",
      "reOpenCount": 1,
      "reason": "Revisit service request in future",
      "requester": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "resources": [
        {
          "id": "ad0a218d-7512-435c-9b58-614470ee8658",
          "name": "WORK-PC",
          "type": "DEVICE"
        }
      ],
      "serviceCatalogItemId": "0",
      "slaDetails": {
        "resolutionBreach": false,
        "resolutionBreachDate": "",
        "resolutionTime": 1630398,
        "responseBreach": false,
        "responseBreachDate": "",
        "responseTime": 1630397
      },
      "source": "PORTAL",
      "status": "Pending",
      "statusUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "Ops",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "statusUpdatedDate": "2016-08-12T07:52:41+0000",
      "subCategory": {
        "id": 16,
        "name": "Medium",
        "uniqueId": "SCAT-662b16e1-5373-44b2-a648-a8dc7cbb3fca"
      },
      "subject": "Windows Services Required",
      "ticketArisedTime": "",
      "updatedDate": "2016-08-12T07:52:41+0000"
    }
  ],
  "totalPages": 2,
  "totalResults": 17
}