Jump to

• Request
• Response

Rule re-run history

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

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• ruleId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the Rule.

  Example:

  704A7178208D44BC9AD52556B18933C3

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  C360089F838D4DD980322DE22545C49F

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Rule execution was successful.

Body ()

Root Schema : Rule Execution History List Response

Type: object

Title: Rule Execution History List Response

Object containing a list of Rule Execution History Objects

Show Source

• ruleHistory: object Rule History Object
  Title: Rule History Object

  Rule history object
• status: string
  Rule Execution History request status or error message

  Example: success

{
    "title":"Rule Execution History List Response",
    "type":"object",
    "properties":{
        "ruleHistory":{
            "title":"Rule History Object",
            "type":"object",
            "properties":{
                "ruleId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
                    "format":"UUID",
                    "example":"704A7178208D44BC9AD52556B18933C3"
                },
                "jobId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
                    "format":"UUID",
                    "example":"0E2428167F66445BAB544C7CDD884E87"
                },
                "jobStatus":{
                    "type":"string",
                    "description":"Job Status",
                    "example":"Success",
                    "enum":[
                        "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"
                    ]
                },
                "ruleName":{
                    "type":"string",
                    "description":"Rule Name",
                    "example":"Calculate BMI"
                },
                "jobStartDate":{
                    "type":"string",
                    "description":"Job Start Date",
                    "example":"2025-09-07 19:12:08.747"
                },
                "userId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the user that initiated the rule execution.",
                    "format":"UUID",
                    "example":"0000000000000000000000000000000A"
                },
                "countPassedSubjects":{
                    "type":"integer",
                    "description":"Number of subjects for which the rule passed.",
                    "example":1
                },
                "countFailedSubjects":{
                    "type":"integer",
                    "description":"Number of subjects for which the rule failed.",
                    "example":0
                }
            },
            "description":"Rule history object"
        },
        "status":{
            "type":"string",
            "description":"Rule Execution History request status or error message",
            "example":"success"
        }
    },
    "description":"Object containing a list of Rule Execution History Objects"
}

Nested Schema : Rule History Object

Type: object

Title: Rule History Object

Rule history object

Show Source

• countFailedSubjects: integer
  Number of subjects for which the rule failed.

  Example: 0
• countPassedSubjects: integer
  Number of subjects for which the rule passed.

  Example: 1
• jobId: string (UUID)
  Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.

  Example: 0E2428167F66445BAB544C7CDD884E87
• jobStartDate: string
  Job Start Date

  Example: 2025-09-07 19:12:08.747
• jobStatus: string
  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" ]

  Job Status

  Example: Success
• ruleId: string (UUID)
  Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.

  Example: 704A7178208D44BC9AD52556B18933C3
• ruleName: string
  Rule Name

  Example: Calculate BMI
• userId: string (UUID)
  Identifier((UUID, 32-character uppercase hexadecimal string)) for the user that initiated the rule execution.

  Example: 0000000000000000000000000000000A

{
    "title":"Rule History Object",
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
            "format":"UUID",
            "example":"704A7178208D44BC9AD52556B18933C3"
        },
        "jobId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
            "format":"UUID",
            "example":"0E2428167F66445BAB544C7CDD884E87"
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "example":"Success",
            "enum":[
                "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"
            ]
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "example":"Calculate BMI"
        },
        "jobStartDate":{
            "type":"string",
            "description":"Job Start Date",
            "example":"2025-09-07 19:12:08.747"
        },
        "userId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the user that initiated the rule execution.",
            "format":"UUID",
            "example":"0000000000000000000000000000000A"
        },
        "countPassedSubjects":{
            "type":"integer",
            "description":"Number of subjects for which the rule passed.",
            "example":1
        },
        "countFailedSubjects":{
            "type":"integer",
            "description":"Number of subjects for which the rule failed.",
            "example":0
        }
    },
    "description":"Rule history object"
}

Examples

Select an example Successful results Successful with non-existent rule

400 Response

Incorrect payload.

Body ()

Root Schema : Rule Execution History List Response

Type: object

Title: Rule Execution History List Response

Object containing a list of Rule Execution History Objects

Show Source

• ruleHistory: object Rule History Object
  Title: Rule History Object

  Rule history object
• status: string
  Rule Execution History request status or error message

  Example: success

{
    "title":"Rule Execution History List Response",
    "type":"object",
    "properties":{
        "ruleHistory":{
            "title":"Rule History Object",
            "type":"object",
            "properties":{
                "ruleId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
                    "format":"UUID",
                    "example":"704A7178208D44BC9AD52556B18933C3"
                },
                "jobId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
                    "format":"UUID",
                    "example":"0E2428167F66445BAB544C7CDD884E87"
                },
                "jobStatus":{
                    "type":"string",
                    "description":"Job Status",
                    "example":"Success",
                    "enum":[
                        "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"
                    ]
                },
                "ruleName":{
                    "type":"string",
                    "description":"Rule Name",
                    "example":"Calculate BMI"
                },
                "jobStartDate":{
                    "type":"string",
                    "description":"Job Start Date",
                    "example":"2025-09-07 19:12:08.747"
                },
                "userId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the user that initiated the rule execution.",
                    "format":"UUID",
                    "example":"0000000000000000000000000000000A"
                },
                "countPassedSubjects":{
                    "type":"integer",
                    "description":"Number of subjects for which the rule passed.",
                    "example":1
                },
                "countFailedSubjects":{
                    "type":"integer",
                    "description":"Number of subjects for which the rule failed.",
                    "example":0
                }
            },
            "description":"Rule history object"
        },
        "status":{
            "type":"string",
            "description":"Rule Execution History request status or error message",
            "example":"success"
        }
    },
    "description":"Object containing a list of Rule Execution History Objects"
}

Nested Schema : Rule History Object

Type: object

Title: Rule History Object

Rule history object

Show Source

• countFailedSubjects: integer
  Number of subjects for which the rule failed.

  Example: 0
• countPassedSubjects: integer
  Number of subjects for which the rule passed.

  Example: 1
• jobId: string (UUID)
  Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.

  Example: 0E2428167F66445BAB544C7CDD884E87
• jobStartDate: string
  Job Start Date

  Example: 2025-09-07 19:12:08.747
• jobStatus: string
  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" ]

  Job Status

  Example: Success
• ruleId: string (UUID)
  Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.

  Example: 704A7178208D44BC9AD52556B18933C3
• ruleName: string
  Rule Name

  Example: Calculate BMI
• userId: string (UUID)
  Identifier((UUID, 32-character uppercase hexadecimal string)) for the user that initiated the rule execution.

  Example: 0000000000000000000000000000000A

{
    "title":"Rule History Object",
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
            "format":"UUID",
            "example":"704A7178208D44BC9AD52556B18933C3"
        },
        "jobId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
            "format":"UUID",
            "example":"0E2428167F66445BAB544C7CDD884E87"
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "example":"Success",
            "enum":[
                "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"
            ]
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "example":"Calculate BMI"
        },
        "jobStartDate":{
            "type":"string",
            "description":"Job Start Date",
            "example":"2025-09-07 19:12:08.747"
        },
        "userId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the user that initiated the rule execution.",
            "format":"UUID",
            "example":"0000000000000000000000000000000A"
        },
        "countPassedSubjects":{
            "type":"integer",
            "description":"Number of subjects for which the rule passed.",
            "example":1
        },
        "countFailedSubjects":{
            "type":"integer",
            "description":"Number of subjects for which the rule failed.",
            "example":0
        }
    },
    "description":"Rule history object"
}

500 Response

An internal error occurred.

Body ()

Root Schema : Rule Execution History List Response

Type: object

Title: Rule Execution History List Response

Object containing a list of Rule Execution History Objects

Show Source

• ruleHistory: object Rule History Object
  Title: Rule History Object

  Rule history object
• status: string
  Rule Execution History request status or error message

  Example: success

{
    "title":"Rule Execution History List Response",
    "type":"object",
    "properties":{
        "ruleHistory":{
            "title":"Rule History Object",
            "type":"object",
            "properties":{
                "ruleId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
                    "format":"UUID",
                    "example":"704A7178208D44BC9AD52556B18933C3"
                },
                "jobId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
                    "format":"UUID",
                    "example":"0E2428167F66445BAB544C7CDD884E87"
                },
                "jobStatus":{
                    "type":"string",
                    "description":"Job Status",
                    "example":"Success",
                    "enum":[
                        "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"
                    ]
                },
                "ruleName":{
                    "type":"string",
                    "description":"Rule Name",
                    "example":"Calculate BMI"
                },
                "jobStartDate":{
                    "type":"string",
                    "description":"Job Start Date",
                    "example":"2025-09-07 19:12:08.747"
                },
                "userId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the user that initiated the rule execution.",
                    "format":"UUID",
                    "example":"0000000000000000000000000000000A"
                },
                "countPassedSubjects":{
                    "type":"integer",
                    "description":"Number of subjects for which the rule passed.",
                    "example":1
                },
                "countFailedSubjects":{
                    "type":"integer",
                    "description":"Number of subjects for which the rule failed.",
                    "example":0
                }
            },
            "description":"Rule history object"
        },
        "status":{
            "type":"string",
            "description":"Rule Execution History request status or error message",
            "example":"success"
        }
    },
    "description":"Object containing a list of Rule Execution History Objects"
}

Nested Schema : Rule History Object

Type: object

Title: Rule History Object

Rule history object

Show Source

• countFailedSubjects: integer
  Number of subjects for which the rule failed.

  Example: 0
• countPassedSubjects: integer
  Number of subjects for which the rule passed.

  Example: 1
• jobId: string (UUID)
  Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.

  Example: 0E2428167F66445BAB544C7CDD884E87
• jobStartDate: string
  Job Start Date

  Example: 2025-09-07 19:12:08.747
• jobStatus: string
  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" ]

  Job Status

  Example: Success
• ruleId: string (UUID)
  Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.

  Example: 704A7178208D44BC9AD52556B18933C3
• ruleName: string
  Rule Name

  Example: Calculate BMI
• userId: string (UUID)
  Identifier((UUID, 32-character uppercase hexadecimal string)) for the user that initiated the rule execution.

  Example: 0000000000000000000000000000000A

{
    "title":"Rule History Object",
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
            "format":"UUID",
            "example":"704A7178208D44BC9AD52556B18933C3"
        },
        "jobId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
            "format":"UUID",
            "example":"0E2428167F66445BAB544C7CDD884E87"
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "example":"Success",
            "enum":[
                "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"
            ]
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "example":"Calculate BMI"
        },
        "jobStartDate":{
            "type":"string",
            "description":"Job Start Date",
            "example":"2025-09-07 19:12:08.747"
        },
        "userId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the user that initiated the rule execution.",
            "format":"UUID",
            "example":"0000000000000000000000000000000A"
        },
        "countPassedSubjects":{
            "type":"integer",
            "description":"Number of subjects for which the rule passed.",
            "example":1
        },
        "countFailedSubjects":{
            "type":"integer",
            "description":"Number of subjects for which the rule failed.",
            "example":0
        }
    },
    "description":"Rule history object"
}

Examples

Select an example Missing Rule ID

Back to Top