1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Rule Execution
  4. Re-Execution
  5. Get Rule Re-run History

v1.0

get

/ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/rerunhistory/{ruleId}

Fetches the rule re-run history for a given rule id.

Request

Path Parameters
  • Study mode identifies the study data segment. Allowed values: design (draft workspace), test (UAT sandbox), training (practice environment), production (live subject data).
    Example:
    test
  • Unique identifier for the rule. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
    Example:
    704A7178208D44BC9AD52556B18933C3
  • Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example:
    C360089F838D4DD980322DE22545C49F

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Rule execution was successful.
Body ()
Root Schema : RuleHistoryResponse
Type: object
Envelope returned when fetching rule history by rule identifier.
Show Source
  • ruleHistory
    Collection of rule history entries returned for the provided rule identifier.
  • Minimum Length: 4
    Maximum Length: 32
    Allowed Values: [ "SUCCESS", "VALIDATION_ERROR", "NOT_FOUND", "SERVER_ERROR" ]
    High-level status for the history request. Values: SUCCESS (history retrieved successfully), VALIDATION_ERROR (request failed validation), NOT_FOUND (no matching history records), SERVER_ERROR (unexpected service failure).
    Example: SUCCESS
  • Minimum Length: 1
    Maximum Length: 512
    Additional detail about the rule history status. Null when the request succeeds without warnings.
    Example: Rule execution job not found for the supplied identifier.
Nested Schema : ruleHistory
Type: array
Collection of rule history entries returned for the provided rule identifier.
Show Source
Example:
[
    {
        "ruleId":"704A7178208D44BC9AD52556B18933C3",
        "jobId":"0E2428167F66445BAB544C7CDD884E87",
        "jobStatus":"Success",
        "ruleName":"screening - create query with form submit dates",
        "jobStartDate":"2025-09-07 19:08:07.437",
        "userId":"0000000000000000000000000000000A",
        "countPassedSubjects":1,
        "countFailedSubjects":0
    }
]
Nested Schema : RuleHistoryEntry
Type: object
Individual rule re-run history entry.
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Number of subjects for which the rule failed. Negative values are not allowed.
    Example: 0
  • Minimum Value: 0
    Maximum Value: 2147483647
    Number of subjects for which the rule passed. Negative values are not allowed.
    Example: 1
  • Minimum Length: 32
    Maximum Length: 36
    Pattern: ^[0-9A-Fa-f]{32}$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
    Identifier for the rule execution job. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
    Example: 0E2428167F66445BAB544C7CDD884E87
  • Minimum Length: 23
    Maximum Length: 23
    Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}$
    Job start timestamp formatted as yyyy-MM-dd HH:mm:ss.SSS in the service timezone.
    Example: 2025-09-07 19:08:07.437
  • Minimum Length: 4
    Maximum Length: 64
    Allowed Values: [ "Running", "Success", "Failed", "Cancelled", "Completed with errors", "Pending", "Rule is not in publish state", "Rule is invalid", "Rule is disabled", "Rule doesn't exist", "Failed to cancel job", "Skipped because subject is locked" ]
    Execution outcome for an individual rule job. Allowed values: Running (job currently executing), Success (job completed without errors), Failed (job exited because of an error), Cancelled (job was cancelled before completion), Completed with errors (job finished but produced warnings), Pending (job waiting to start), Rule is not in publish state (rule not promoted to the target mode), Rule is invalid (rule failed validation), Rule is disabled (rule disabled for the selected mode), Rule doesn't exist (referenced rule is missing), Failed to cancel job (service could not cancel the job), Skipped because subject is locked (subject lock prevented execution).
    Example: Success
  • Minimum Length: 32
    Maximum Length: 36
    Pattern: ^[0-9A-Fa-f]{32}$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
    Identifier for the rule. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
    Example: 704A7178208D44BC9AD52556B18933C3
  • Minimum Length: 1
    Maximum Length: 256
    Rule display name associated with the historical job execution.
    Example: screening - create query with form submit dates
  • Minimum Length: 32
    Maximum Length: 36
    Pattern: ^[0-9A-Fa-f]{32}$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
    Identifier for the user that initiated the rule execution. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
    Example: 0000000000000000000000000000000A
Example:
{
    "ruleId":"704A7178208D44BC9AD52556B18933C3",
    "jobId":"0E2428167F66445BAB544C7CDD884E87",
    "jobStatus":"Success",
    "ruleName":"screening - create query with form submit dates",
    "jobStartDate":"2025-09-07 19:08:07.437",
    "userId":"0000000000000000000000000000000A",
    "countPassedSubjects":1,
    "countFailedSubjects":0
}
Examples

400 Response

Returned when the request payload fails validation, such as when ruleIds is empty, contains malformed UUIDs, or required fields are missing.
Body ()
Root Schema : RuleHistoryResponse
Type: object
Envelope returned when fetching rule history by rule identifier.
Show Source
  • ruleHistory
    Collection of rule history entries returned for the provided rule identifier.
  • Minimum Length: 4
    Maximum Length: 32
    Allowed Values: [ "SUCCESS", "VALIDATION_ERROR", "NOT_FOUND", "SERVER_ERROR" ]
    High-level status for the history request. Values: SUCCESS (history retrieved successfully), VALIDATION_ERROR (request failed validation), NOT_FOUND (no matching history records), SERVER_ERROR (unexpected service failure).
    Example: SUCCESS
  • Minimum Length: 1
    Maximum Length: 512
    Additional detail about the rule history status. Null when the request succeeds without warnings.
    Example: Rule execution job not found for the supplied identifier.
Nested Schema : ruleHistory
Type: array
Collection of rule history entries returned for the provided rule identifier.
Show Source
Example:
[
    {
        "ruleId":"704A7178208D44BC9AD52556B18933C3",
        "jobId":"0E2428167F66445BAB544C7CDD884E87",
        "jobStatus":"Success",
        "ruleName":"screening - create query with form submit dates",
        "jobStartDate":"2025-09-07 19:08:07.437",
        "userId":"0000000000000000000000000000000A",
        "countPassedSubjects":1,
        "countFailedSubjects":0
    }
]
Nested Schema : RuleHistoryEntry
Type: object
Individual rule re-run history entry.
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Number of subjects for which the rule failed. Negative values are not allowed.
    Example: 0
  • Minimum Value: 0
    Maximum Value: 2147483647
    Number of subjects for which the rule passed. Negative values are not allowed.
    Example: 1
  • Minimum Length: 32
    Maximum Length: 36
    Pattern: ^[0-9A-Fa-f]{32}$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
    Identifier for the rule execution job. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
    Example: 0E2428167F66445BAB544C7CDD884E87
  • Minimum Length: 23
    Maximum Length: 23
    Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}$
    Job start timestamp formatted as yyyy-MM-dd HH:mm:ss.SSS in the service timezone.
    Example: 2025-09-07 19:08:07.437
  • Minimum Length: 4
    Maximum Length: 64
    Allowed Values: [ "Running", "Success", "Failed", "Cancelled", "Completed with errors", "Pending", "Rule is not in publish state", "Rule is invalid", "Rule is disabled", "Rule doesn't exist", "Failed to cancel job", "Skipped because subject is locked" ]
    Execution outcome for an individual rule job. Allowed values: Running (job currently executing), Success (job completed without errors), Failed (job exited because of an error), Cancelled (job was cancelled before completion), Completed with errors (job finished but produced warnings), Pending (job waiting to start), Rule is not in publish state (rule not promoted to the target mode), Rule is invalid (rule failed validation), Rule is disabled (rule disabled for the selected mode), Rule doesn't exist (referenced rule is missing), Failed to cancel job (service could not cancel the job), Skipped because subject is locked (subject lock prevented execution).
    Example: Success
  • Minimum Length: 32
    Maximum Length: 36
    Pattern: ^[0-9A-Fa-f]{32}$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
    Identifier for the rule. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
    Example: 704A7178208D44BC9AD52556B18933C3
  • Minimum Length: 1
    Maximum Length: 256
    Rule display name associated with the historical job execution.
    Example: screening - create query with form submit dates
  • Minimum Length: 32
    Maximum Length: 36
    Pattern: ^[0-9A-Fa-f]{32}$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
    Identifier for the user that initiated the rule execution. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
    Example: 0000000000000000000000000000000A
Example:
{
    "ruleId":"704A7178208D44BC9AD52556B18933C3",
    "jobId":"0E2428167F66445BAB544C7CDD884E87",
    "jobStatus":"Success",
    "ruleName":"screening - create query with form submit dates",
    "jobStartDate":"2025-09-07 19:08:07.437",
    "userId":"0000000000000000000000000000000A",
    "countPassedSubjects":1,
    "countFailedSubjects":0
}
Examples

500 Response

Returned when rerun history retrieval fails because of an unexpected server-side error.
Body ()
Root Schema : RuleHistoryResponse
Type: object
Envelope returned when fetching rule history by rule identifier.
Show Source
  • ruleHistory
    Collection of rule history entries returned for the provided rule identifier.
  • Minimum Length: 4
    Maximum Length: 32
    Allowed Values: [ "SUCCESS", "VALIDATION_ERROR", "NOT_FOUND", "SERVER_ERROR" ]
    High-level status for the history request. Values: SUCCESS (history retrieved successfully), VALIDATION_ERROR (request failed validation), NOT_FOUND (no matching history records), SERVER_ERROR (unexpected service failure).
    Example: SUCCESS
  • Minimum Length: 1
    Maximum Length: 512
    Additional detail about the rule history status. Null when the request succeeds without warnings.
    Example: Rule execution job not found for the supplied identifier.
Nested Schema : ruleHistory
Type: array
Collection of rule history entries returned for the provided rule identifier.
Show Source
Example:
[
    {
        "ruleId":"704A7178208D44BC9AD52556B18933C3",
        "jobId":"0E2428167F66445BAB544C7CDD884E87",
        "jobStatus":"Success",
        "ruleName":"screening - create query with form submit dates",
        "jobStartDate":"2025-09-07 19:08:07.437",
        "userId":"0000000000000000000000000000000A",
        "countPassedSubjects":1,
        "countFailedSubjects":0
    }
]
Nested Schema : RuleHistoryEntry
Type: object
Individual rule re-run history entry.
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Number of subjects for which the rule failed. Negative values are not allowed.
    Example: 0
  • Minimum Value: 0
    Maximum Value: 2147483647
    Number of subjects for which the rule passed. Negative values are not allowed.
    Example: 1
  • Minimum Length: 32
    Maximum Length: 36
    Pattern: ^[0-9A-Fa-f]{32}$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
    Identifier for the rule execution job. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
    Example: 0E2428167F66445BAB544C7CDD884E87
  • Minimum Length: 23
    Maximum Length: 23
    Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}$
    Job start timestamp formatted as yyyy-MM-dd HH:mm:ss.SSS in the service timezone.
    Example: 2025-09-07 19:08:07.437
  • Minimum Length: 4
    Maximum Length: 64
    Allowed Values: [ "Running", "Success", "Failed", "Cancelled", "Completed with errors", "Pending", "Rule is not in publish state", "Rule is invalid", "Rule is disabled", "Rule doesn't exist", "Failed to cancel job", "Skipped because subject is locked" ]
    Execution outcome for an individual rule job. Allowed values: Running (job currently executing), Success (job completed without errors), Failed (job exited because of an error), Cancelled (job was cancelled before completion), Completed with errors (job finished but produced warnings), Pending (job waiting to start), Rule is not in publish state (rule not promoted to the target mode), Rule is invalid (rule failed validation), Rule is disabled (rule disabled for the selected mode), Rule doesn't exist (referenced rule is missing), Failed to cancel job (service could not cancel the job), Skipped because subject is locked (subject lock prevented execution).
    Example: Success
  • Minimum Length: 32
    Maximum Length: 36
    Pattern: ^[0-9A-Fa-f]{32}$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
    Identifier for the rule. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
    Example: 704A7178208D44BC9AD52556B18933C3
  • Minimum Length: 1
    Maximum Length: 256
    Rule display name associated with the historical job execution.
    Example: screening - create query with form submit dates
  • Minimum Length: 32
    Maximum Length: 36
    Pattern: ^[0-9A-Fa-f]{32}$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
    Identifier for the user that initiated the rule execution. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
    Example: 0000000000000000000000000000000A
Example:
{
    "ruleId":"704A7178208D44BC9AD52556B18933C3",
    "jobId":"0E2428167F66445BAB544C7CDD884E87",
    "jobStatus":"Success",
    "ruleName":"screening - create query with form submit dates",
    "jobStartDate":"2025-09-07 19:08:07.437",
    "userId":"0000000000000000000000000000000A",
    "countPassedSubjects":1,
    "countFailedSubjects":0
}
Examples

Back to Top