POST api/File/Stream

Retrieves a file as a stream based on the provided request parameters. This method is invoked via an HTTP POST request to the specified route.

Request Information

URI Parameters

None.

Body Parameters

The request object containing parameters for file retrieval.

GetFileRequest

Name	Type	Additional information
ArchiveGuid	string	None.
DocId	integer	None.
FileId	integer	None.
WithBinaries	boolean	None.
AsPdf	boolean	None.
WithAnnotations	boolean	None.
Token	Token	None.

Request Formats

application/json, text/json

Sample:

{
  "ArchiveGuid": "sample string 1",
  "DocId": 2,
  "FileId": 3,
  "WithBinaries": true,
  "AsPdf": true,
  "WithAnnotations": true,
  "Token": {
    "OrgId": 1,
    "OrgGuid": "sample string 2",
    "UserId": 3,
    "UserGuid": "sample string 4",
    "Username": "sample string 5",
    "UserNumber": "sample string 6",
    "EMail": "sample string 7",
    "CreatedAt": "2026-09-15T11:34:25.6222364+02:00",
    "ValidTo": "2026-09-15T11:34:25.6222364+02:00",
    "Realm": "sample string 10",
    "IsDelegated": true,
    "AccessKey": "sample string 12"
  }
}

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

An indicating the result of the operation. Returns a stream of the requested file if successful, or an error message if not.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.