Table of Contents

Class TransportTaskElement

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

A single configuration element (of any type) tracked by a TransportTask.

public sealed record TransportTaskElement : ITransportTaskElement
Inheritance
object
TransportTaskElement
Implements

Properties

Action

What to do with the element on the target system - see TransportTaskElementAction.

[JsonPropertyName("action")]
public string? Action { get; init; }

Property Value

string

Date

When the element was last recorded. Set by the server on every assign.

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

Property Value

DateTimeOffset

ElementId

The id of the configuration object the entry stands for, such as a role or usergroup id.

[JsonPropertyName("elementId")]
public string? ElementId { get; init; }

Property Value

string

ElementName

The display name of the configuration object, as recorded.

[JsonPropertyName("elementName")]
public string? ElementName { get; init; }

Property Value

string

ElementType

The kind of configuration object, such as ROLE, USERGROUP, ORGANISATION, PERMISSION, LANGUAGETEXT, CMSTEMPLATEITEM or CONNECTIONTEMPLATE. Taken from the request as it is.

[JsonPropertyName("elementType")]
public string? ElementType { get; init; }

Property Value

string

Id

The id of this entry in the task, server-assigned - the {elementId} of DELETE transporttasks/{id}/elements/{elementId}, not the id of the configuration object.

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

Property Value

long?

Language

The language of a language-dependent element, such as a CMS item template; empty otherwise.

[JsonPropertyName("language")]
public string? Language { get; init; }

Property Value

string

ParentId

The id of the object the element belongs to, where the element is only addressable within it - the base entity of an entity, the role of a role content, the language text of a language text value. Empty for none.

[JsonPropertyName("parentId")]
public string? ParentId { get; init; }

Property Value

string

ParentName

The display name of the parent object, as recorded.

[JsonPropertyName("parentName")]
public string? ParentName { get; init; }

Property Value

string

ParentType

The kind of the parent object, with the same values as ElementType. Empty or UNDEFINED for none.

[JsonPropertyName("parentType")]
public string? ParentType { get; init; }

Property Value

string

TransportTaskId

The Id of the task. Set by the server from the route.

[JsonPropertyName("transportTaskId")]
public string? TransportTaskId { get; init; }

Property Value

string