Interface EvaluateDecisionResponse

interface EvaluateDecisionResponse {
    decisionId: string;
    decisionKey: string;
    decisionName: string;
    decisionOutput: string;
    decisionRequirementsId: string;
    decisionRequirementsKey: string;
    decisionVersion: number;
    evaluatedDecisions: EvaluatedDecision[];
    failedDecisionId: string;
    failureMessage: string;
    tenantId?: string;
}

Properties

decisionId: string

the ID of the decision which was evaluated

decisionKey: string

the unique key identifying the decision which was evaluated (e.g. returned from a decision in the DeployResourceResponse message)

decisionName: string

the name of the decision which was evaluated

decisionOutput: string

JSON document that will instantiate the result of the decision which was evaluated; it will be a JSON object, as the result output will be mapped in a key-value fashion, e.g. { "a": 1 }.

decisionRequirementsId: string

the ID of the decision requirements graph that the decision which was evaluated is part of.

decisionRequirementsKey: string

the unique key identifying the decision requirements graph that the decision which was evaluated is part of.

decisionVersion: number

the version of the decision which was evaluated

evaluatedDecisions: EvaluatedDecision[]

a list of decisions that were evaluated within the requested decision evaluation

failedDecisionId: string

an optional string indicating the ID of the decision which failed during evaluation

failureMessage: string

an optional message describing why the decision which was evaluated failed

tenantId?: string

the tenant identifier of the decision

Generated using TypeDoc