Get problem responses

This endpoint is used to retrieve responses of a problem.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{clientId}/problems/{problemId}/responses/search

Sample URLs

https://{api-url}/api/v2/tenants/client_1000/problems/PRB0000001112/responses/search?pageNo=1&pageSize=10&queryString=startCreationDate:2016-03-29T11:02:19 0000+endCreationDate:2016-03-10T12:02:19 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": "USR0000002095",
			"loginName": "John.Smith",
			"lastName": "Smith",
			"firstName": "John",
			"email": "john.smith@domain.com"
		},
		"createdDate": "2016-03-29T11:02:19+0000",
		"attachments": [{
			"id": 100,
			"name": "file-1.txt",
			"createdDate": "2016-03-29T11:02:19+0000",
			"contentURL": "https:///api/v2/tenants/client_1000/problems/PRB0000001112/responses/1904/resources/100"
		}, {
			"id": 101,
			"name": "file-2.txt",
			"createdDate": "2016-03-29T11:02:19+0000",
			"contentURL": "https:///api/v2/tenants/client_1000/problems/PRB0000001112/responses/1904/resources/101"
		}],
		"hasAttachments": true,
		"tags": "API,Problem",
		"internal": "false",
		"description": "Adding Problem Attachment",
		"timeSpent": 40
	}, {
		"creator": {
			"id": "USR0000002095",
			"loginName": "John.Smith",
			"lastName": "Smith",
			"firstName": "John",
			"email": "john.smith@domain.com"
		},
		"createdDate": "2016-03-29T10:45:44+0000",
		"hasAttachments": false,
		"internal": "false",
		"description": "Response testing-1",
		"timeSpent": 25
	}, {
		"creator": {
			"id": "USR0000002146",
			"loginName": "FSSL-API-Lab-User-1",
			"lastName": "API-Lab",
			"firstName": "FSSL",
			"email": "fssl.user@gmail.com"
		},
		"createdDate": "2016-03-29T16:03:18+0000",
		"attachments": [{
			"id": 98,
			"name": "2.txt",
			"createdDate": "2016-03-29T10:33:17+0000",
			"contentURL": "https:///api/v2/tenants/client_1000/problems/PRB0000001112/responses/1902/resources/98"
		}, {
			"id": 99,
			"name": "1.txt",
			"createdDate": "2016-03-29T10:33:17+0000",
			"contentURL": "https:///api/v2/tenants/client_1000/problems/PRB0000001112/responses/1902/resources/99"
		}],
		"hasAttachments": true,
		"internal": "false",
		"description": "Device status is down",
		"timeSpent": 55
	}],
	"totalResults": 3,
	"orderBy": "response.id",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"nextPageNo": 0,
	"previousPageNo": 0,
	"descendingOrder": true
}