Jump to

• Request
• Response

Cancel job

put

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

Cancels job associated with a given rule ID, if the job is in pending or running state.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  C360089F838D4DD980322DE22545C49F

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Rule IDs Object

Type: object

Title: Rule IDs Object

Object containing a list of Rule IDs

Show Source

• ruleIds(required): array ruleIds
  list of Rule Unique GUIDs

{
    "title":"Rule IDs Object",
    "required":[
        "ruleIds"
    ],
    "type":"object",
    "properties":{
        "ruleIds":{
            "type":"array",
            "description":"list of Rule Unique GUIDs",
            "format":"UUID",
            "example":[
                "938D23FA6B7241CCA41BD627E5DB60DA",
                "699EF3745FC545589F186D2198F3C65E"
            ],
            "items":{
                "type":"string",
                "description":"list of Rule Unique GUIDs",
                "format":"uuid"
            }
        }
    },
    "description":"Object containing a list of Rule IDs"
}

Nested Schema : ruleIds

Type: array

list of Rule Unique GUIDs

Show Source

• Array of: string(uuid)
  list of Rule Unique GUIDs

{
    "type":"array",
    "description":"list of Rule Unique GUIDs",
    "format":"UUID",
    "example":[
        "938D23FA6B7241CCA41BD627E5DB60DA",
        "699EF3745FC545589F186D2198F3C65E"
    ],
    "items":{
        "type":"string",
        "description":"list of Rule Unique GUIDs",
        "format":"uuid"
    }
}

Example:

[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]

Examples

Select an example Rule IDs Object

Back to Top

Response

Supported Media Types

• application/json

200 Response

Rule execution was successful.

Body ()

Root Schema : Job Status List Response

Type: object

Title: Job Status List Response

Response object containing list of Job statuses

Show Source

• errorMessage: string
  Error message if any

  Example: Success
• jobStatus: object Job Status Response
  Title: Job Status Response

  Job status response object

{
    "title":"Job Status List Response",
    "type":"object",
    "properties":{
        "jobStatus":{
            "title":"Job Status Response",
            "type":"object",
            "properties":{
                "ruleId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
                    "format":"UUID",
                    "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
                },
                "jobId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
                    "format":"UUID",
                    "example":"91F4E249F44C4C14A372EE30CEA6B7A8"
                },
                "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"
                }
            },
            "description":"Job status response object"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message if any",
            "example":"Success"
        }
    },
    "description":"Response object containing list of Job statuses"
}

Nested Schema : Job Status Response

Type: object

Title: Job Status Response

Job status response object

Show Source

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

  Example: 91F4E249F44C4C14A372EE30CEA6B7A8
• 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: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• ruleName: string
  Rule Name

  Example: Calculate BMI

{
    "title":"Job Status Response",
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
            "format":"UUID",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "jobId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
            "format":"UUID",
            "example":"91F4E249F44C4C14A372EE30CEA6B7A8"
        },
        "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"
        }
    },
    "description":"Job status response object"
}

Examples

Select an example Successful results Successful with some non-existent rules

400 Response

Incorrect payload.

Body ()

Root Schema : Job Status List Response

Type: object

Title: Job Status List Response

Response object containing list of Job statuses

Show Source

• errorMessage: string
  Error message if any

  Example: Success
• jobStatus: object Job Status Response
  Title: Job Status Response

  Job status response object

{
    "title":"Job Status List Response",
    "type":"object",
    "properties":{
        "jobStatus":{
            "title":"Job Status Response",
            "type":"object",
            "properties":{
                "ruleId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
                    "format":"UUID",
                    "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
                },
                "jobId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
                    "format":"UUID",
                    "example":"91F4E249F44C4C14A372EE30CEA6B7A8"
                },
                "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"
                }
            },
            "description":"Job status response object"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message if any",
            "example":"Success"
        }
    },
    "description":"Response object containing list of Job statuses"
}

Nested Schema : Job Status Response

Type: object

Title: Job Status Response

Job status response object

Show Source

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

  Example: 91F4E249F44C4C14A372EE30CEA6B7A8
• 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: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• ruleName: string
  Rule Name

  Example: Calculate BMI

{
    "title":"Job Status Response",
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
            "format":"UUID",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "jobId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
            "format":"UUID",
            "example":"91F4E249F44C4C14A372EE30CEA6B7A8"
        },
        "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"
        }
    },
    "description":"Job status response object"
}

Examples

Select an example Empty UUID List

500 Response

An internal error occurred.

Body ()

Root Schema : Job Status List Response

Type: object

Title: Job Status List Response

Response object containing list of Job statuses

Show Source

• errorMessage: string
  Error message if any

  Example: Success
• jobStatus: object Job Status Response
  Title: Job Status Response

  Job status response object

{
    "title":"Job Status List Response",
    "type":"object",
    "properties":{
        "jobStatus":{
            "title":"Job Status Response",
            "type":"object",
            "properties":{
                "ruleId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
                    "format":"UUID",
                    "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
                },
                "jobId":{
                    "type":"string",
                    "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
                    "format":"UUID",
                    "example":"91F4E249F44C4C14A372EE30CEA6B7A8"
                },
                "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"
                }
            },
            "description":"Job status response object"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message if any",
            "example":"Success"
        }
    },
    "description":"Response object containing list of Job statuses"
}

Nested Schema : Job Status Response

Type: object

Title: Job Status Response

Job status response object

Show Source

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

  Example: 91F4E249F44C4C14A372EE30CEA6B7A8
• 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: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• ruleName: string
  Rule Name

  Example: Calculate BMI

{
    "title":"Job Status Response",
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule.",
            "format":"UUID",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "jobId":{
            "type":"string",
            "description":"Identifier((UUID, 32-character uppercase hexadecimal string)) for the rule execution job.",
            "format":"UUID",
            "example":"91F4E249F44C4C14A372EE30CEA6B7A8"
        },
        "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"
        }
    },
    "description":"Job status response object"
}

Examples

Select an example Empty Request Body

Back to Top