StarterTemplate ASP.NET Host

<back to all web services

RequestFileById

Files Service

The following routes are available for this service:
GET/service/api/v1/projects/{ProjectId}/{EntityCode}/{EntityId}/files/{Id}Returns information on an attachmentThe authenticating user must have the Read privilege for the entity (Defects, Tests and so on) that contains the attachment.
Parameters:
NameParameterData TypeRequiredDescription
ProjectIdpathintYesThe ID of the project that contains the item
EntityCodepathstringYesThe type of the item that has the attachment
EntityIdpathintYesThe ID of the item that has the attachment
IdpathstringYesThe ID of the attachment

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

HTTP + XML

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

POST /xml/reply/RequestFileById HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

<RequestFileById xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Files">
  <EntityCode>String</EntityCode>
  <EntityId>0</EntityId>
  <Id>0</Id>
  <ProjectId>0</ProjectId>
</RequestFileById>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseFileSingle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Files">
  <AttachmentTypeCode>String</AttachmentTypeCode>
  <Comments>String</Comments>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <DateUpdated>0001-01-01T00:00:00</DateUpdated>
  <EntityCode>String</EntityCode>
  <EntityId>0</EntityId>
  <FileName>String</FileName>
  <Id>0</Id>
  <Title>String</Title>
  <UpdateUserId>0</UpdateUserId>
  <UserName>String</UserName>
</ResponseFileSingle>