ruleDryRun
Runs an unsaved Action through the real rules engine against real records and reports what happened. Commits nothing and writes no execution log.
ruleDryRun(changes: JSONString, draft: RuleDryRunInput!, entityIds: [Int]!): RuleDryRunArguments
Returns
The rebuilt query that ran, which is not the draft's own string.
block | warn, from the raised exception.
The Action supplies a message the engine discards, so whoever trips this Action sees only its title and not the reason. Static: it covers branches this run did not take.
Why the message was discarded, or null when none was.
The context the Action's code actually received. Empty means the record was filtered out of the Action's own context query, so the Action is inert.
passed | blocked | warned | errored. 'errored' means the Action could not be run — it is not a violation.
Did the Action's code raise?
Would this draft survive CreateRule?
query RuleDryRun($draft: RuleDryRunInput!, $entityIds: [Int]!) {
ruleDryRun(draft: $draft, entityIds: $entityIds) {
contextQuery
errorState
evaluatedIds
message
messageDropped
messageDroppedReason
}
}{
"draft": {
"code": "string",
"context": "string",
"eventType": "CREATE",
"target": "ABOMINSTALLATION"
},
"entityIds": [
1
]
}{
"data": {
"ruleDryRun": {
"contextQuery": "string",
"errorState": "string",
"evaluatedIds": [
1
],
"message": "string",
"messageDropped": true,
"messageDroppedReason": "string"
}
}
}Was this page helpful?
query RuleDryRun($draft: RuleDryRunInput!, $entityIds: [Int]!) {
ruleDryRun(draft: $draft, entityIds: $entityIds) {
contextQuery
errorState
evaluatedIds
message
messageDropped
messageDroppedReason
}
}{
"draft": {
"code": "string",
"context": "string",
"eventType": "CREATE",
"target": "ABOMINSTALLATION"
},
"entityIds": [
1
]
}{
"data": {
"ruleDryRun": {
"contextQuery": "string",
"errorState": "string",
"evaluatedIds": [
1
],
"message": "string",
"messageDropped": true,
"messageDroppedReason": "string"
}
}
}