Table of Contents

Class ExecuteBatchJobEventRequest

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

Request body for running every batch job registered for an event (POST batchjobevents/execute).

public sealed record ExecuteBatchJobEventRequest : IExecuteBatchJobEventRequest
Inheritance
object
ExecuteBatchJobEventRequest
Implements

Properties

EventName

The event name the jobs are registered for (EventName). Required.

[JsonPropertyName("eventName")]
public string? EventName { get; init; }

Property Value

string

EventValue

The event value the jobs are registered for (EventValue). Required.

[JsonPropertyName("eventValue")]
public string? EventValue { get; init; }

Property Value

string

Parameters

Extra parameters passed to every triggered job handler for this run only, laid over each job's stored parameters.

[JsonPropertyName("parameters")]
public Dictionary<string, string>? Parameters { get; init; }

Property Value

Dictionary<string, string>