Class Download

Namespace

BiExcellence.OpenBi.Api.Downloads

Assembly

BiExcellence.OpenBi.Api.Client.dll

A downloadable content item (a portal "download") - the offer around one or more files: headline, descriptions, image and group. The CMS download list item shows the active ones, newest first, to the usergroups they are assigned to. Used as both the request and response body.

public sealed record Download : IDownload

Inheritance

object

Download

Implements

IDownload

Properties

Content

The long description, as HTML - the CMS inserts it without encoding.

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

Property Value

string

Date

The date shown with the download; the CMS download list item sorts newest first by it.

[JsonPropertyName("date")]
public DateTimeOffset Date { get; init; }

Property Value

DateTimeOffset

Files

The ids of the role content elements (RoleContentElement) offered for download; the CMS links each as /downloadrolecontentelement?element={id}. Passing a non-null value on create/update replaces the full set of attached files; null leaves it as it is. A list response carries null for a download without files.

[JsonPropertyName("files")]
public string[]? Files { get; init; }

Property Value

string[]

Group

The group the download is listed under, so a CMS page can list one group. Groups are not a resource of their own: GetDownloadGroupsAsync lists the names in use.

[JsonPropertyName("group")]
public string? Group { get; init; }

Property Value

string

Id

The download's id. The server generates a GUID when a create leaves it empty.

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

Property Value

string

ImagePath

The URL of the teaser image. Where it is empty the CMS download list item uses /CMS/img/teaser-default.jpg.

[JsonPropertyName("imagePath")]
public string? ImagePath { get; init; }

Property Value

string

IsActive

Whether the CMS download list item shows it. This API returns inactive downloads as well.

[JsonPropertyName("isActive")]
public bool IsActive { get; init; }

Property Value

bool

Name

The download's headline.

[JsonPropertyName("name")]
public string? Name { get; init; }

Property Value

string

ShortDescription

A short description, shown in the CMS download list.

[JsonPropertyName("shortDescription")]
public string? ShortDescription { get; init; }

Property Value

string

Subheadline

A second headline shown below Name.

[JsonPropertyName("subheadline")]
public string? Subheadline { get; init; }

Property Value

string