3.2.5.1.1 GET

This API retrieves the binary content of a file in bytes. The caller reads the response stream. The API supports retrieving partial content of the file range that is specified by the Range header in an HTTP request.

This operation is transported by an HTTP GET.

The operation can be invoked through the following URI:

 https://<ServerName>/services/builtin/FileContentAccessService.svc/filecontent?path={path}

The request message for this operation contains the following HTTP headers.

Request header

Usage

Value

Range

Optional

Request only part of an entity, as specified in section 2.2.2.7.

Canary

Optional

The user token, as specified in section 2.2.2.5. Client MUST either pass this header to server or pass all of the following headers to the server. 

Authorization

Optional

The caller's credentials, which are encoded text that is based on the user name and password as specified in section 2.2.2.4.

AppName

Optional

The client application name, as specified in section 2.2.2.1.

AppVersion

Optional

The client application version, as specified in section 2.2.2.3.

AppPublisherName

Optional

The client application publisher name, as specified in section 2.2.2.2.

The response message for this operation can result in one of the following status codes.

Status code

Description

200

Download operation successfully completed.

400

Input parameters are invalid.

401

User is not allowed to access resource.

404

Requested resource does not exist.