Compare Rules Files and Revisions
get
/api/rule/Rules/readDiff
Compares the specified rules files or file revisions and creates a diff to show the differences.
Request
Query Parameters
-
fromFile(required): string
The path to the file to compare on the "from" side of the diff.Example:
example/base/auto/base.rules
-
fromRevision(required): string
The file revision number to compare on the "from" side of the diff.Example:
3
-
toFile(required): string
The path to the file to compare to on the "to" side of the diff.Example:
example1/base/auto/base.rules
-
toRevision(required): string
The file revision number to compare to on the "to" side of diff.Example:
3
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
object
-
data: array
data
The diff comparing the rules files.
-
message: string
The response message.Example:
-
success: boolean
Whether the operation was a success (true) or failure (false).Example:
true
Nested Schema : ruleRulesReadDiff
Type:
Show Source
object
-
fromFile: string
The content of the fileExample:
/n=head1 NAME/n/n Auto Discovery Post Discovery Rules/n
-
toFile: string
The content of the fileExample:
/n=head1 NAME/n/n Auto Discovery Post Discovery Rules/n
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object