Get Rules
get
/api/rule/Rules/read
Gets a list of all rules and their attributes that match the specified parameters. If no parameters are specified, all rules and their attributes are returned.
Request
Query Parameters
-
node(required): string
The path to the node to get rules for, prefixed with id-.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : ruleRulesRead
Type:
Show Source
object
-
Checkouts: integer
CheckoutsExample:
1
-
icon: string
Image icon pathExample:
/resources/assure1/images/icons/silk/basket.png
-
Info: string
Repository NameExample:
Core Rules
-
LastRevision: integer
Last RevisionExample:
8
-
ModificationTime: string
Modification TimeExample:
2023-08-31 07:00:35
-
PathID: string
Path IDExample:
id-core
-
PathName: string
Path NameExample:
core
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