Documentation is now available for the Fall 2020 Update release!

Add response to a time bound request

This endpoint is used to add a response to a time bound request.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/timeBoundRequests/{timeBountRequestId}/responses

Sample URLs

https://{api-url}/api/v2/tenants/client_1000/timeBoundRequests/TBR0000001114/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": "Timebound Request Attachment",
	"internal": "false",
	"tags": "API, timebound",
	"creator": {
		"id": "USR0000002146",
		"loginName": "FSSL-API-Lab-User-1"
	},
	"attachments": [{
			"name": "file-1.txt",
			"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ="
		},
		{
			"name": "file-2.txt",
			"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ="
		}
	]
}

Sample response

{
	"creator": {
		"id": "USR0000002146",
		"loginName": "FSSL-API-Lab-User-1",
		"lastName": "API-Lab",
		"firstName": "FSSL",
		"email": "fssl.user@gmail.com"
	},
	"createdDate": "2016-03-29T11:57:45+0000",
	"attachments": [{
			"id": 104,
			"name": "file-1.txt",
			"createdDate": "2016-03-29T11:57:45+0000",
			"contentURL": "https://<api-url>/api/v2/tenants/client_7/timeBoundRequests/TBR0000001114/responses/1907/resources/104"
		},
		{
			"id": 105,
			"name": "file-2.txt",
			"createdDate": "2016-03-29T11:57:45+0000",
			"contentURL": "https://<api-url>/api/v2/tenants/client_7/timeBoundRequests/TBR0000001114/responses/1907/resources/105"
		}
	],
	"hasAttachments": true,
	"tags": "API,timebound",
	"internal": "false",
	"description": "Timebound Request Attachment"
}