StarterTemplate ASP.NET Host

<back to all web services

RequestFilePost

Files Service

The following routes are available for this service:
POST/service/api/v1/projects/{ProjectId}/{EntityCode}/{EntityId}/filesAdds a new attachmentThe authenticating user must have the Update privilege for the entity (Defects, Tests and so on) to which you are adding the attachment.
Parameters:
NameParameterData TypeRequiredDescription
ProjectIdpathintYesThe ID of the project to which the item belongs
EntityCodepathstringYesThe entity code of the item to which the attachment will be added
EntityIdpathintYesThe ID of the item to which the attachment will be added
CommentsquerystringNoComments to the attachment. Can include HTML markup
TitlequerystringYesThe user-friendly name (title) of the attachment
FilebodyfileYesThe file to be attached

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/RequestFilePost HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: text/jsv
Content-Length: length

{
	project_id: 0,
	entity_code: String,
	entity_id: 0,
	comments: String,
	title: String,
	file: {}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	entity_id: 0,
	entity_code: String,
	attachment_type_code: String,
	file_name: String,
	title: String,
	comments: String,
	date_created: 0001-01-01,
	date_updated: 0001-01-01,
	update_user_id: 0,
	user_name: String
}