1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Rule Designer
  4. Rule Management
  5. Allow rules to run on either All or Future data

v1.0

put

/ec-rule-designer-svc/rest/v1.0/rulemgt/studies/{studyId}/{mode}/{publishRun}

Updates rules in a study to execute, when published, for either all or future data only. Compared to the v0.9 endpoint, v1.0 centralizes the publish scope in the path parameter and validates rule identifiers before applying changes.

Request

Path Parameters
  • Study mode determines the data segment being managed. Allowed values: design (draft configuration workspace), test (UAT sandbox), training (sandbox for practice data), production (live subject data).
    Example:
    test
  • `AllData` republishes rules for existing and future subject data, while `FutureData` restricts the change to newly collected data.
    Example:
    AllData
  • Unique study identifier supplied as a UUID. Accepts either a compact 32-character hexadecimal value or a hyphenated 36-character UUID.
    Example:
    36753A48BBA048CB98A5F3278146118D
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Wrapper containing the rule identifiers targeted by a bulk operation.
Show Source
Nested Schema : ruleIds
Type: array
List of rule identifiers expressed as 32 character uppercase hexadecimal strings without separators.
Show Source
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Rule identifier expressed as a 32 character uppercase hexadecimal string without separators.
    Example: 938D23FA6B7241CCA41BD627E5DB60DA
Example:
[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Rule enable/disable was successful.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : BulkRulePublishRunResponseItemDoc
Type: object
Entry describing the outcome of a publish run update for a specific rule.
Show Source
  • BulkRuleMgmtErrorDoc
    Error payload returned when a request cannot be processed.
  • Minimum Value: 100
    Maximum Value: 599
    HTTP status code that would have been returned for this entry if processed individually.
    Example: 200
  • Minimum Length: 2
    Maximum Length: 64
    HTTP status text associated with the error code.
    Example: Success
  • Minimum Length: 5
    Maximum Length: 10
    Allowed Values: [ "Success", "Failed", "Error", "InProgress", "Queued" ]
    Processing outcome for the rule. `Success` means the publish run was updated, `Failed` signals a validation problem, `Error` reports an unexpected server issue, `InProgress` denotes an active update, and `Queued` indicates that processing has not started yet.
    Example: Success
  • BulkRulePublishRunResultDoc
    Result object returned when a publish run update succeeds.
  • Minimum Length: 32
    Maximum Length: 36
    Unique identifier of the rule.
    Example: 8E2253D8E53A4A46BAE3E4952CBE9E5A
  • Minimum Length: 3
    Maximum Length: 256
    Name of the rule.
    Example: Out of Range Visit Date
  • Minimum Length: 5
    Maximum Length: 512
    Validation message resulting from the publish run update.
    Example: Rule updated successfully.
  • Allowed Values: [ true, false ]
    Indicates whether the rule remains valid after processing. `true` means validation succeeded for the rule entry, while `false` records warnings or errors.
    Example: true
Example:
{
    "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A",
    "ruleName":"Out of Range Visit Date",
    "jobStatus":"Success",
    "ruleValidationMessage":"Rule updated successfully.",
    "ruleValidationStatus":true,
    "httpErrorCode":200,
    "httpErrorMessage":"Success",
    "result":{
        "status":"success",
        "result":"Publish run updated to AllData"
    },
    "error":null
}
Nested Schema : BulkRuleMgmtErrorDoc
Type: object
Error payload returned when a request cannot be processed.
Show Source
  • Minimum Length: 5
    Maximum Length: 512
    Optional contextual details that help the caller remediate the failure.
    Example: ruleIds must contain at least one value.
  • Minimum Length: 5
    Maximum Length: 32
    Application level error code.
    Example: JSON-004
  • Minimum Length: 10
    Maximum Length: 512
    Human-readable explanation of the error.
    Example: Invalid UUID list. One or more elements are invalid. Must contain at least one element.
  • Minimum Length: 5
    Maximum Length: 256
    Successful result content when available; typically null for errors.
    Example: No result returned because the request failed validation.
  • Minimum Length: 6
    Maximum Length: 6
    Allowed Values: [ "failed" ]
    Overall status of the call. `failed` indicates the request could not be completed, `success` is never returned for this payload.
    Example: failed
Example:
{
    "status":"failed",
    "result":null,
    "errorCode":"JSON-004",
    "errorMessage":"Invalid UUID list. One or more elements are invalid. Must contain at least one element.",
    "details":"ruleIds must contain at least one value."
}
Nested Schema : BulkRulePublishRunResultDoc
Type: object
Result object returned when a publish run update succeeds.
Show Source
  • Minimum Length: 5
    Maximum Length: 256
    Additional message describing the change that was applied.
    Example: Publish run updated to AllData
  • Minimum Length: 3
    Maximum Length: 10
    Allowed Values: [ "success", "failed", "error" ]
    Outcome status string. `success` indicates the publish run change applied, `failed` shows a validation issue, and `error` represents an unexpected exception.
    Example: success
Example:
{
    "status":"success",
    "result":"Publish run updated to AllData"
}
Examples

400 Response

Returned when the request payload is missing required fields, supplies invalid identifiers, or otherwise fails validation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : BulkRulePublishRunResponseItemDoc
Type: object
Entry describing the outcome of a publish run update for a specific rule.
Show Source
  • BulkRuleMgmtErrorDoc
    Error payload returned when a request cannot be processed.
  • Minimum Value: 100
    Maximum Value: 599
    HTTP status code that would have been returned for this entry if processed individually.
    Example: 200
  • Minimum Length: 2
    Maximum Length: 64
    HTTP status text associated with the error code.
    Example: Success
  • Minimum Length: 5
    Maximum Length: 10
    Allowed Values: [ "Success", "Failed", "Error", "InProgress", "Queued" ]
    Processing outcome for the rule. `Success` means the publish run was updated, `Failed` signals a validation problem, `Error` reports an unexpected server issue, `InProgress` denotes an active update, and `Queued` indicates that processing has not started yet.
    Example: Success
  • BulkRulePublishRunResultDoc
    Result object returned when a publish run update succeeds.
  • Minimum Length: 32
    Maximum Length: 36
    Unique identifier of the rule.
    Example: 8E2253D8E53A4A46BAE3E4952CBE9E5A
  • Minimum Length: 3
    Maximum Length: 256
    Name of the rule.
    Example: Out of Range Visit Date
  • Minimum Length: 5
    Maximum Length: 512
    Validation message resulting from the publish run update.
    Example: Rule updated successfully.
  • Allowed Values: [ true, false ]
    Indicates whether the rule remains valid after processing. `true` means validation succeeded for the rule entry, while `false` records warnings or errors.
    Example: true
Example:
{
    "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A",
    "ruleName":"Out of Range Visit Date",
    "jobStatus":"Success",
    "ruleValidationMessage":"Rule updated successfully.",
    "ruleValidationStatus":true,
    "httpErrorCode":200,
    "httpErrorMessage":"Success",
    "result":{
        "status":"success",
        "result":"Publish run updated to AllData"
    },
    "error":null
}
Nested Schema : BulkRuleMgmtErrorDoc
Type: object
Error payload returned when a request cannot be processed.
Show Source
  • Minimum Length: 5
    Maximum Length: 512
    Optional contextual details that help the caller remediate the failure.
    Example: ruleIds must contain at least one value.
  • Minimum Length: 5
    Maximum Length: 32
    Application level error code.
    Example: JSON-004
  • Minimum Length: 10
    Maximum Length: 512
    Human-readable explanation of the error.
    Example: Invalid UUID list. One or more elements are invalid. Must contain at least one element.
  • Minimum Length: 5
    Maximum Length: 256
    Successful result content when available; typically null for errors.
    Example: No result returned because the request failed validation.
  • Minimum Length: 6
    Maximum Length: 6
    Allowed Values: [ "failed" ]
    Overall status of the call. `failed` indicates the request could not be completed, `success` is never returned for this payload.
    Example: failed
Example:
{
    "status":"failed",
    "result":null,
    "errorCode":"JSON-004",
    "errorMessage":"Invalid UUID list. One or more elements are invalid. Must contain at least one element.",
    "details":"ruleIds must contain at least one value."
}
Nested Schema : BulkRulePublishRunResultDoc
Type: object
Result object returned when a publish run update succeeds.
Show Source
  • Minimum Length: 5
    Maximum Length: 256
    Additional message describing the change that was applied.
    Example: Publish run updated to AllData
  • Minimum Length: 3
    Maximum Length: 10
    Allowed Values: [ "success", "failed", "error" ]
    Outcome status string. `success` indicates the publish run change applied, `failed` shows a validation issue, and `error` represents an unexpected exception.
    Example: success
Example:
{
    "status":"success",
    "result":"Publish run updated to AllData"
}
Examples

500 Response

Returned when the service encounters an unexpected server-side error while processing the request.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : BulkRulePublishRunResponseItemDoc
Type: object
Entry describing the outcome of a publish run update for a specific rule.
Show Source
  • BulkRuleMgmtErrorDoc
    Error payload returned when a request cannot be processed.
  • Minimum Value: 100
    Maximum Value: 599
    HTTP status code that would have been returned for this entry if processed individually.
    Example: 200
  • Minimum Length: 2
    Maximum Length: 64
    HTTP status text associated with the error code.
    Example: Success
  • Minimum Length: 5
    Maximum Length: 10
    Allowed Values: [ "Success", "Failed", "Error", "InProgress", "Queued" ]
    Processing outcome for the rule. `Success` means the publish run was updated, `Failed` signals a validation problem, `Error` reports an unexpected server issue, `InProgress` denotes an active update, and `Queued` indicates that processing has not started yet.
    Example: Success
  • BulkRulePublishRunResultDoc
    Result object returned when a publish run update succeeds.
  • Minimum Length: 32
    Maximum Length: 36
    Unique identifier of the rule.
    Example: 8E2253D8E53A4A46BAE3E4952CBE9E5A
  • Minimum Length: 3
    Maximum Length: 256
    Name of the rule.
    Example: Out of Range Visit Date
  • Minimum Length: 5
    Maximum Length: 512
    Validation message resulting from the publish run update.
    Example: Rule updated successfully.
  • Allowed Values: [ true, false ]
    Indicates whether the rule remains valid after processing. `true` means validation succeeded for the rule entry, while `false` records warnings or errors.
    Example: true
Example:
{
    "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A",
    "ruleName":"Out of Range Visit Date",
    "jobStatus":"Success",
    "ruleValidationMessage":"Rule updated successfully.",
    "ruleValidationStatus":true,
    "httpErrorCode":200,
    "httpErrorMessage":"Success",
    "result":{
        "status":"success",
        "result":"Publish run updated to AllData"
    },
    "error":null
}
Nested Schema : BulkRuleMgmtErrorDoc
Type: object
Error payload returned when a request cannot be processed.
Show Source
  • Minimum Length: 5
    Maximum Length: 512
    Optional contextual details that help the caller remediate the failure.
    Example: ruleIds must contain at least one value.
  • Minimum Length: 5
    Maximum Length: 32
    Application level error code.
    Example: JSON-004
  • Minimum Length: 10
    Maximum Length: 512
    Human-readable explanation of the error.
    Example: Invalid UUID list. One or more elements are invalid. Must contain at least one element.
  • Minimum Length: 5
    Maximum Length: 256
    Successful result content when available; typically null for errors.
    Example: No result returned because the request failed validation.
  • Minimum Length: 6
    Maximum Length: 6
    Allowed Values: [ "failed" ]
    Overall status of the call. `failed` indicates the request could not be completed, `success` is never returned for this payload.
    Example: failed
Example:
{
    "status":"failed",
    "result":null,
    "errorCode":"JSON-004",
    "errorMessage":"Invalid UUID list. One or more elements are invalid. Must contain at least one element.",
    "details":"ruleIds must contain at least one value."
}
Nested Schema : BulkRulePublishRunResultDoc
Type: object
Result object returned when a publish run update succeeds.
Show Source
  • Minimum Length: 5
    Maximum Length: 256
    Additional message describing the change that was applied.
    Example: Publish run updated to AllData
  • Minimum Length: 3
    Maximum Length: 10
    Allowed Values: [ "success", "failed", "error" ]
    Outcome status string. `success` indicates the publish run change applied, `failed` shows a validation issue, and `error` represents an unexpected exception.
    Example: success
Example:
{
    "status":"success",
    "result":"Publish run updated to AllData"
}
Examples

Back to Top