1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Rule Designer
  4. Rule Management
  5. Get all rules based on filter parameters

v1.0

post

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

Retrieves rule management summaries by applying form, question, state, enabled, or validation filters. Multiple filters can be combined and the request body example illustrates supported fields and pagination controls. Compared to the v0.9 legacy endpoint, v1.0 introduces server-side pagination and explicit sort ordering to reduce payload sizes.

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
  • 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
Filter criteria applied when retrieving rule management summaries.
Show Source
  • Minimum Length: 36
    Maximum Length: 36
    Pattern: ^[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}$
    Form identifier used to constrain the rule list. Accepts a UUID string.
    Example: 39903D6C-042D-4D9E-8977-3160488E6D3D
  • itemId
    Collection of item identifiers to include in the filter.
  • Minimum Length: 7
    Maximum Length: 8
    Allowed Values: [ "AllData", "FutureData" ]
    Execution scope for the rule. `AllData` updates historical and in-flight data, while `FutureData` restricts updates to newly captured data.
    Example: FutureData
  • Minimum Length: 1
    Maximum Length: 1
    Flag representing whether rules should be enabled (`1`) or disabled (`0`).
    Example: 1
  • ruleState
    List of rule states to include in the response.
  • Minimum Length: 4
    Maximum Length: 5
    Indicator for training mode enablement. Accepts the literal values `true`, `false`, or is omitted to include all records.
    Example: true
  • Minimum Length: 4
    Maximum Length: 64
    Column used to sort the result set. Defaults to form, question, and rule name when not provided.
    Example: ruleName
  • Minimum Length: 3
    Maximum Length: 4
    Allowed Values: [ "ASC", "DESC" ]
    Sort order for the column. `ASC` sorts results in ascending order, while `DESC` sorts in descending order.
    Example: ASC
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-Fa-f]{32}$
    User identifier associated with the most recent rule update.
    Example: 0000000000000000000000000000000A
  • Minimum Length: 1
    Maximum Length: 64
    User friendly name for the rule owner or last modifier. Filter is case-insensitive.
    Example: jsmith
Nested Schema : itemId
Type: array
Collection of item identifiers to include in the filter.
Show Source
  • Minimum Length: 36
    Maximum Length: 36
    Pattern: ^[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}$
    Item identifier expressed as a canonical UUID string without braces.
    Example: 2f4f4e67-e0ce-4be0-bb95-44d2cd38a569
Example:
[
    "2F4F4E67-E0CE-4BE0-BB95-44D2CD38A569"
]
Nested Schema : ruleState
Type: array
List of rule states to include in the response.
Show Source
  • Minimum Length: 4
    Maximum Length: 8
    Allowed Values: [ "draft", "uat", "approved", "publish" ]
    Rule state indicator.
    Example: approved
Example:
[
    "draft",
    "publish"
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Success.
Body ()
Root Schema : BulkRuleMgmtFilterResponseDoc
Type: object
Paginated response for filtered rule summaries.
Show Source
Nested Schema : resultData
Type: array
Filtered rule summaries matching the supplied criteria.
Show Source
Example:
[
    {
        "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A",
        "ruleName":"Out of Range Visit Date",
        "ruleState":"approved",
        "ruleValidationStatus":"true"
    }
]
Nested Schema : BulkRuleMgmtRuleSummaryDoc
Type: object
Rule summary entry returned by the bulk filter endpoint.
Show Source
  • Minimum Length: 2
    Maximum Length: 128
    Name of the associated form.
    Example: Screening Visit
  • Minimum Length: 2
    Maximum Length: 64
    Reference identifier for the related form.
    Example: SCR_VISIT
  • Minimum Length: 20
    Maximum Length: 30
    Timestamp for the last modification.
    Example: 2025-11-02T14:45:22Z
  • Minimum Length: 7
    Maximum Length: 8
    Allowed Values: [ "AllData", "FutureData" ]
    Publish scope applied to the rule.
    Example: AllData
  • Minimum Length: 2
    Maximum Length: 128
    Name of the question or data element.
    Example: Visit Date
  • Minimum Length: 2
    Maximum Length: 64
    Reference identifier for the related question.
    Example: VISIT_DATE
  • Minimum Length: 2
    Maximum Length: 64
    The record type targeted by the rule action.
    Example: VISIT
  • Minimum Length: 5
    Maximum Length: 64
    Action executed when the rule evaluates to true.
    Example: CREATE_QUERY
  • Minimum Value: 0
    Maximum Value: 1
    Indicates whether the rule is marked deleted (0 = active, 1 = deleted).
    Example: 0
  • Minimum Length: 3
    Maximum Length: 1024
    Purpose or behavior of the rule.
    Example: Creates a query when visit date falls outside the allowable window.
  • Minimum Value: 0
    Maximum Value: 1
    Indicates whether the rule is enabled (1) or disabled (0).
    Example: 1
  • Minimum Length: 4
    Maximum Length: 5
    Allowed Values: [ "true", "false" ]
    Indicates whether the rule has been executed in production previously.
    Example: false
  • Minimum Length: 32
    Maximum Length: 36
    Unique identifier of the rule.
    Example: 8E2253D8E53A4A46BAE3E4952CBE9E5A
  • Minimum Length: 3
    Maximum Length: 256
    Human readable name for the rule.
    Example: Out of Range Visit Date
  • Minimum Value: 0
    Maximum Value: 9999
    Display order used when listing the rule.
    Example: 10
  • Minimum Length: 2
    Maximum Length: 32
    Allowed Values: [ "UI", "API", "INTEGRATION" ]
    Origin of the rule. `UI` denotes portal-authored rules, `API` covers service integrations, and `INTEGRATION` represents synchronized external logic.
    Example: UI
  • Minimum Length: 3
    Maximum Length: 256
    Unique reference name for the rule.
    Example: VISIT_DATE_RANGE_VALIDATION
  • Minimum Length: 5
    Maximum Length: 8
    Allowed Values: [ "draft", "uat", "approved", "publish" ]
    Lifecycle state of the rule.
    Example: approved
  • Minimum Length: 4
    Maximum Length: 5
    Allowed Values: [ "true", "false" ]
    Flag showing whether training mode is enabled for the rule (`true` enables training execution, `false` excludes training records).
    Example: false
  • Minimum Length: 1
    Maximum Length: 512
    Message associated with the last validation result.
    Example: Rule evaluated successfully.
  • Minimum Length: 4
    Maximum Length: 5
    Allowed Values: [ "true", "false" ]
    Indicates whether the rule validated successfully in its last execution (`true` means validation passed, `false` captures warnings or errors).
    Example: true
  • Minimum Length: 32
    Maximum Length: 32
    Identifier of the last modifying user.
    Example: 0000000000000000000000000000000A
  • Minimum Length: 2
    Maximum Length: 64
    Name of the last modifying user.
    Example: jsmith
  • Minimum Length: 20
    Maximum Length: 30
    Timestamp when the rule version ended.
    Example: 2026-01-15T08:30:00Z
  • Minimum Length: 20
    Maximum Length: 30
    Timestamp when the rule version started.
    Example: 2025-09-07T19:12:08Z
Example:
{
    "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A",
    "ruleName":"Out of Range Visit Date",
    "ruleState":"approved",
    "ruleValidationStatus":"true"
}
Examples

400 Response

Returned when the supplied parameters fail validation or use an unsupported combination of filter values.
Body ()
Root 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."
}
Examples

500 Response

Returned when the service encounters an unexpected server-side error while processing the request.
Body ()
Root 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."
}
Examples

Back to Top