Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ruleRulesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ruleRulesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ruleRulesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ruleRulesRead"
    }
}

Nested Schema : ruleRulesRead

Type: object

Show Source

• Checkouts: integer
  Checkouts

  Example: 1
• icon: string
  Image icon path

  Example: /resources/assure1/images/icons/silk/basket.png
• Info: string
  Repository Name

  Example: Core Rules
• LastRevision: integer
  Last Revision

  Example: 8
• ModificationTime: string
  Modification Time

  Example: 2023-08-31 07:00:35
• PathID: string
  Path ID

  Example: id-core
• PathName: string
  Path Name

  Example: core

{
    "properties":{
        "PathID":{
            "description":"Path ID",
            "type":"string",
            "example":"id-core"
        },
        "PathName":{
            "description":"Path Name",
            "type":"string",
            "example":"core"
        },
        "Info":{
            "description":"Repository Name",
            "type":"string",
            "example":"Core Rules"
        },
        "Checkouts":{
            "description":"Checkouts",
            "type":"integer",
            "example":"1"
        },
        "LastRevision":{
            "description":"Last Revision",
            "type":"integer",
            "example":"8"
        },
        "ModificationTime":{
            "description":"Modification Time",
            "type":"string",
            "example":"2023-08-31 07:00:35"
        },
        "icon":{
            "description":"Image icon path",
            "type":"string",
            "example":"/resources/assure1/images/icons/silk/basket.png"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top