Table of Contents

Class ServerFile

Namespace
BiExcellence.OpenBi.Api.Files
Assembly
BiExcellence.OpenBi.Api.Client.dll

A raw file under one of the web host's content-root "areas" (e.g. FLATFILES, STATIC). These are low-level filesystem operations, not a database-backed resource.

public sealed record ServerFile : IServerFile
Inheritance
object
ServerFile
Implements

Properties

Area

The area (top-level folder under the content root) the file is in.

[JsonPropertyName("area")]
public string? Area { get; init; }

Property Value

string

Content

The file's content, base64-encoded. Populated when listing files; absent from the response to a save.

[JsonPropertyName("content")]
public string? Content { get; init; }

Property Value

string

FileName

When listing, the bare file name. In the response to a save or an upload, the path the file was actually written to, relative to the content root and including the area and folder - characters not allowed in a file name are replaced with _.

[JsonPropertyName("fileName")]
public string? FileName { get; init; }

Property Value

string

MimeType

The media type derived from the file's extension; empty when the extension is unknown. Absent from the response to a save.

[JsonPropertyName("mimeType")]
public string? MimeType { get; init; }

Property Value

string