Jump to

• Request
• Response

Patch Rules

patch

/v1/uwaas/rules/{id}

Updates a rule and refreshes the rules engine.

Request

Path Parameters

• id(required):

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object RuleBaseComponent
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RuleBaseComponent"
        },
        {
            "type":"object",
            "not":{
                "required":[
                    "id",
                    "name"
                ]
            }
        }
    ]
}

Nested Schema : RuleBaseComponent

Type: object

Show Source

• category: string
• conditions:
• description: string
  Minimum Length: 1

  Maximum Length: 255
• enabled: boolean
• id: number
• name: string
  Minimum Length: 1

  Maximum Length: 100
• priority: number
• response: object EvaluationResponse
• scopelevels: array Scopelevels
  Minimum Number of Items: 1

  Unique Items Required: true
• tags: array Tags
• targets: object Targets

{
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/components/schemas/T_Number"
        },
        "name":{
            "$ref":"#/components/schemas/T_String"
        },
        "description":{
            "$ref":"#/components/schemas/T_StringLong"
        },
        "conditions":{
            "$ref":"#/components/schemas/TopLevelCondition"
        },
        "response":{
            "$ref":"#/components/schemas/EvaluationResponse"
        },
        "enabled":{
            "type":"boolean"
        },
        "priority":{
            "$ref":"#/components/schemas/T_Number"
        },
        "scopelevels":{
            "$ref":"#/components/schemas/Scopelevels"
        },
        "targets":{
            "$ref":"#/components/schemas/Targets"
        },
        "tags":{
            "$ref":"#/components/schemas/Tags"
        },
        "category":{
            "type":"string"
        }
    },
    "additionalProperties":false
}

Nested Schema : type

Type: object

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 : Scopelevels

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

• Array of: string
  Allowed Values: [ "global", "org", "instance", "wallet", "asset" ]

{
    "type":"array",
    "minItems":1,
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "global",
            "org",
            "instance",
            "wallet",
            "asset"
        ]
    },
    "example":[
        "org"
    ]
}

Example:

[
    "org"
]

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 : T_RecordStringAny

Type: object

Additional Properties Allowed: true

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

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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Rule patched

Body ()

Root Schema : RuleOutput

Match All

Show Source

• object RuleBaseComponent
• object RuleOutput-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RuleBaseComponent"
        },
        {
            "type":"object",
            "properties":{
                "createdBy":{
                    "$ref":"#/components/schemas/T_String"
                },
                "updatedBy":{
                    "$ref":"#/components/schemas/T_String"
                },
                "createdAt":{
                    "$ref":"#/components/schemas/T_DateTime"
                },
                "updatedAt":{
                    "$ref":"#/components/schemas/T_DateTime"
                }
            },
            "required":[
                "id",
                "name",
                "description",
                "conditions",
                "response",
                "enabled",
                "priority",
                "scopelevels",
                "targets",
                "tags",
                "category",
                "createdBy",
                "updatedBy",
                "createdAt",
                "updatedAt"
            ]
        }
    ]
}

Nested Schema : RuleBaseComponent

Type: object

Show Source

• category: string
• conditions:
• description: string
  Minimum Length: 1

  Maximum Length: 255
• enabled: boolean
• id: number
• name: string
  Minimum Length: 1

  Maximum Length: 100
• priority: number
• response: object EvaluationResponse
• scopelevels: array Scopelevels
  Minimum Number of Items: 1

  Unique Items Required: true
• tags: array Tags
• targets: object Targets

{
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/components/schemas/T_Number"
        },
        "name":{
            "$ref":"#/components/schemas/T_String"
        },
        "description":{
            "$ref":"#/components/schemas/T_StringLong"
        },
        "conditions":{
            "$ref":"#/components/schemas/TopLevelCondition"
        },
        "response":{
            "$ref":"#/components/schemas/EvaluationResponse"
        },
        "enabled":{
            "type":"boolean"
        },
        "priority":{
            "$ref":"#/components/schemas/T_Number"
        },
        "scopelevels":{
            "$ref":"#/components/schemas/Scopelevels"
        },
        "targets":{
            "$ref":"#/components/schemas/Targets"
        },
        "tags":{
            "$ref":"#/components/schemas/Tags"
        },
        "category":{
            "type":"string"
        }
    },
    "additionalProperties":false
}

Nested Schema : RuleOutput-allOf[1]

Type: object

Show Source

• createdAt(required): string (date-time)
• createdBy(required): string
  Minimum Length: 1

  Maximum Length: 100
• updatedAt(required): string (date-time)
• updatedBy(required): string
  Minimum Length: 1

  Maximum Length: 100

{
    "type":"object",
    "properties":{
        "createdBy":{
            "$ref":"#/components/schemas/T_String"
        },
        "updatedBy":{
            "$ref":"#/components/schemas/T_String"
        },
        "createdAt":{
            "$ref":"#/components/schemas/T_DateTime"
        },
        "updatedAt":{
            "$ref":"#/components/schemas/T_DateTime"
        }
    },
    "required":[
        "id",
        "name",
        "description",
        "conditions",
        "response",
        "enabled",
        "priority",
        "scopelevels",
        "targets",
        "tags",
        "category",
        "createdBy",
        "updatedBy",
        "createdAt",
        "updatedAt"
    ]
}

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 : Scopelevels

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

• Array of: string
  Allowed Values: [ "global", "org", "instance", "wallet", "asset" ]

{
    "type":"array",
    "minItems":1,
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "global",
            "org",
            "instance",
            "wallet",
            "asset"
        ]
    },
    "example":[
        "org"
    ]
}

Example:

[
    "org"
]

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 : T_RecordStringAny

Type: object

Additional Properties Allowed: true

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

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"
    }
}

400 Response

Validation 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"
    ]
}

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"
    ]
}

Back to Top