Interface IBusinessRuleClient

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface IBusinessRuleClient

Methods

GetConfigurationAsync(CancellationToken)

Get the current business rule configuration

Declaration

Task<BusinessRuleConfiguration> GetConfigurationAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessRuleConfiguration> BusinessRuleConfiguration

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

RunScheduleAsync(BusinessRuleSchedule, CancellationToken)

Runs the supplied business rule schedule immediately.
Allows for testing of schedules.

Declaration

Task<BusinessProcess> RunScheduleAsync(BusinessRuleSchedule schedule, CancellationToken cancellationToken = default)

Parameters

BusinessRuleSchedule schedule BusinessRuleSchedule

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> BusinessProcess of the metadata operation triggered by the schedule.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

SearchTracesAsync(BusinessRuleTraceLogSearchRequest, CancellationToken)

Searches for trace logs produces by business rule execution.

Declaration

Task<BusinessRuleTraceLogSearchResult> SearchTracesAsync(BusinessRuleTraceLogSearchRequest request, CancellationToken cancellationToken = default)

Parameters

BusinessRuleTraceLogSearchRequest request Request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessRuleTraceLogSearchResult> Holds results of trace log search.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

UpdateConfigurationAsync(BusinessRuleConfigurationUpdateRequest, CancellationToken)

Updates the business rule configuration.

Declaration

Task<BusinessProcess> UpdateConfigurationAsync(BusinessRuleConfigurationUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

BusinessRuleConfigurationUpdateRequest request Request containing the new configuration.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error