Documentation is now available for the Fall 2020 Update release!

Get incident responses

This endpoint is used to retrieve responses of an incident.

Leave Feedback

URL

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

Sample URLs

https://{api-url}/api/v2/tenants/client_1000/incidents/INC0000001114/responses/search?pageNo=1&pageSize=10&queryString=startCreationDate:2016-03-29T12:56:15 0000+endCreationDate:2016-03-30T11:36:15 0000

Parameters

All parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}response.id
queryString={queryString}NA

NA indicates that the value is not applicable.

Query variables

Query VariableValuesDescription
startCreationDateNAFilter response with request creation date. Provide from date.
Example: 2016-03-29T10:15:55 0000 (GMT)
endCreationDateNAFilter response with request creation date. Provide to date.
Example: 2016-03-31T11:20:55 0000 (GMT)
internaltrue, falseInternal or universal responses:
  • If internal=true retrieves only the internal responses.
  • If internal=false retrieves global responses.
  • By default it retrieves all responses of the ticket.

NA indicates that the value is not applicable.

Sample response

{
	"results": [{
		"creator": {
			"id": "USR0000002146",
			"loginName": "FSSL-API-Lab-User-1",
			"lastName": "API-Lab",
			"firstName": "FSSL",
			"email": "tester@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",
		"extTicketResponseId": "12345",
		"internal": "false",
		"description": "Testing response"
	}, {
		"creator": {
			"id": "USR0000002095",
			"loginName": "John.Smith",
			"lastName": "Smith",
			"firstName": "John",
			"email": "john.smith@domain.com"
		},
		"createdDate": "2016-03-29T12:42:49+0000",
		"hasAttachments": false,
		"internal": "false",
		"description": "Testing description-update"
	}],
	"totalResults": 6,
	"orderBy": "response.id",
	"pageNo": 1,
	"pageSize": 2,
	"totalPages": 3,
	"nextPage": true,
	"nextPageNo": 2,
	"previousPageNo": 0,
	"descendingOrder": true
}