Add response to an incident

This endpoint is used to add a response to an incident.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/incidents/{incidentId}/responses

Sample URLs

https://{api-url}/api/v2/tenants/client_1000/incidents/INC0000001114/responses

Parameters

FieldData TypeDescription
descriptionStringShort summary describing the response.
tagsString(Optional) Labels attached to the response.
attachmentsObject(Optional) Attachments for the particular response.
internalBoolean(Optional) Represents the visibility of the response:
  • Setting internal=true represents visibility of response within the organization
  • Setting internal=false represents visibility of response to all users
creatorObject(Optional) If internal=true, creator is mandatory.
Provide:
  • id
    Example: USR0000002095
  • loginName

Sample request

{
	"description": "Adding Attachments to Incident",
	"internal": "false",
	"creator": {
		"id": "USR0000002146",
		"loginName": "FSSL-API-Lab-User-1"
	},
	"tags": "API, Incident",
	"attachments": [{
		"name": "2.txt",
		"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ="
	}, {
		"name": "1.txt",
		"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ="
	}],
	"extTicketResponseId": "12345"
}

Sample response

{
	"creator": {
		"id": "USR0000002146",
		"loginName": "FSSL-API-Lab-User-1",
		"lastName": "API-Lab",
		"firstName": "FSSL",
		"email": "fssl.user@gmail.com"
	},
	"createdDate": "2016-03-29T12:56:15+0000",
	"attachments": [{
		"id": 108,
		"name": "2.txt",
		"createdDate": "2016-03-29T12:56:15+0000",
		"contentURL": "https://<api-url>/api/v2/tenants/client_1000/incidents/INC0000001114/responses/1913/resources/108"
	}, {
		"id": 109,
		"name": "1.txt",
		"createdDate": "2016-03-29T12:56:15+0000",
		"contentURL": "https://<api-url>/api/v2/tenants/client_1000/incidents/INC0000001114/responses/1913/resources/109" }], "hasAttachments": true, "tags": "tag1,tag2", "internal": "false", "extTicketResponseId": "12345", "description": "testing response"
}