1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Rule Designer
  4. Rule Management
  5. Get rule history by study ID, ruleid and optionally study mode

v1.0

get

/ec-rule-designer-svc/rest/v1.0/rulemgt/studies/{studyId}/{ruleId}/rulehistory

Retrieves the audit history of a given rule, including state, validation outcome, and author details. Compared to the legacy v0.9 endpoint, v1.0 introduces the optional `modes` filter and returns the origin channel metadata for each revision.

Request

Path Parameters
  • Rule identifier. Required for path parameters targeting a single rule; optional when used as a query filter.
    Example:
    8E2253D8E53A4A46BAE3E4952CBE9E5A
  • Unique study identifier supplied as a UUID. Accepts either a compact 32-character hexadecimal value or a hyphenated 36-character UUID.
    Example:
    36753A48BBA048CB98A5F3278146118D
Query Parameters
  • Required list of study modes to filter the history results.
    • Minimum Length: 4
      Maximum Length: 8
      Allowed Values: [ "design", "test", "training", "active" ]
      Study mode to include in the history response. Allowed values: design, test, training, or active.
      Example: design
    Example:
    [
    "design",
    "test"
]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Returned when rule history records are found for the supplied identifiers.
Body ()
Root Schema : RuleHistoryResponseDoc
Type: object
Envelope returned when fetching rule history by rule identifier.
Show Source
Nested Schema : RuleHistoryResultDoc
Type: object
Rule history entries returned for a rule request.
Show Source
Example:
{
    "rules":[
        {
            "ruleId":"38891F5E75BB4071BBF8ACE1F43BD1BD",
            "ruleRevisionNumber":3
        }
    ]
}
Nested Schema : rules
Type: array
Historical revisions ordered by version date.
Show Source
Example:
[
    {
        "ruleId":"38891F5E75BB4071BBF8ACE1F43BD1BD",
        "ruleRevisionNumber":3
    }
]
Nested Schema : RuleHistoryEntryDoc
Type: object
Historical snapshot of a rule revision returned by the history endpoint.
Show Source
  • Minimum Value: 0
    Maximum Value: 1
    Flag indicating whether the rule was deleted in this revision (0 = active, 1 = deleted).
    Example: 0
  • Minimum Length: 1
    Maximum Length: 1024
    Purpose of the rule revision.
    Example: Validates that visit start date is not later than expected window.
  • Minimum Value: 0
    Maximum Value: 1
    Flag indicating whether the rule was enabled in this revision.
    Example: 1
  • Minimum Length: 32
    Maximum Length: 36
    Unique identifier of the rule revision.
    Example: 38891F5E75BB4071BBF8ACE1F43BD1BD
  • Minimum Length: 3
    Maximum Length: 256
    Display name for the rule revision.
    Example: Visit Start Date Validation
  • Minimum Length: 2
    Maximum Length: 12
    Allowed Values: [ "UI", "API", "INTEGRATION" ]
    Origin channel for the rule. `UI` denotes portal-authored rules, `API` covers service integrations, and `INTEGRATION` represents synchronized external logic.
    Example: UI
  • Minimum Length: 3
    Maximum Length: 256
    Reference name that uniquely identifies the rule.
    Example: VISIT_START_DATE_VALIDATION
  • Minimum Value: 0
    Maximum Value: 9999
    Revision number assigned to the record.
    Example: 3
  • Minimum Length: 4
    Maximum Length: 8
    Allowed Values: [ "draft", "uat", "approved", "publish" ]
    Workflow state captured in this revision.
    Example: approved
  • Minimum Length: 1
    Maximum Length: 512
    Validation message captured for the revision.
    Example: Rule evaluated successfully.
  • Minimum Length: 4
    Maximum Length: 5
    Allowed Values: [ "true", "false" ]
    Validation status for the revision. `true` indicates success, `false` indicates the presence of warnings or errors.
    Example: true
  • Minimum Length: 32
    Maximum Length: 36
    Identifier of the study associated with the rule revision.
    Example: 36753A48BBA048CB98A5F3278146118D
  • Minimum Length: 4
    Maximum Length: 10
    Allowed Values: [ "design", "test", "training", "production", "active" ]
    Study mode that captured the revision. Allowed values: design, test, training, production, active.
    Example: test
  • Minimum Length: 3
    Maximum Length: 32
    Study version tied to the revision.
    Example: 3.2.0.18
  • Minimum Length: 32
    Maximum Length: 32
    Identifier for the user who performed the change.
    Example: 0000000000000000000000000000000A
  • Minimum Length: 2
    Maximum Length: 64
    User name of the individual who performed the change.
    Example: jsmith
  • Minimum Length: 20
    Maximum Length: 30
    Timestamp when this revision was superseded.
    Example: 2025-10-11T08:30:00Z
  • Minimum Length: 20
    Maximum Length: 30
    Timestamp when this rule revision became effective.
    Example: 2025-09-07T19:12:08Z
Example:
{
    "ruleId":"38891F5E75BB4071BBF8ACE1F43BD1BD",
    "ruleRevisionNumber":3,
    "ruleDeleted":0,
    "ruleEnabled":1,
    "ruleName":"Visit Start Date Validation",
    "ruleState":"approved",
    "ruleValidationStatus":"true",
    "ruleOriginType":"UI",
    "studymode":"test"
}
Examples

204 Response

Returned when no history entries exist for the supplied rule identifier and study context.
Body ()
Root Schema : RDSRestErrorDataDTO
Type: object
Standard error structure returned by Rule Designer APIs.
Show Source
  • details
    Read Only: true
    Optional diagnostic information when available.
  • Read Only: true
    Minimum Length: 3
    Maximum Length: 64
    Application specific error identifier.
    Example: RuleSvc-030
  • Read Only: true
    Minimum Length: 10
    Maximum Length: 512
    Human-readable summary explaining the error.
    Example: Error encountered during rule execution. Contact your system administrator.
  • Read Only: true
    Minimum Length: 4
    Maximum Length: 4
    Successful payload content when available; remains null for error responses.
    Example: null
  • Read Only: true
    Minimum Length: 6
    Maximum Length: 6
    Allowed Values: [ "failed" ]
    Overall outcome indicator. `failed` means the request could not be fulfilled.
    Example: failed
Example:
{
    "status":"failed",
    "result":null,
    "errorCode":"RuleSvc-030",
    "errorMessage":"Error encountered during rule execution.",
    "details":null
}
Nested Schema : details
Type: object
Read Only: true
Optional diagnostic information when available.
Example:
Validation failed for ruleId 8E2253D8E53A4A46BAE3E4952CBE9E5A.
Examples

400 Response

Returned when the supplied identifiers fail validation or the query parameters are malformed.
Body ()
Root Schema : RDSRestErrorDataDTO
Type: object
Standard error structure returned by Rule Designer APIs.
Show Source
  • details
    Read Only: true
    Optional diagnostic information when available.
  • Read Only: true
    Minimum Length: 3
    Maximum Length: 64
    Application specific error identifier.
    Example: RuleSvc-030
  • Read Only: true
    Minimum Length: 10
    Maximum Length: 512
    Human-readable summary explaining the error.
    Example: Error encountered during rule execution. Contact your system administrator.
  • Read Only: true
    Minimum Length: 4
    Maximum Length: 4
    Successful payload content when available; remains null for error responses.
    Example: null
  • Read Only: true
    Minimum Length: 6
    Maximum Length: 6
    Allowed Values: [ "failed" ]
    Overall outcome indicator. `failed` means the request could not be fulfilled.
    Example: failed
Example:
{
    "status":"failed",
    "result":null,
    "errorCode":"RuleSvc-030",
    "errorMessage":"Error encountered during rule execution.",
    "details":null
}
Nested Schema : details
Type: object
Read Only: true
Optional diagnostic information when available.
Example:
Validation failed for ruleId 8E2253D8E53A4A46BAE3E4952CBE9E5A.
Examples

500 Response

Returned when the rule history retrieval encounters an unexpected server-side error.
Body ()
Root Schema : RDSRestErrorDataDTO
Type: object
Standard error structure returned by Rule Designer APIs.
Show Source
  • details
    Read Only: true
    Optional diagnostic information when available.
  • Read Only: true
    Minimum Length: 3
    Maximum Length: 64
    Application specific error identifier.
    Example: RuleSvc-030
  • Read Only: true
    Minimum Length: 10
    Maximum Length: 512
    Human-readable summary explaining the error.
    Example: Error encountered during rule execution. Contact your system administrator.
  • Read Only: true
    Minimum Length: 4
    Maximum Length: 4
    Successful payload content when available; remains null for error responses.
    Example: null
  • Read Only: true
    Minimum Length: 6
    Maximum Length: 6
    Allowed Values: [ "failed" ]
    Overall outcome indicator. `failed` means the request could not be fulfilled.
    Example: failed
Example:
{
    "status":"failed",
    "result":null,
    "errorCode":"RuleSvc-030",
    "errorMessage":"Error encountered during rule execution.",
    "details":null
}
Nested Schema : details
Type: object
Read Only: true
Optional diagnostic information when available.
Example:
Validation failed for ruleId 8E2253D8E53A4A46BAE3E4952CBE9E5A.
Examples

Back to Top