POST api/File/DownloadFile

Gets a report or attachment from server.

Request Information

URI Parameters

None.

Body Parameters

Identifies attachment. Use LookupController.GetLookupValues(LookupController.GetLookupArgumentModel) with argument "Attachments" to get a list of valid attachment id's

AttachmentArgumentModel
NameDescriptionTypeAdditional information
AttachmentId

Gets or sets the report or attachment id

 string

None.
CombinedActivityId

Get or set combined activity id

 string

None.
FormName

Gets or sets the optional FormName. The FormName is used to limit the number of fields returned from GetActivity.

 string

None.
TicketId

Gets or sets the ticket id

 string

None.
Culture

Gets or sets culture, if not specified we will use culture set on user.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "AttachmentId": "sample string 1",
  "CombinedActivityId": "sample string 2",
  "FormName": "sample string 3",
  "TicketId": "sample string 4",
  "Culture": "sample string 5"
}

application/xml, text/xml

Sample: 
<FileController.AttachmentArgumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Controllers">
  <Culture xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 5</Culture>
  <TicketId xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 4</TicketId>
  <CombinedActivityId xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 2</CombinedActivityId>
  <FormName xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 3</FormName>
  <AttachmentId>sample string 1</AttachmentId>
</FileController.AttachmentArgumentModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AttachmentArgumentModel'.

Response Information

Resource Description

A HttpResonseMessage containing the attachment

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.