Table of Contents

Class TransportTask

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

A transport task: a package of configuration changes moved between environments.

public sealed record TransportTask : ITransportTask
Inheritance
object
TransportTask
Implements

Properties

Changed

When the task was last saved. Set by the server on every save.

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

Property Value

DateTimeOffset

Created

When the task was created. Defaults to the time it was first stored.

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

Property Value

DateTimeOffset

Description

A free-text description of the change set.

[JsonPropertyName("description")]
public string? Description { get; init; }

Property Value

string

Id

The task id, a GUID generated by the server when POST transporttasks is given none.

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

Property Value

string

Released

When the task was released. Set by the server to the time of the save whenever the task is saved in state Closed, Transported or IMPORTED; null while it is open.

[JsonPropertyName("released")]
public DateTimeOffset? Released { get; init; }

Property Value

DateTimeOffset?

Source

The system the task was recorded on. The configurator stores the host name of the source server here.

[JsonPropertyName("source")]
public string? Source { get; init; }

Property Value

string

State

The task's state - see TransportTaskState.

[JsonPropertyName("state")]
public string? State { get; init; }

Property Value

string

UserId

The username of the task's owner. Defaults to the caller when a save leaves it empty.

[JsonPropertyName("userId")]
public string? UserId { get; init; }

Property Value

string