Documentation is now available for the Fall 2020 Update release!

Get time bound responses

This endpoint is used to retrieve responses of a time bound request.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/timeBoundRequests/{timeBoundRequestId}/responses/search

Sample URLs

https://{api-url}/api/v2/tenants/client_1000/changeRequests/CHG0000001111/responses/search?pageNo=1&pageSize=10&queryString=startCreationDate:2016-03-29T10:15:55 0000+endCreationDate:2016-03-30T11:15:55 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-29T11:57:45 0000 (GMT)
endCreationDateNAFilter response with request creation date. Provide to date.
Example: 2016-03-31T12:30:45 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.

Status code

200 OK

Sample response

{
	"results": [{
			"creator": {
				"id": "USR0000002146",
				"loginName": "FSSL-API-Lab-User-1",
				"lastName": "API-Lab",
				"firstName": "FSSL",
				"email": "fssl.user@gmail.com"
			},
			"createdDate": "2016-03-30T18:09:10+0000",
			"hasAttachments": false,
			"internal": "false",
			"description": "Testing Response"
		},
		{
			"creator": {
				"id": "USR0000002146",
				"loginName": "FSSL-API-Lab-User-1",
				"lastName": "API-Lab",
				"firstName": "FSSL",
				"email": "fssl.user@gmail.com"
			},
			"createdDate": "2016-03-30T18:07:50+0000",
			"hasAttachments": false,
			"internal": "false",
			"description": "Testing Response"
		},
		{
			"creator": {
				"id": "USR0000002095",
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@gmail.com"
			},
			"createdDate": "2016-03-30T12:22:50+0000",
			"hasAttachments": false,
			"internal": "false",
			"description": "Change in Schedule and Consoles"
		},
		{
			"creator": {
				"id": "USR0000002146",
				"loginName": "FSSL-API-Lab-User-1",
				"lastName": "API-Lab",
				"firstName": "FSSL",
				"email": "fssl.user@gmail.com"
			},
			"createdDate": "2016-03-30T17:50:01+0000",
			"attachments": [{
					"id": 133,
					"name": "2.txt",
					"createdDate": "2016-03-30T12:20:01+0000",
					"contentURL": "https://<api-url>/api/v2/tenants/client_1000/timeBoundRequests/TBT0000001127/responses/1927/resources/133"
				},
				{
					"id": 134,
					"name": "1.txt",
					"createdDate": "2016-03-30T12:20:01+0000",
					"contentURL": "https://<api-url>/api/v2/tenants/client_1000/timeBoundRequests/TBT0000001127/responses/1927/resources/134"
				}
			],
			"hasAttachments": true,
			"internal": "false",
			"description": "Tickets must be in closed state within the specified time"
		}
	],
	"totalResults": 4,
	"orderBy": "response.id",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"nextPageNo": 0,
	"previousPageNo": 0,
	"descendingOrder": true
}