Jump to

• Request
• Response

Get Revision History for a Rules File

get

/api/rule/Rules/readRevisionHistory

Gets the revision history for the specified file.

Request

Query Parameters

• limit: integer(int32)
  The number of records to limit results by. If you do not also set the start parameter, records start at 0.

  Example:

  100

• node: string
  The path to the node to get rules for, prefixed with id-.

  Example:

  id-core/example/auto/base.rules

• start: integer(int32)
  The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

  Default Value: 0

  Example:

  1

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

Type: object

Show Source

• data: array data
  The revision history of the specified rules file.
• message: string
  The response message.

  Example: Loaded file
• success: boolean
  Whether the operation was a success (true) or failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded file"
        },
        "data":{
            "description":"The revision history of the specified rules file.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ruleRulesreadRevisionHistory"
            }
        }
    },
    "type":"object"
}

Nested Schema : data

Type: array

The revision history of the specified rules file.

Show Source

• Array of: object ruleRulesreadRevisionHistory

{
    "description":"The revision history of the specified rules file.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ruleRulesreadRevisionHistory"
    }
}

Nested Schema : ruleRulesreadRevisionHistory

Type: object

Show Source

• Node: string
  User Group ID parent node of Users

  Example: core/RO_LOCKED/example/auto/base.rules
• RevisionID: integer
  Revision ID

  Example: 3
• RevisionName: string
  Revision Name

  Example: r3 [2023-08-04] Updates for package core-rules-6.0.3.0.0.53(1/19)

{
    "properties":{
        "Node":{
            "description":"User Group ID parent node of Users",
            "type":"string",
            "example":"core/RO_LOCKED/example/auto/base.rules"
        },
        "RevisionID":{
            "description":"Revision ID",
            "type":"integer",
            "example":"3"
        },
        "RevisionName":{
            "description":"Revision Name",
            "type":"string",
            "example":"r3 [2023-08-04] Updates for package core-rules-6.0.3.0.0.53(1/19)"
        }
    },
    "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":{
                "description":"An error.",
                "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
  An error.

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

Nested Schema : items

Type: object

An error.

Back to Top