Table of Contents

Class WebFile

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

A file stored under a WebFileContainer. List responses omit Content (fetch a single file via GetWebFileAsync to retrieve it).

public sealed record WebFile : IWebFile
Inheritance
object
WebFile
Implements

Properties

Changed

When the file was last saved. Set by the server on every save; also the file's Last-Modified.

[JsonPropertyName("changed")]
public DateTimeOffset Changed { get; init; }

Property Value

DateTimeOffset

ContainerId

The id of the WebFileContainer the file belongs to. Set from the route by CreateWebFileContainerFileAsync.

[JsonPropertyName("containerId")]
public string? ContainerId { get; init; }

Property Value

string

Content

The file's bytes (base64 in JSON). null in list responses.

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

Property Value

byte[]

ContentType

The media type the CMS serves the file with, such as text/css. Derived from the extension of Path when a save leaves it empty.

[JsonPropertyName("contentType")]
public string? ContentType { get; init; }

Property Value

string

Created

When the file was created.

[JsonPropertyName("created")]
public DateTimeOffset Created { get; init; }

Property Value

DateTimeOffset

Creator

The user who created the file. When a save leaves it empty, the server keeps the stored file's creator, or uses the authenticated user for a new file.

[JsonPropertyName("creator")]
public string? Creator { get; init; }

Property Value

string

Id

The file's id, a GUID the server assigns when a create leaves it null.

[JsonPropertyName("id")]
public string? Id { get; init; }

Property Value

string

Modifier

The user who last saved the file. Set to the authenticated user when a save leaves it empty.

[JsonPropertyName("modifier")]
public string? Modifier { get; init; }

Property Value

string

Path

The request path the CMS serves the file under, such as /css/site.css - compared exactly with the path of a request to a website whose host header names this container. Unique within the container.

[JsonPropertyName("path")]
public string? Path { get; init; }

Property Value

string