Endpoint
/api/v2/tenants/{tenantId}/problems
Path Parameters
tenantIdstring
alertIdsarray
allowedStatusarray
Child Parameters
- allowedStatus.id
- allowedStatus.name
- allowedStatus.reasonsDefined
- allowedStatus.reasonsEnabled
applicationstring
Application from which the problem is generated.
assignedUserobject
Child Parameters
- assignedUser.email
- assignedUser.firstName
- assignedUser.id
- assignedUser.lastName
- assignedUser.loginName
- assignedUser.phoneNumber
assigneeGroupobject
Child Parameters
- assigneeGroup.description
- assigneeGroup.id
- assigneeGroup.name
- assigneeGroup.userCount
attachmentsarray
Child Parameters
- attachments.contentURL
- attachments.createdDate
- attachments.file
- attachments.id
- attachments.name
ccstring
Cc email.
channelIdinteger
clientobject
Child Parameters
- client.activated
- client.createdTime
- client.id
- client.name
- client.uniqueId
- client.updatedTime
closedDatestring
closedSummarystring
createdDatestring
createdUserobject
Child Parameters
- createdUser.email
- createdUser.firstName
- createdUser.id
- createdUser.lastName
- createdUser.loginName
- createdUser.phoneNumber
customFieldsarray
Child Parameters
- 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
descriptionstring
Description of the problem.
estimatedHoursinteger
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".
estimatedMinutesinteger
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".
extTicketIdstring
Attach an external ticket ID to the problem.
idstring
knowledgeArticleIdsarray
(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.
Child Parameters
knownIssueboolean
notesstring
oldPrioritystring
oldStatusstring
prioritystring
Priority of the problem.
priorityUpdatedByobject
Child Parameters
- priorityUpdatedBy.email
- priorityUpdatedBy.firstName
- priorityUpdatedBy.id
- priorityUpdatedBy.lastName
- priorityUpdatedBy.loginName
- priorityUpdatedBy.phoneNumber
priorityUpdatedDatestring
reOpenCountinteger
reasonstring
requesterobject
Child Parameters
- requester.email
- requester.firstName
- requester.id
- requester.lastName
- requester.loginName
- requester.phoneNumber
resolvedDatestring
resourcesarray
Child Parameters
- resources.aliasName
- resources.hostName
- resources.id
- resources.metaData
- resources.name
- resources.resourceName
- resources.resourceType
- resources.type
rootCausestring
Root cause of the problem.
slaDetailsobject
Child Parameters
- slaDetails.resolutionBreach
- slaDetails.resolutionBreachDate
- slaDetails.resolutionTime
- slaDetails.responseBreach
- slaDetails.responseBreachDate
- slaDetails.responseTime
- slaDetails.slaPolicy
sourcestring
statusstring
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".
statusFlowarray
Child Parameters
- statusFlow.createdDate
- statusFlow.notes
- statusFlow.reason
- statusFlow.status
- statusFlow.timeSpent
- statusFlow.updatedBy
statusUpdatedByobject
Child Parameters
- statusUpdatedBy.email
- statusUpdatedBy.firstName
- statusUpdatedBy.id
- statusUpdatedBy.lastName
- statusUpdatedBy.loginName
- statusUpdatedBy.phoneNumber
statusUpdatedDatestring
subjectstring
Subject of the problem.
suspendEndDatestring
tagsstring
ticketArisedTimestring
timeSpentinteger
updatedDatestring
workaroundstring
Temporary solution to solve the problem.
{
"application": "Devices Separation based on status",
"assignedUser": {
"id": "USR0000002146",
"loginName": "FSSL-API-Lab-User-1"
},
"attachments": [
{
"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
"name": "2.txt"
},
{
"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
"name": "1.txt"
}
],
"category": {
"id": 26
},
"cc": "tester@gmail.com,VTester@gmail.com",
"changeRequest": {
"id": "CHG0000001093"
},
"channelId": 1,
"customFields": [
{
"id": "UDF0000003790",
"name": "drop_down_api_lab_3790",
"value": "2"
},
{
"id": "UDF0000003791",
"name": "text_api_lab_3791",
"value": "request custom field - text"
}
],
"description": "Device status is not available",
"estimatedHours": 3,
"estimatedMinutes": 45,
"extTicketId": "BMCXC00907",
"knowledgeArticleIds": [
12,
26
],
"knownIssue": true,
"location": "Location@test",
"priority": "Normal",
"requester": {
"id": "USR0000002146",
"loginName": "FSSL-API-Lab-User-1"
},
"resources": [
{
"id": "481af404-33a6-4d61-af77-c483ca6641fa"
},
{
"id": "SGP-7adf3762-f310-4c14-9ecd-443eb7c6c208"
},
{
"id": "DGP-8d44a504-fd4b-4a78-ba34-2dfdf3ffb85e"
}
],
"rootCause": "Device Status",
"subCategory": {
"id": 28
},
"subject": "Issue with Device status",
"tags": "API, Problem",
"workaround": "Need to check from DataBase from every time"
}
Responses
OK
alertIdsarray
allowedStatusarray
Child Parameters
- allowedStatus.id
- allowedStatus.name
- allowedStatus.reasonsDefined
- allowedStatus.reasonsEnabled
applicationstring
Application from which the problem is generated.
assignedUserobject
Child Parameters
- assignedUser.email
- assignedUser.firstName
- assignedUser.id
- assignedUser.lastName
- assignedUser.loginName
- assignedUser.phoneNumber
assigneeGroupobject
Child Parameters
- assigneeGroup.description
- assigneeGroup.id
- assigneeGroup.name
- assigneeGroup.userCount
attachmentsarray
Child Parameters
- attachments.contentURL
- attachments.createdDate
- attachments.file
- attachments.id
- attachments.name
ccstring
Cc email.
channelIdinteger
clientobject
Child Parameters
- client.activated
- client.createdTime
- client.id
- client.name
- client.uniqueId
- client.updatedTime
closedDatestring
closedSummarystring
createdDatestring
createdUserobject
Child Parameters
- createdUser.email
- createdUser.firstName
- createdUser.id
- createdUser.lastName
- createdUser.loginName
- createdUser.phoneNumber
customFieldsarray
Child Parameters
- 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
descriptionstring
Description of the problem.
estimatedHoursinteger
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".
estimatedMinutesinteger
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".
extTicketIdstring
Attach an external ticket ID to the problem.
idstring
knowledgeArticleIdsarray
(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.
Child Parameters
knownIssueboolean
notesstring
oldPrioritystring
oldStatusstring
prioritystring
Priority of the problem.
priorityUpdatedByobject
Child Parameters
- priorityUpdatedBy.email
- priorityUpdatedBy.firstName
- priorityUpdatedBy.id
- priorityUpdatedBy.lastName
- priorityUpdatedBy.loginName
- priorityUpdatedBy.phoneNumber
priorityUpdatedDatestring
reOpenCountinteger
reasonstring
requesterobject
Child Parameters
- requester.email
- requester.firstName
- requester.id
- requester.lastName
- requester.loginName
- requester.phoneNumber
resolvedDatestring
resourcesarray
Child Parameters
- resources.aliasName
- resources.hostName
- resources.id
- resources.metaData
- resources.name
- resources.resourceName
- resources.resourceType
- resources.type
rootCausestring
Root cause of the problem.
slaDetailsobject
Child Parameters
- slaDetails.resolutionBreach
- slaDetails.resolutionBreachDate
- slaDetails.resolutionTime
- slaDetails.responseBreach
- slaDetails.responseBreachDate
- slaDetails.responseTime
- slaDetails.slaPolicy
sourcestring
statusstring
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".
statusFlowarray
Child Parameters
- statusFlow.createdDate
- statusFlow.notes
- statusFlow.reason
- statusFlow.status
- statusFlow.timeSpent
- statusFlow.updatedBy
statusUpdatedByobject
Child Parameters
- statusUpdatedBy.email
- statusUpdatedBy.firstName
- statusUpdatedBy.id
- statusUpdatedBy.lastName
- statusUpdatedBy.loginName
- statusUpdatedBy.phoneNumber
statusUpdatedDatestring
subjectstring
Subject of the problem.
suspendEndDatestring
tagsstring
ticketArisedTimestring
timeSpentinteger
updatedDatestring
workaroundstring
Temporary solution to solve the problem.
{
"alertIds": [],
"allowedStatus": [
{
"id": "2",
"name": "Open",
"reasonsDefined": true,
"reasonsEnabled": true
},
{
"id": "3",
"name": "Pending",
"reasonsDefined": true,
"reasonsEnabled": true
},
{
"id": "4",
"name": "Resolved",
"reasonsDefined": false,
"reasonsEnabled": true
},
{
"id": "5",
"name": "Closed",
"reasonsDefined": false,
"reasonsEnabled": true
},
{
"id": "6",
"name": "On Hold",
"reasonsDefined": true,
"reasonsEnabled": true
}
],
"application": "Devices separation based on status",
"assignedUser": {
"email": "tester@gmail.com",
"firstName": "FSSL",
"id": "USR0000002146",
"lastName": "API-Lab",
"loginName": "FSSL-API-Lab-User-1"
},
"attachedArticles": [
{
"id": 12,
"subject": "Troubleshoot Device Status and Availability"
},
{
"id": 26,
"subject": "Notes on Network Infrastructure"
}
],
"cc": "tester@gmail.com,VTester@gmail.com",
"client": {
"activated": true,
"createdTime": "2012-10-09T11:49:34+0000",
"id": 7,
"name": "API Lab",
"uniqueId": "client_7",
"updatedTime": ""
},
"createdDate": "2016-03-29T10:33:17+0000",
"createdUser": {
"email": "john.smith@gmail.com",
"firstName": "John",
"id": "USR0000002095",
"lastName": "Smith",
"loginName": "John.Smith"
},
"description": "Device status is unavailable",
"estimatedHours": 3,
"estimatedMinutes": 45,
"extTicketId": "BMCXC00907",
"id": "PRB0000001112",
"knowledgeArticleIds": [
12,
26
],
"oldPriority": "Normal",
"oldStatus": "New",
"priority": "Normal",
"priorityUpdatedBy": {
"email": "tester@gmail.com",
"firstName": "FSSL",
"id": "USR0000002146",
"lastName": "API-Lab",
"loginName": "FSSL-API-Lab-User-1"
},
"priorityUpdatedDate": "2016-03-29T10:33:17+0000",
"requester": {
"email": "tester@gmail.com",
"firstName": "FSSL",
"id": "USR0000002146",
"lastName": "API-Lab",
"loginName": "FSSL-API-Lab-User-1"
},
"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"
}
],
"rootCause": "Device Status",
"slaDetails": {
"resolutionBreach": false,
"resolutionBreachDate": "",
"resolutionTime": 0,
"responseBreach": false,
"responseBreachDate": "",
"responseTime": 0
},
"source": "INTEGRATION",
"status": "New",
"statusFlow": [
{
"createdDate": "2016-07-25T12:42:19+0000",
"status": "New",
"updatedBy": {
"email": "sample@opsramp.com",
"firstName": "user",
"lastName": "system",
"loginName": "system.user"
}
}
],
"statusUpdatedBy": {
"email": "tester@gmail.com",
"firstName": "FSSL",
"id": "USR0000002146",
"lastName": "API-Lab",
"loginName": "FSSL-API-Lab-User-1"
},
"statusUpdatedDate": "2016-03-29T10:33:17+0000",
"subject": "Issue with Device Status",
"ticketArisedTime": "",
"updatedDate": "2016-03-29T10:33:28+0000",
"workaround": "Need to check from Database every time"
}