Jump to

• Request
• Response

Evaluate a Rule

post

/v1/uwaas/rules/evaluate/{id}

Evaluate a data payload against one rule.

Request

Path Parameters

• id(required):

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• facts(required): object T_RecordStringAny
  Additional Properties Allowed: true

  Construct a type with a set of arbitrary properties with any type

{
    "type":"object",
    "properties":{
        "facts":{
            "$ref":"#/components/schemas/T_RecordStringAny"
        }
    },
    "required":[
        "facts"
    ]
}

Nested Schema : T_RecordStringAny

Type: object

Additional Properties Allowed: true

Construct a type with a set of arbitrary properties with any type

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : EvaluationOverallResult

Type: object

Show Source

• evaluationResult(required): string
  Allowed Values: [ "BLOCK", "ALLOW" ]
• responses(required): array responses

{
    "type":"object",
    "properties":{
        "evaluationResult":{
            "$ref":"#/components/schemas/EvaluationResultEnum"
        },
        "responses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EvaluationResponse"
            }
        }
    },
    "required":[
        "evaluationResult",
        "responses"
    ]
}

Nested Schema : responses

Type: array

Show Source

• Array of: object EvaluationResponse

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EvaluationResponse"
    }
}

Nested Schema : EvaluationResponse

Type: object

Show Source

• params(required): object T_RecordStringAny
  Additional Properties Allowed: true

  Construct a type with a set of arbitrary properties with any type
• type(required): string
  Allowed Values: [ "BLOCK", "ALLOW" ]

{
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/EvaluationResponseTypeEnum"
        },
        "params":{
            "$ref":"#/components/schemas/T_RecordStringAny"
        }
    },
    "required":[
        "type",
        "params"
    ]
}

Nested Schema : T_RecordStringAny

Type: object

Additional Properties Allowed: true

Construct a type with a set of arbitrary properties with any type

404 Response

Rule not found

Body ()

Root Schema : AppError

Type: object

Show Source

• details(required):
• message(required): string
• name(required): string
• stack: string
• statusCode(required): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "stack":{
            "type":"string"
        },
        "statusCode":{
            "type":"string"
        },
        "details":{
        }
    },
    "required":[
        "name",
        "message",
        "statusCode",
        "details"
    ]
}

500 Response

Internal server error

Body ()

Root Schema : AppError

Type: object

Show Source

• details(required):
• message(required): string
• name(required): string
• stack: string
• statusCode(required): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "stack":{
            "type":"string"
        },
        "statusCode":{
            "type":"string"
        },
        "details":{
        }
    },
    "required":[
        "name",
        "message",
        "statusCode",
        "details"
    ]
}

Back to Top