Get a File's Content by the File Path |
Gets the content of a file by using the file path.
Retrieves the content that is associated with a file based on optional search criteria together with an encoded URI to the target file.
|
Note: For more information about this command, including descriptions of any path and request parameters, request body schema, response codes and schemas, and payload examples, refer to the online API reference for this command at the following web page: |
URI
https://bartendercloud.com/api/librarian/files/path/{filePath}/content
|
Note: The bartendercloud.com domain that is referenced in the URI and in the code example that follows must be replaced with the contents of the DataCenterURI claim that is extracted from your access token. For more information, refer to Extracting the DataCenterURI Claim. |
Path Parameters
filePath
Type: String
Specifies the path of the file. Required.
Comment: The {filePath} parameter must be single-URL encoded, and the path must start with the "librarian://{spaceName}/" prefix. Replace {spaceName} with the name of the target space (such as Main or $temp).
For example, the actual path for the file named "My File.txt" in the "My Folder" folder in the Main space is as follows:
librarian://Main/My Folder/My File.txt
The URL-encoded {filePath} parameter is as follows:
librarian%3A%2F%2FMain%2FMy%20Folder%2FMy%20File.txt
The full URI would resemble the following:
https://bartendercloud.com/api/librarian/files/path/librarian%3A%2F%2FMain%2FMy%20Folder%2FMy%20File.txt/content
Query Parameters
versionMajor
Type: Integer <int32>
Specifies the requested major version. Gets the latest version if both major and minor versions are not provided. Also gets the latest version if a major version is not provided and if minor versioning is not enabled in the space, regardless of the minor version value. Optional.
versionMinor
Type: Integer <int32>
Specifies the requested minor version. Required when minor versioning is enabled in the space; otherwise optional.
createDateTimeUtc
Type: String <date-time>
Specifies the requested "created date and time" value to use to retrieve a file that has the smallest difference that is less than or equal to the provided value. Optional.
|
Caution: Do not use both a version parameter and the createdDateTimeUtc parameter in a request. |
Example
- C#
Request body: None.
Response: System.IO.Stream
// Get the first (1.0) version of a file.
// Assume that fileId is the ID of the target file.
// Assume that majorVersion is 1 (minorVersion will default to 0).
var client = new HttpClient();
string filePathEncoded = System.Uri.EscapeDataString(filePath);
HttpResponseMessage msg = await client.GetAsync($"https://bartendercloud.com/api/librarian/files/path/{filePath}/content?versionMajor={majorVersion}");
if (msg.IsSuccessStatusCode || msg.StatusCode == HttpStatusCode.NoContent)
{
return await msg.Content.ReadAsStreamAsync();
}