Endpoint
/api/v2/tenants/{tenantId}/tasks/{taskId}/close
Path Parameters
tenantIdstring
taskIdstring
notesstring
(Optional) Additional information to provide to a task.
reasonstring
Provide reason for changing the status. This is mandatory only if the option Enable reasons to change status Close is enabled for tasks in service desk settings. See below steps for more information.
{
"notes": "Project structure integration shared with the admin team and architect team.",
"reason": "Project Integration Completed"
}
Responses
OK
alertIdsarray
allowedStatusarray
Child Parameters
- allowedStatus.id
- allowedStatus.name
- allowedStatus.reasonsDefined
- allowedStatus.reasonsEnabled
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
attachedRequestsarray
Attach service requests to an incident. Use the search service requests to get list of service requests in a client.
Child Parameters
- attachedRequests.id
attachmentsarray
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.
Child Parameters
- attachments.file
- attachments.name
businessImpactobject
Child Parameters
- businessImpact.createdBy
- businessImpact.createdDate
- businessImpact.description
- (Optional) Short summary describing the business impact.
- businessImpact.name
- Business impact name.
- businessImpact.uniqueId
- businessImpact.updatedBy
- businessImpact.updatedDate
categoryobject
Add the change request under a category. Use the get API to get the list of categories.
Child Parameters
- category.id
ccstring
Cc email.
changePlanstring
Description of the change plan.
changeRequestobject
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
Child Parameters
- changeRequest.id
changeTypestring
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.
channelIdstring
clientobject
Child Parameters
- client.activated
- client.createdTime
- client.id
- client.name
- client.uniqueId
- client.updatedTime
closedSummarystring
consolesarray
Child Parameters
- consoles.consoleProtocol
- Console protocol.
- consoles.options
- Console options.
- consoles.type
- Console type
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
Ticket description.
dueDatestring
extTicketIdstring
Attach third party ticket ID.
idstring
knowledgeArticleIdsarray
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.
Child Parameters
locationstring
notesstring
oldPrioritystring
oldStatusstring
parentIdstring
Attach incident. Provide the incident ID as an attachment.
plannedEndstring
plannedStartstring
policyobject
Child Parameters
- policy.active
- policy.createdDate
- policy.executionOrder
- policy.id
- policy.name
- policy.policyType
- policy.updatedDate
prioritystring
Ticket priority with supported priority values: Low, Normal, High, Urgent, and Very Low.
priorityUpdatedByobject
Child Parameters
- priorityUpdatedBy.email
- priorityUpdatedBy.firstName
- priorityUpdatedBy.id
- priorityUpdatedBy.lastName
- priorityUpdatedBy.loginName
- priorityUpdatedBy.phoneNumber
priorityUpdatedDatestring
problemobject
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
Child Parameters
- problem.id
reOpenCountinteger
requesterobject
Child Parameters
- requester.email
- requester.firstName
- requester.id
- requester.lastName
- requester.loginName
- requester.phoneNumber
resolutionSummarystring
resolveDatestring
resourcesarray
Child Parameters
- resources.aliasName
- resources.hostName
- resources.id
- resources.metaData
- resources.name
- resources.resourceName
- resources.resourceType
- resources.type
rollbackPlanstring
Description of roll back plan.
scheduleobject
Child Parameters
- schedule.endTime
- Schedule end time.
- schedule.pattern
- Recurrence pattern.
- schedule.startTime
- Schedule start time.
- schedule.timezone
- Schedule time zone. The list of timezones are shown below. Example: "timezone": "America/Los_Angeles"
- schedule.type
- Schedule type.
serviceRestoreDatestring
slaDetailsobject
Child Parameters
- slaDetails.resolutionBreach
- slaDetails.resolutionBreachDate
- slaDetails.resolutionTime
- slaDetails.responseBreach
- slaDetails.responseBreachDate
- slaDetails.responseTime
- slaDetails.slaPolicy
sourcestring
sourceEntityTypestring
sourceEntityTypeIdstring
sourcePolicyTypestring
sourcePolicyTypeIdstring
statusstring
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
subCategoryobject
Add the change request under a sub-category. Use get categories to get the list of sub-categories.
Child Parameters
- subCategory.id
subjectstring
Ticket subject.
tagsstring
testPlanstring
Description of test plan.
ticketArisedTimestring
toEmailstring
Email address of the user. An email notification is sent to the user.
updatedDatestring
workEndstring
workStartstring
{
"alertIds": [],
"allowedStatus": [],
"assignedUser": {
"email": "sample@gmail.com",
"firstName": "Brocade",
"id": "USR0000000011",
"lastName": "Inc Admin",
"loginName": "brocadeInc@organization.com",
"phoneNumber": "8096250653"
},
"assigneeGroup": {
"description": "Brocade Partner Users",
"id": 5,
"name": "Brocade Inc Users"
},
"cc": "john.smith@gmail.com",
"client": {
"activated": true,
"id": 8,
"name": "Brocade Lab",
"uniqueId": "client_8"
},
"closedDate": "2016-11-25T10:18:49+0000",
"closedSummary": "Project integration done for Logix service desk.",
"createdDate": "2016-11-25T10:15:00+0000",
"createdUser": {
"email": "sample@gmail.com",
"firstName": "SP",
"id": "USR0000000018",
"lastName": "Admin",
"loginName": "superadmin"
},
"customFields": [
{
"classCode": "TASK",
"defaultValue": "",
"description": "Test field",
"displayLabel": "API-Lab-Drop-Down",
"editable": true,
"fieldType": "TYPE_DROPDOWN",
"id": "UDF0000003797",
"mandatory": false,
"name": "api_lab_drop_down_3797",
"options": [
{
"label": "first",
"value": "1"
},
{
"label": "second",
"value": "2"
}
],
"selectedOption": {
"label": "second",
"value": "2"
},
"value": "2"
},
{
"classCode": "TASK",
"defaultValue": "Text field",
"description": "Text Field",
"displayLabel": "API-Lab-Text",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000003798",
"mandatory": false,
"name": "api_lab_text_3798",
"value": "testing text field-update"
},
{
"classCode": "TASK",
"defaultValue": "testing lined\ntext",
"description": "Multi line text field",
"displayLabel": "API-Lab-Multi-Line-Text",
"editable": true,
"fieldType": "TYPE_TEXTAREA",
"id": "UDF0000003799",
"mandatory": false,
"name": "api_lab_multi_line_text_3799"
},
{
"classCode": "TASK",
"defaultValue": "10",
"description": "Testing numeric case",
"displayLabel": "API-Lab-Numeric",
"editable": true,
"fieldType": "TYPE_NUMBER",
"id": "UDF0000003800",
"mandatory": false,
"name": "api_lab_numeric_3800"
}
],
"description": "Project structure needs to be integrated",
"id": "TASK0000000378",
"notes": "Project integration shared with the admin team and architect team.",
"oldPriority": "High",
"oldStatus": "On Hold",
"priority": "High",
"priorityUpdatedBy": {
"email": "john.smith@gmail.com",
"firstName": "john",
"lastName": "smith",
"loginName": "john.smith",
"phoneNumber": "998-559-1234"
},
"priorityUpdatedDate": "2016-11-25T10:15:00+0000",
"reOpenCount": 0,
"reason": "Close Task",
"requester": {
"email": "john.smith@gmail.com",
"firstName": "john",
"lastName": "smith",
"loginName": "john.smith",
"phoneNumber": "998-559-1234"
},
"resolvedDate": "2016-11-25T10:16:15+0000",
"resources": [
{
"id": "d628b4f1-37ad-49de-8487-43125ec3178a",
"name": "SJLPT204",
"type": "DEVICE"
},
{
"id": "SGP-c2af3866-fc89-47dd-b83f-bcc8df0b2a0a",
"name": "VTH Services",
"type": "SERVICE"
},
{
"id": "DGP-420a80f4-5fba-46d5-a1c1-20e2df4a326a",
"name": "OPSRAMP-SJ",
"type": "DEVICE_GROUP"
}
],
"slaDetails": {
"resolutionBreach": false,
"resolutionBreachDate": "",
"resolutionTime": 75,
"responseBreach": false,
"responseBreachDate": "",
"responseTime": 75
},
"source": "PORTAL",
"sourcePolicyType": "MANUAL",
"status": "Closed",
"statusFlow": [
{
"createdDate": "2016-11-25T10:15:00+0000",
"status": "New",
"timeSpent": 49,
"updatedBy": {
"email": "sample@gmail.com",
"firstName": "SP",
"id": "USR0000000018",
"lastName": "Admin",
"loginName": "superadmin"
}
},
{
"createdDate": "2016-11-25T10:15:49+0000",
"reason": "Open task",
"status": "Open",
"timeSpent": 26,
"updatedBy": {
"email": "sample@gmail.com",
"firstName": "SP",
"id": "USR0000000018",
"lastName": "Admin",
"loginName": "superadmin"
}
},
{
"createdDate": "2016-11-25T10:16:15+0000",
"notes": "Resolving task. Assuming completed",
"reason": "Resolve Task",
"status": "Resolved",
"timeSpent": 11,
"updatedBy": {
"email": "sample@gmail.com",
"firstName": "SP",
"id": "USR0000000018",
"lastName": "Admin",
"loginName": "superadmin"
}
},
{
"createdDate": "2016-11-25T10:16:26+0000",
"notes": "Resolving task. Assuming completed",
"reason": "On Hold task",
"status": "On Hold",
"timeSpent": 143,
"updatedBy": {
"email": "sample@gmail.com",
"firstName": "SP",
"id": "USR0000000018",
"lastName": "Admin",
"loginName": "superadmin"
}
},
{
"createdDate": "2016-11-25T10:18:49+0000",
"notes": "Project structure integration shared with the admin team and architect team.",
"reason": "Project Integration Completed",
"status": "Closed",
"updatedBy": {
"email": "john.bolt@gmail.com",
"firstName": "John",
"lastName": "Bolt",
"loginName": "john.bolt"
}
}
],
"statusUpdatedBy": {
"email": "john.bolt@gmail.com",
"firstName": "Bolt",
"lastName": "Bolt",
"loginName": "john.bolt"
},
"statusUpdatedDate": "2016-11-25T10:18:49+0000",
"subject": "Integrate project",
"suspendEndDate": "2016-11-29T10:16:00+0000",
"ticketArisedTime": "",
"updatedDate": "2016-11-25T10:18:49+0000"
}