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

serviceRequestId
string

notes
string

Additional information to add to a service request.

reason
string

Reason for closing the service request. This is mandatory only if the option Enable reasons to change status Close is enabled for service request in service desk settings (example steps below).

{
  "notes": "Windows services in North-West are accessible",
  "reason": "Windows Services are up and running"
}

Responses

OK

alertIds
array

allowedStatus
array

allowedStatus.id
allowedStatus.name
allowedStatus.reasonsDefined
allowedStatus.reasonsEnabled
application
string

Application from which the problem is generated.

assignedUser
object

assignedUser.email
assignedUser.firstName
assignedUser.id
assignedUser.lastName
assignedUser.loginName
assignedUser.phoneNumber
assigneeGroup
object

assigneeGroup.description
assigneeGroup.id
assigneeGroup.name
assigneeGroup.userCount
attachedArticles
array

attachedArticles.id
attachedArticles.subject
attachments
array

attachments.contentURL
attachments.createdDate
attachments.file
attachments.id
attachments.name
category
object

category.id
category.name
cc
string

Cc email.

changeRequest
object

Attach a problem related to the problem.

changeRequest.id
channelId
integer

client
object

client.activated
client.createdTime
client.id
client.name
client.uniqueId
client.updatedTime
closedDate
string

closedSummary
string

createdDate
string

createdUser
object

createdUser.email
createdUser.firstName
createdUser.id
createdUser.lastName
createdUser.loginName
createdUser.phoneNumber
customFields
array

customFields.classCode
customFields.customField
customFields.defaultValue
customFields.description
customFields.displayLabel
customFields.editable
customFields.fieldType
customFields.id
customFields.mandatory
customFields.name
customFields.options
customFields.selectedOption
customFields.value
description
string

Description of the problem.

estimatedHours
integer

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".

estimatedMinutes
integer

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".

extTicketId
string

Attach an external ticket ID to the problem.

id
string

knowledgeArticleIds
array

(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.

knownIssue
boolean

notes
string

oldPriority
string

oldStatus
string

priority
string

Priority of the problem.

priorityUpdatedBy
object

priorityUpdatedBy.email
priorityUpdatedBy.firstName
priorityUpdatedBy.id
priorityUpdatedBy.lastName
priorityUpdatedBy.loginName
priorityUpdatedBy.phoneNumber
priorityUpdatedDate
string

reOpenCount
integer

reason
string

requester
object

requester.email
requester.firstName
requester.id
requester.lastName
requester.loginName
requester.phoneNumber
resolvedDate
string

resources
array

resources.aliasName
resources.hostName
resources.id
resources.metaData
resources.name
resources.resourceName
resources.resourceType
resources.type
rootCause
string

Root cause of the problem.

slaDetails
object

slaDetails.resolutionBreach
slaDetails.resolutionBreachDate
slaDetails.resolutionTime
slaDetails.responseBreach
slaDetails.responseBreachDate
slaDetails.responseTime
slaDetails.slaPolicy
source
string

status
string

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".

statusFlow
array

statusFlow.createdDate
statusFlow.notes
statusFlow.reason
statusFlow.status
statusFlow.timeSpent
statusFlow.updatedBy
statusUpdatedBy
object

statusUpdatedBy.email
statusUpdatedBy.firstName
statusUpdatedBy.id
statusUpdatedBy.lastName
statusUpdatedBy.loginName
statusUpdatedBy.phoneNumber
statusUpdatedDate
string

subCategory
object

subCategory.id
subCategory.name
subject
string

Subject of the problem.

suspendEndDate
string

tags
string

ticketArisedTime
string

timeSpent
integer

updatedDate
string

workaround
string

Temporary solution to solve the problem.

{
  "alertIds": [],
  "allowedStatus": [],
  "assignedUser": {
    "email": "Blab@gmail.com",
    "firstName": "BLab",
    "id": "USR0000000023",
    "lastName": "Business User",
    "loginName": "brocadeLabBusiness@organization.com"
  },
  "assigneeGroup": {
    "description": "All brocade lab escalation users",
    "id": 8,
    "name": "Brocade Lab Escalation Users"
  },
  "category": {
    "id": 14,
    "name": "Service Urgency Level"
  },
  "cc": "sample@gmail.com",
  "client": {
    "activated": true,
    "id": 8,
    "name": "Brocade Lab",
    "uniqueId": "client_8"
  },
  "closedDate": "2016-11-25T09:33:43+0000",
  "closedSummary": "Windows 10 devices in North-West issue solved",
  "createdDate": "2016-07-24T16:28:51+0000",
  "createdUser": {
    "email": "john@gmail.com",
    "firstName": "john",
    "lastName": "smith",
    "loginName": "john.smith",
    "phoneNumber": "998-559-2345"
  },
  "customFields": [
    {
      "classCode": "SERVICEREQUEST",
      "defaultValue": "",
      "description": "TESTING",
      "displayLabel": "DROP DOWN",
      "editable": true,
      "fieldType": "TYPE_DROPDOWN",
      "id": "UDF0000003811",
      "mandatory": true,
      "name": "drop_down_3811",
      "options": [
        {
          "label": "one",
          "value": "1"
        },
        {
          "label": "two",
          "value": "2"
        }
      ]
    },
    {
      "classCode": "SERVICEREQUEST",
      "defaultValue": "",
      "description": "text field",
      "displayLabel": "text field",
      "editable": true,
      "fieldType": "TYPE_TEXT",
      "id": "UDF0000003812",
      "mandatory": false,
      "name": "text_field_3812"
    },
    {
      "classCode": "SERVICEREQUEST",
      "defaultValue": "",
      "description": "numeric",
      "displayLabel": "numeric",
      "editable": true,
      "fieldType": "TYPE_NUMBER",
      "id": "UDF0000003813",
      "mandatory": false,
      "name": "numeric_3813"
    },
    {
      "classCode": "SERVICEREQUEST",
      "defaultValue": "0",
      "description": "testing",
      "displayLabel": "check box",
      "editable": true,
      "fieldType": "TYPE_CHECKBOX",
      "id": "UDF0000003814",
      "mandatory": false,
      "name": "check_box_3814",
      "options": [
        {
          "label": "yes",
          "value": "1"
        }
      ]
    },
    {
      "classCode": "SERVICEREQUEST",
      "defaultValue": "2016-02-26T12:13:00+0000",
      "description": "",
      "displayLabel": "Date",
      "editable": true,
      "fieldType": "TYPE_DATE",
      "id": "UDF0000003821",
      "mandatory": false,
      "name": "date_3821"
    },
    {
      "classCode": "SERVICEREQUEST",
      "defaultValue": "2016-02-26T12:13:00+0000",
      "description": "",
      "displayLabel": "Date and Time",
      "editable": true,
      "fieldType": "TYPE_DATETIME",
      "id": "UDF0000003822",
      "mandatory": false,
      "name": "date_and_time_3822"
    }
  ],
  "description": "Windows services required in North-West location",
  "extTicketId": "VNXC0090344",
  "id": "SRQ0000000096",
  "notes": "Windows 10 devices in North-West are working",
  "oldPriority": "Urgent",
  "oldStatus": "Resolved",
  "priority": "Very Low",
  "priorityUpdatedBy": {
    "email": "john@gmail.com",
    "firstName": "john",
    "lastName": "smith",
    "loginName": "john.smith",
    "phoneNumber": "998-559-2345"
  },
  "priorityUpdatedDate": "2016-08-12T07:52:10+0000",
  "reOpenCount": 1,
  "reason": "SR Close",
  "requester": {
    "email": "john@gmail.com",
    "firstName": "john",
    "lastName": "smith",
    "loginName": "john.smith",
    "phoneNumber": "998-559-1234"
  },
  "resolvedDate": "2016-11-25T09:32:05+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"
    }
  ],
  "slaDetails": {
    "resolutionBreach": false,
    "resolutionBreachDate": "",
    "resolutionTime": 1630416,
    "responseBreach": false,
    "responseBreachDate": "",
    "responseTime": 1630397
  },
  "source": "PORTAL",
  "sourcePolicyType": "MANUAL",
  "status": "Closed",
  "statusFlow": [
    {
      "createdDate": "2016-07-24T16:28:52+0000",
      "status": "New",
      "timeSpent": 1630398,
      "updatedBy": {
        "email": "john@gmail.com",
        "firstName": "john",
        "lastName": "smith",
        "loginName": "john.smith",
        "phoneNumber": "998-559-3456"
      }
    },
    {
      "createdDate": "2016-08-12T13:22:10+0000",
      "reason": "Done, Hence moving service request to resolved",
      "status": "Resolved",
      "timeSpent": 13,
      "updatedBy": {
        "email": "john@gmail.com",
        "firstName": "john",
        "lastName": "smith",
        "loginName": "john.smith",
        "phoneNumber": "998-559-3456"
      }
    },
    {
      "createdDate": "2016-08-12T13:22:23+0000",
      "status": "Open",
      "timeSpent": 18,
      "updatedBy": {
        "email": "john@gmail.com",
        "firstName": "john",
        "lastName": "smith",
        "loginName": "john.smith",
        "phoneNumber": "998-559-3456"
      }
    },
    {
      "createdDate": "2016-08-12T13:22:41+0000",
      "reason": "Revisit service request in future",
      "status": "Pending",
      "timeSpent": 9058164,
      "updatedBy": {
        "email": "john@gmail.com",
        "firstName": "john",
        "lastName": "smith",
        "loginName": "john.smith",
        "phoneNumber": "998-559-1234"
      }
    },
    {
      "createdDate": "2016-11-25T09:32:05+0000",
      "notes": "Resolving",
      "reason": "Done, Hence moving service request to resolved",
      "status": "Resolved",
      "timeSpent": 98,
      "updatedBy": {
        "email": "sample@gmail.com",
        "firstName": "SP",
        "id": "USR0000000018",
        "lastName": "Admin",
        "loginName": "superadmin"
      }
    },
    {
      "createdDate": "2016-11-25T09:33:43+0000",
      "notes": "Windows services in North-West are accessible",
      "reason": "Windows Services are up and running",
      "status": "Closed",
      "updatedBy": {
        "email": "john.bolt@gmail.com",
        "firstName": "John",
        "lastName": "Bolt",
        "loginName": "john.bolt"
      }
    }
  ],
  "statusUpdatedBy": {
    "email": "john.bolt@gmail.com",
    "firstName": "John",
    "lastName": "Bolt",
    "loginName": "john.bolt"
  },
  "statusUpdatedDate": "2016-11-25T09:33:43+0000",
  "subCategory": {
    "id": 16,
    "name": "Medium"
  },
  "subject": "Windows Services Required",
  "ticketArisedTime": "",
  "updatedDate": "2016-11-25T09:33:43+0000"
}