Get task responses

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/tasks/{taskId}/responses/search

Sample URLs

https://{api-url}/api/v2/tenants/client_1000/tasks/TASK0000001090/responses/search?pageNo=1&pageSize=10&queryString=startCreationDate:2016-03-29T08:53:48 0000+endCreationDate:2016-03-30T10:53:48 0000

Parameters

All parameters are optional:

Field	Default 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.

Notes

There are special characters that can be used in a query string:

(+) represents the next field and must be URL-encoded.
(:) represents equals. An example is key : value.
Space characters must be URL-encoded.
Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).

Status code

200 OK

Sample response

{
	"results": [{
			"creator": {
				"id": "USR0000002095",
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@domain.com"
			},
			"createdDate": "2016-03-29T08:53:48+0000",
			"attachments": [{
					"id": 90,
					"name": "file-1.txt",
					"createdDate": "2016-03-29T08:53:48+0000",
					"contentURL": "https://{api-url}/api/v2/tenants/client_1000/tasks/TASK0000001109/responses/1896/resources/90"
				},
				{
					"id": 91,
					"name": "file-2.txt",
					"createdDate": "2016-03-29T08:53:48+0000",
					"contentURL": "https://{api-url}/api/v2/tenants/client_1000/tasks/TASK0000001109/responses/1896/resources/91"
				}
			],
			"hasAttachments": true,
			"tags": "API,Task",
			"timeSpent": 120,
			"internal": "false",
			"description": "Task Attachment"
		},
		{
			"creator": {
				"id": "USR0000002095",
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@domain.com"
			},
			"createdDate": "2016-03-29T14:13:20+0000",
			"hasAttachments": false,
			"timeSpent": 200,
			"internal": "false",
			"description": "Response Testing-1"
		},
		{
			"creator": {
				"id": "USR0000002146",
				"loginName": "FSSL-API-Lab-User-1",
				"lastName": "API-Lab",
				"firstName": "FSSL",
				"email": "fssl.user@gmail.com"
			},
			"createdDate": "2016-03-29T13:54:31+0000",
			"attachments": [{
					"id": 88,
					"name": "2.txt",
					"createdDate": "2016-03-29T08:24:31+0000",
					"contentURL": "https://{api-url}/api/v2/tenants/client_1000/tasks/TASK0000001109/responses/1893/resources/88"
				},
				{
					"id": 89,
					"name": "1.txt",
					"createdDate": "2016-03-29T08:24:31+0000",
					"contentURL": "https://{api-url}/api/v2/tenants/client_1000/tasks/TASK0000001109/responses/1893/resources/89"
				}
			],
			"hasAttachments": true,
			"internal": "false",
			"description": "Implement API for Tasks"
		}
	],
	"totalResults": 3,
	"orderBy": "response.id",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"nextPageNo": 0,
	"previousPageNo": 0,
	"descendingOrder": true
}