Jump to

• Request
• Response

Evaluate Filtered Rules

post

/v1/uwaas/rules/evaluate

Evaluate a data payload against all active rules filtered by scope and tags.

Request

There are no request parameters for this operation.

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
• tags: array Tags
• targets: object Targets

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

Nested Schema : T_RecordStringAny

Type: object

Additional Properties Allowed: true

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

Nested Schema : Tags

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "jurisdiction:us"
    ]
}

Example:

[
    "jurisdiction:us"
]

Nested Schema : Targets

Type: object

Show Source

• assetIds: array assetIds
• instanceIds: array instanceIds
• orgIds: array orgIds
• walletIds: array walletIds

{
    "type":"object",
    "properties":{
        "orgIds":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "red_bank",
                "green_bank"
            ]
        },
        "instanceIds":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "instance-1"
            ]
        },
        "walletIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assetIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : assetIds

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : instanceIds

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "instance-1"
    ]
}

Example:

[
    "instance-1"
]

Nested Schema : orgIds

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "red_bank",
        "green_bank"
    ]
}

Example:

[
    "red_bank",
    "green_bank"
]

Nested Schema : walletIds

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

Select an example No filters With filters

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

500 Response

Internal server error

Back to Top