REST API for Clinical One Platform

Cancel rule jobs

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
studyId(required): string

Study Id

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

ruleIds(required): array ruleIds

list of Rule Unique GUIDs

{
    "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"
            }
        }
    }
}

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"
]

Response

Supported Media Types

application/json

200 Response

Rule execution was successful.

Root Schema : JobStatusTO

Type: object

Show Source

errorMessage: string
jobStatus: array jobStatus

{
    "type":"object",
    "properties":{
        "jobStatus":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/JobTO"
            }
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : jobStatus

Type: array

Show Source

Array of: object JobTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/JobTO"
    }
}

Nested Schema : JobTO

Type: object

Show Source

jobId: string
jobStartDate: string
jobStatus: string
ruleId: string
ruleName: string

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "jobStatus":{
            "type":"string"
        },
        "ruleName":{
            "type":"string"
        },
        "jobStartDate":{
            "type":"string"
        }
    }
}

400 Response

Incorrect payload

Root Schema : JobStatusTO

Type: object

Show Source

errorMessage: string
jobStatus: array jobStatus

{
    "type":"object",
    "properties":{
        "jobStatus":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/JobTO"
            }
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : jobStatus

Type: array

Show Source

Array of: object JobTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/JobTO"
    }
}

Nested Schema : JobTO

Type: object

Show Source

jobId: string
jobStartDate: string
jobStatus: string
ruleId: string
ruleName: string

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "jobStatus":{
            "type":"string"
        },
        "ruleName":{
            "type":"string"
        },
        "jobStartDate":{
            "type":"string"
        }
    }
}

500 Response

An internal error occured

Root Schema : JobStatusTO

Type: object

Show Source

errorMessage: string
jobStatus: array jobStatus

{
    "type":"object",
    "properties":{
        "jobStatus":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/JobTO"
            }
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : jobStatus

Type: array

Show Source

Array of: object JobTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/JobTO"
    }
}

Nested Schema : JobTO

Type: object

Show Source

jobId: string
jobStartDate: string
jobStatus: string
ruleId: string
ruleName: string

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "jobStatus":{
            "type":"string"
        },
        "ruleName":{
            "type":"string"
        },
        "jobStartDate":{
            "type":"string"
        }
    }
}