Jump to

• Request
• Response

v1.0

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
  Study mode identifies the study data segment. Allowed values: design (draft workspace), test (UAT sandbox), training (practice environment), production (live subject data).

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C360089F838D4DD980322DE22545C49F

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

List of rule identifiers supplied to the re-execution APIs.

Show Source

• ruleIds: array ruleIds
  Ordered collection of rule identifiers to include. Provide between one and five hundred values.

{
    "type":"object",
    "properties":{
        "ruleIds":{
            "type":"array",
            "description":"Ordered collection of rule identifiers to include. Provide between one and five hundred values.",
            "example":[
                "0E1A63683F884B13A3E7BEE9CA4FF1EA",
                "DBF2C278385E4AF4BA4FBF2AA76D194F"
            ],
            "items":{
                "maxLength":36,
                "minLength":32,
                "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}$",
                "type":"string",
                "description":"Rule UUID. Accepts either a compact 32-character hexadecimal value or a hyphenated 36-character UUID.",
                "example":"E4C2D1B7A8F9465FB1E2A3C4D5879E10"
            }
        }
    },
    "description":"List of rule identifiers supplied to the re-execution APIs."
}

Nested Schema : ruleIds

Type: array

Ordered collection of rule identifiers to include. Provide between one and five hundred values.

Show Source

• Array of: string
  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}$

  Rule UUID. Accepts either a compact 32-character hexadecimal value or a hyphenated 36-character UUID.

  Example: E4C2D1B7A8F9465FB1E2A3C4D5879E10

{
    "type":"array",
    "description":"Ordered collection of rule identifiers to include. Provide between one and five hundred values.",
    "example":[
        "0E1A63683F884B13A3E7BEE9CA4FF1EA",
        "DBF2C278385E4AF4BA4FBF2AA76D194F"
    ],
    "items":{
        "maxLength":36,
        "minLength":32,
        "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}$",
        "type":"string",
        "description":"Rule UUID. Accepts either a compact 32-character hexadecimal value or a hyphenated 36-character UUID.",
        "example":"E4C2D1B7A8F9465FB1E2A3C4D5879E10"
    }
}

Example:

[
    "0E1A63683F884B13A3E7BEE9CA4FF1EA",
    "DBF2C278385E4AF4BA4FBF2AA76D194F"
]

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 : JobStatusResponse

Type: object

Response payload returned by rule job status endpoints.

Show Source

• errorMessage(required): string
  Minimum Length: 1

  Maximum Length: 512

  Overall outcome for the job status request. Provide "Success" when all jobs were evaluated successfully; otherwise supply a concise explanation of the failure.

  Example: Success
• jobStatus: array jobStatus
  Array of job status entries returned by the rule execution service. Allowed job status 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.

{
    "required":[
        "errorMessage"
    ],
    "type":"object",
    "properties":{
        "jobStatus":{
            "type":"array",
            "description":"Array of job status entries returned by the rule execution service. Allowed job status 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.",
            "example":[
                {
                    "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
                    "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
                    "jobStatus":"Success",
                    "ruleName":"onesection - create query with form submit dates",
                    "jobStartDate":"2025-09-07 19:12:08.747",
                    "groupJobId":"F8491962C1574F0A89195560670B59E8"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/JobStatusEntry"
            }
        },
        "errorMessage":{
            "maxLength":512,
            "minLength":1,
            "type":"string",
            "description":"Overall outcome for the job status request. Provide \"Success\" when all jobs were evaluated successfully; otherwise supply a concise explanation of the failure.",
            "example":"Success"
        }
    },
    "description":"Response payload returned by rule job status endpoints."
}

Nested Schema : jobStatus

Type: array

Array of job status entries returned by the rule execution service. Allowed job status 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.

Show Source

• Array of: object JobStatusEntry
  Single rule execution job status entry.

{
    "type":"array",
    "description":"Array of job status entries returned by the rule execution service. Allowed job status 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.",
    "example":[
        {
            "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
            "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
            "jobStatus":"Success",
            "ruleName":"onesection - create query with form submit dates",
            "jobStartDate":"2025-09-07 19:12:08.747",
            "groupJobId":"F8491962C1574F0A89195560670B59E8"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/JobStatusEntry"
    }
}

Example:

[
    {
        "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
        "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
        "jobStatus":"Success",
        "ruleName":"onesection - create query with form submit dates",
        "jobStartDate":"2025-09-07 19:12:08.747",
        "groupJobId":"F8491962C1574F0A89195560670B59E8"
    }
]

Nested Schema : JobStatusEntry

Type: object

Single rule execution job status entry.

Show Source

• groupJobId: string
  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 batch job that orchestrated this individual execution. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.

  Example: 589F499D700340DE866C8EF3ACCE1547
• jobId(required): string
  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: 91F4E249F44C4C14A372EE30CEA6B7A8
• jobStartDate: string
  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:12:08.747
• jobStatus(required): string
  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
• ruleId(required): string
  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: E4C2D1B7A8F9465FB1E2A3C4D5879E10
• ruleName: string
  Minimum Length: 1

  Maximum Length: 256

  Rule display name associated with the job execution.

  Example: onesection - create query with form submit dates

{
    "required":[
        "jobId",
        "jobStatus",
        "ruleId"
    ],
    "type":"object",
    "properties":{
        "ruleId":{
            "maxLength":36,
            "minLength":32,
            "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}$",
            "type":"string",
            "description":"Identifier for the rule. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.",
            "example":"E4C2D1B7A8F9465FB1E2A3C4D5879E10"
        },
        "jobId":{
            "maxLength":36,
            "minLength":32,
            "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}$",
            "type":"string",
            "description":"Identifier for the rule execution job. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.",
            "example":"91F4E249F44C4C14A372EE30CEA6B7A8"
        },
        "jobStatus":{
            "maxLength":64,
            "minLength":4,
            "type":"string",
            "description":"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",
            "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":{
            "maxLength":256,
            "minLength":1,
            "type":"string",
            "description":"Rule display name associated with the job execution.",
            "example":"onesection - create query with form submit dates"
        },
        "jobStartDate":{
            "maxLength":23,
            "minLength":23,
            "pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}\\.\\d{3}$",
            "type":"string",
            "description":"Job start timestamp formatted as yyyy-MM-dd HH:mm:ss.SSS in the service timezone.",
            "example":"2025-09-07 19:12:08.747"
        },
        "groupJobId":{
            "maxLength":36,
            "minLength":32,
            "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}$",
            "type":"string",
            "description":"Identifier for the batch job that orchestrated this individual execution. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.",
            "example":"589F499D700340DE866C8EF3ACCE1547"
        }
    },
    "description":"Single rule execution job status entry.",
    "example":{
        "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
        "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
        "jobStatus":"Success",
        "ruleName":"onesection - create query with form submit dates",
        "jobStartDate":"2025-09-07 19:12:08.747",
        "groupJobId":"F8491962C1574F0A89195560670B59E8"
    }
}

Example:

{
    "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
    "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
    "jobStatus":"Success",
    "ruleName":"onesection - create query with form submit dates",
    "jobStartDate":"2025-09-07 19:12:08.747",
    "groupJobId":"F8491962C1574F0A89195560670B59E8"
}

Examples

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

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 : JobStatusResponse

Type: object

Response payload returned by rule job status endpoints.

Show Source

• errorMessage(required): string
  Minimum Length: 1

  Maximum Length: 512

  Overall outcome for the job status request. Provide "Success" when all jobs were evaluated successfully; otherwise supply a concise explanation of the failure.

  Example: Success
• jobStatus: array jobStatus
  Array of job status entries returned by the rule execution service. Allowed job status 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.

{
    "required":[
        "errorMessage"
    ],
    "type":"object",
    "properties":{
        "jobStatus":{
            "type":"array",
            "description":"Array of job status entries returned by the rule execution service. Allowed job status 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.",
            "example":[
                {
                    "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
                    "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
                    "jobStatus":"Success",
                    "ruleName":"onesection - create query with form submit dates",
                    "jobStartDate":"2025-09-07 19:12:08.747",
                    "groupJobId":"F8491962C1574F0A89195560670B59E8"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/JobStatusEntry"
            }
        },
        "errorMessage":{
            "maxLength":512,
            "minLength":1,
            "type":"string",
            "description":"Overall outcome for the job status request. Provide \"Success\" when all jobs were evaluated successfully; otherwise supply a concise explanation of the failure.",
            "example":"Success"
        }
    },
    "description":"Response payload returned by rule job status endpoints."
}

Nested Schema : jobStatus

Type: array

Array of job status entries returned by the rule execution service. Allowed job status 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.

Show Source

• Array of: object JobStatusEntry
  Single rule execution job status entry.

{
    "type":"array",
    "description":"Array of job status entries returned by the rule execution service. Allowed job status 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.",
    "example":[
        {
            "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
            "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
            "jobStatus":"Success",
            "ruleName":"onesection - create query with form submit dates",
            "jobStartDate":"2025-09-07 19:12:08.747",
            "groupJobId":"F8491962C1574F0A89195560670B59E8"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/JobStatusEntry"
    }
}

Example:

[
    {
        "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
        "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
        "jobStatus":"Success",
        "ruleName":"onesection - create query with form submit dates",
        "jobStartDate":"2025-09-07 19:12:08.747",
        "groupJobId":"F8491962C1574F0A89195560670B59E8"
    }
]

Nested Schema : JobStatusEntry

Type: object

Single rule execution job status entry.

Show Source

• groupJobId: string
  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 batch job that orchestrated this individual execution. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.

  Example: 589F499D700340DE866C8EF3ACCE1547
• jobId(required): string
  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: 91F4E249F44C4C14A372EE30CEA6B7A8
• jobStartDate: string
  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:12:08.747
• jobStatus(required): string
  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
• ruleId(required): string
  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: E4C2D1B7A8F9465FB1E2A3C4D5879E10
• ruleName: string
  Minimum Length: 1

  Maximum Length: 256

  Rule display name associated with the job execution.

  Example: onesection - create query with form submit dates

{
    "required":[
        "jobId",
        "jobStatus",
        "ruleId"
    ],
    "type":"object",
    "properties":{
        "ruleId":{
            "maxLength":36,
            "minLength":32,
            "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}$",
            "type":"string",
            "description":"Identifier for the rule. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.",
            "example":"E4C2D1B7A8F9465FB1E2A3C4D5879E10"
        },
        "jobId":{
            "maxLength":36,
            "minLength":32,
            "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}$",
            "type":"string",
            "description":"Identifier for the rule execution job. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.",
            "example":"91F4E249F44C4C14A372EE30CEA6B7A8"
        },
        "jobStatus":{
            "maxLength":64,
            "minLength":4,
            "type":"string",
            "description":"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",
            "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":{
            "maxLength":256,
            "minLength":1,
            "type":"string",
            "description":"Rule display name associated with the job execution.",
            "example":"onesection - create query with form submit dates"
        },
        "jobStartDate":{
            "maxLength":23,
            "minLength":23,
            "pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}\\.\\d{3}$",
            "type":"string",
            "description":"Job start timestamp formatted as yyyy-MM-dd HH:mm:ss.SSS in the service timezone.",
            "example":"2025-09-07 19:12:08.747"
        },
        "groupJobId":{
            "maxLength":36,
            "minLength":32,
            "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}$",
            "type":"string",
            "description":"Identifier for the batch job that orchestrated this individual execution. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.",
            "example":"589F499D700340DE866C8EF3ACCE1547"
        }
    },
    "description":"Single rule execution job status entry.",
    "example":{
        "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
        "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
        "jobStatus":"Success",
        "ruleName":"onesection - create query with form submit dates",
        "jobStartDate":"2025-09-07 19:12:08.747",
        "groupJobId":"F8491962C1574F0A89195560670B59E8"
    }
}

Example:

{
    "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
    "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
    "jobStatus":"Success",
    "ruleName":"onesection - create query with form submit dates",
    "jobStartDate":"2025-09-07 19:12:08.747",
    "groupJobId":"F8491962C1574F0A89195560670B59E8"
}

Examples

Select an example Empty UUID List

500 Response

Returned when cancelRuleJob fails due to an unexpected server-side processing error.

Body ()

Root Schema : JobStatusResponse

Type: object

Response payload returned by rule job status endpoints.

Show Source

• errorMessage(required): string
  Minimum Length: 1

  Maximum Length: 512

  Overall outcome for the job status request. Provide "Success" when all jobs were evaluated successfully; otherwise supply a concise explanation of the failure.

  Example: Success
• jobStatus: array jobStatus
  Array of job status entries returned by the rule execution service. Allowed job status 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.

{
    "required":[
        "errorMessage"
    ],
    "type":"object",
    "properties":{
        "jobStatus":{
            "type":"array",
            "description":"Array of job status entries returned by the rule execution service. Allowed job status 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.",
            "example":[
                {
                    "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
                    "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
                    "jobStatus":"Success",
                    "ruleName":"onesection - create query with form submit dates",
                    "jobStartDate":"2025-09-07 19:12:08.747",
                    "groupJobId":"F8491962C1574F0A89195560670B59E8"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/JobStatusEntry"
            }
        },
        "errorMessage":{
            "maxLength":512,
            "minLength":1,
            "type":"string",
            "description":"Overall outcome for the job status request. Provide \"Success\" when all jobs were evaluated successfully; otherwise supply a concise explanation of the failure.",
            "example":"Success"
        }
    },
    "description":"Response payload returned by rule job status endpoints."
}

Nested Schema : jobStatus

Type: array

Array of job status entries returned by the rule execution service. Allowed job status 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.

Show Source

• Array of: object JobStatusEntry
  Single rule execution job status entry.

{
    "type":"array",
    "description":"Array of job status entries returned by the rule execution service. Allowed job status 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.",
    "example":[
        {
            "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
            "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
            "jobStatus":"Success",
            "ruleName":"onesection - create query with form submit dates",
            "jobStartDate":"2025-09-07 19:12:08.747",
            "groupJobId":"F8491962C1574F0A89195560670B59E8"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/JobStatusEntry"
    }
}

Example:

[
    {
        "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
        "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
        "jobStatus":"Success",
        "ruleName":"onesection - create query with form submit dates",
        "jobStartDate":"2025-09-07 19:12:08.747",
        "groupJobId":"F8491962C1574F0A89195560670B59E8"
    }
]

Nested Schema : JobStatusEntry

Type: object

Single rule execution job status entry.

Show Source

• groupJobId: string
  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 batch job that orchestrated this individual execution. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.

  Example: 589F499D700340DE866C8EF3ACCE1547
• jobId(required): string
  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: 91F4E249F44C4C14A372EE30CEA6B7A8
• jobStartDate: string
  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:12:08.747
• jobStatus(required): string
  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
• ruleId(required): string
  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: E4C2D1B7A8F9465FB1E2A3C4D5879E10
• ruleName: string
  Minimum Length: 1

  Maximum Length: 256

  Rule display name associated with the job execution.

  Example: onesection - create query with form submit dates

{
    "required":[
        "jobId",
        "jobStatus",
        "ruleId"
    ],
    "type":"object",
    "properties":{
        "ruleId":{
            "maxLength":36,
            "minLength":32,
            "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}$",
            "type":"string",
            "description":"Identifier for the rule. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.",
            "example":"E4C2D1B7A8F9465FB1E2A3C4D5879E10"
        },
        "jobId":{
            "maxLength":36,
            "minLength":32,
            "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}$",
            "type":"string",
            "description":"Identifier for the rule execution job. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.",
            "example":"91F4E249F44C4C14A372EE30CEA6B7A8"
        },
        "jobStatus":{
            "maxLength":64,
            "minLength":4,
            "type":"string",
            "description":"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",
            "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":{
            "maxLength":256,
            "minLength":1,
            "type":"string",
            "description":"Rule display name associated with the job execution.",
            "example":"onesection - create query with form submit dates"
        },
        "jobStartDate":{
            "maxLength":23,
            "minLength":23,
            "pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}\\.\\d{3}$",
            "type":"string",
            "description":"Job start timestamp formatted as yyyy-MM-dd HH:mm:ss.SSS in the service timezone.",
            "example":"2025-09-07 19:12:08.747"
        },
        "groupJobId":{
            "maxLength":36,
            "minLength":32,
            "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}$",
            "type":"string",
            "description":"Identifier for the batch job that orchestrated this individual execution. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.",
            "example":"589F499D700340DE866C8EF3ACCE1547"
        }
    },
    "description":"Single rule execution job status entry.",
    "example":{
        "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
        "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
        "jobStatus":"Success",
        "ruleName":"onesection - create query with form submit dates",
        "jobStartDate":"2025-09-07 19:12:08.747",
        "groupJobId":"F8491962C1574F0A89195560670B59E8"
    }
}

Example:

{
    "ruleId":"DBF2C278385E4AF4BA4FBF2AA76D194F",
    "jobId":"91F4E249F44C4C14A372EE30CEA6B7A8",
    "jobStatus":"Success",
    "ruleName":"onesection - create query with form submit dates",
    "jobStartDate":"2025-09-07 19:12:08.747",
    "groupJobId":"F8491962C1574F0A89195560670B59E8"
}

Examples

Select an example Empty Request Body

Back to Top