Get a Rule by ID
get
/api/rule/Rules/{id}
Gets the rule that matches the specified ID.
Request
Path Parameters
-
id(required): string
The path to the rules file to get, prefixed with id-. For example, to get the rules under a the discovery branch node, use id-core/default/collection/discovery. To get a the rules file for a specific leaf node, use id-core/default/collection/discovery/auto/base.includes.Example:
id-core
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
Show Source
-
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 : 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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.