REST API for Clinical One Cloud Service

v1.0

get

/ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/form/{formId}/valid

Retrieves a list of rules which are in both valid and enabled states that belong to a given form.

Request

Path Parameters

formId(required): string(uuid)
Optional item identifier filter. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
Example:
```
39903D6C042D4D9E89773160488E6D3D
```
mode(required): string
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
```
studyId(required): string(uuid)
Unique study identifier supplied as a UUID. Accepts either a compact 32-character hexadecimal value or a hyphenated 36-character UUID.
Example:
```
36753A48BBA048CB98A5F3278146118D
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success.

Root Schema : RuleSummaryResponseDoc

Type: object

Standard envelope containing rule summary results.

Show Source

result: object RuleSummaryListDoc

Collection of rule summaries returned from list endpoints.
status(required): string

Allowed Values: [ "success", "failed" ]

Overall status of the request. Allowed values: success, failed.

Example: success

{
    "required":[
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Overall status of the request. Allowed values: success, failed.",
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "$ref":"#/components/schemas/RuleSummaryListDoc"
        }
    },
    "description":"Standard envelope containing rule summary results."
}

Nested Schema : RuleSummaryListDoc

Type: object

Collection of rule summaries returned from list endpoints.

Show Source

rules: array rules

Rule summaries matching the supplied filters.

{
    "type":"object",
    "properties":{
        "rules":{
            "type":"array",
            "description":"Rule summaries matching the supplied filters.",
            "example":[
                {
                    "ruleId":"82A65F8F6AAF47FFB177662E3931E7C0",
                    "ruleName":"Visit Start Date Validation",
                    "ruleValidationStatus":"true"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/RuleSummaryDoc"
            }
        }
    },
    "description":"Collection of rule summaries returned from list endpoints.",
    "nullable":true,
    "example":{
        "rules":[
            {
                "ruleId":"82A65F8F6AAF47FFB177662E3931E7C0",
                "ruleName":"Visit Start Date Validation"
            }
        ]
    }
}

Example:

{
    "rules":[
        {
            "ruleId":"82A65F8F6AAF47FFB177662E3931E7C0",
            "ruleName":"Visit Start Date Validation"
        }
    ]
}

Nested Schema : rules

Type: array

Rule summaries matching the supplied filters.

Show Source

Array of: object RuleSummaryDoc

Rule summary entry returned by the list endpoints.

{
    "type":"array",
    "description":"Rule summaries matching the supplied filters.",
    "example":[
        {
            "ruleId":"82A65F8F6AAF47FFB177662E3931E7C0",
            "ruleName":"Visit Start Date Validation",
            "ruleValidationStatus":"true"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/RuleSummaryDoc"
    }
}

Example:

[
    {
        "ruleId":"82A65F8F6AAF47FFB177662E3931E7C0",
        "ruleName":"Visit Start Date Validation",
        "ruleValidationStatus":"true"
    }
]

Nested Schema : RuleSummaryDoc

Type: object

Rule summary entry returned by the list endpoints.

Show Source

actions: array actions

Actions triggered when the rule evaluates to true.
operands: array operands

Operands referenced when the rule executes.
ruleDescription: string

Business purpose or description of the rule.

Example: Creates a query when visit date falls outside the allowable window.
ruleId(required): string

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}$

Unique identifier of the rule. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.

Example: 82A65F8F6AAF47FFB177662E3931E7C0
ruleName(required): string

Human readable rule name displayed in the designer UI.

Example: Visit Start Date Validation
ruleOriginType: string

Allowed Values: [ "UI", "API", "INTEGRATION" ]

Origin of the rule configuration.

Example: UI
ruleValidationMessage: string

Text explaining the latest validation result.

Example: Rule evaluated successfully.
ruleValidationStatus: string

Allowed Values: [ "true", "false" ]

Validation result indicator. `true` means validation passed; `false` indicates warnings or errors.

Example: true

{
    "required":[
        "ruleId",
        "ruleName"
    ],
    "type":"object",
    "properties":{
        "ruleId":{
            "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":"Unique identifier of the rule. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.",
            "example":"82A65F8F6AAF47FFB177662E3931E7C0"
        },
        "ruleName":{
            "type":"string",
            "description":"Human readable rule name displayed in the designer UI.",
            "example":"Visit Start Date Validation"
        },
        "ruleDescription":{
            "type":"string",
            "description":"Business purpose or description of the rule.",
            "nullable":true,
            "example":"Creates a query when visit date falls outside the allowable window."
        },
        "ruleValidationStatus":{
            "type":"string",
            "description":"Validation result indicator. `true` means validation passed; `false` indicates warnings or errors.",
            "nullable":true,
            "example":"true",
            "enum":[
                "true",
                "false"
            ]
        },
        "ruleValidationMessage":{
            "type":"string",
            "description":"Text explaining the latest validation result.",
            "nullable":true,
            "example":"Rule evaluated successfully."
        },
        "ruleOriginType":{
            "type":"string",
            "description":"Origin of the rule configuration.",
            "nullable":true,
            "example":"UI",
            "enum":[
                "UI",
                "API",
                "INTEGRATION"
            ]
        },
        "actions":{
            "type":"array",
            "description":"Actions triggered when the rule evaluates to true.",
            "example":[
                {
                    "ruleActionTypeName":"CREATE_QUERY",
                    "formId":"39903D6C042D4D9E89773160488E6D3D"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/RuleSummaryActionDoc"
            }
        },
        "operands":{
            "type":"array",
            "description":"Operands referenced when the rule executes.",
            "example":[
                {
                    "formId":"39903D6C042D4D9E89773160488E6D3D",
                    "itemId":"2F4F4E67E0CE4BE0BB9544D2CD38A569"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/RuleSummaryOperandDoc"
            }
        }
    },
    "description":"Rule summary entry returned by the list endpoints.",
    "example":{
        "ruleId":"82A65F8F6AAF47FFB177662E3931E7C0",
        "ruleName":"Visit Start Date Validation",
        "ruleOriginType":"UI"
    }
}

Example:

{
    "ruleId":"82A65F8F6AAF47FFB177662E3931E7C0",
    "ruleName":"Visit Start Date Validation",
    "ruleOriginType":"UI"
}

Nested Schema : actions

Type: array

Actions triggered when the rule evaluates to true.

Show Source

Array of: object RuleSummaryActionDoc

Action metadata describing what happens when the rule triggers.

{
    "type":"array",
    "description":"Actions triggered when the rule evaluates to true.",
    "example":[
        {
            "ruleActionTypeName":"CREATE_QUERY",
            "formId":"39903D6C042D4D9E89773160488E6D3D"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/RuleSummaryActionDoc"
    }
}

Example:

[
    {
        "ruleActionTypeName":"CREATE_QUERY",
        "formId":"39903D6C042D4D9E89773160488E6D3D"
    }
]

Nested Schema : operands

Type: array

Operands referenced when the rule executes.

Show Source

Array of: object RuleSummaryOperandDoc

Operand metadata used while evaluating the rule.

{
    "type":"array",
    "description":"Operands referenced when the rule executes.",
    "example":[
        {
            "formId":"39903D6C042D4D9E89773160488E6D3D",
            "itemId":"2F4F4E67E0CE4BE0BB9544D2CD38A569"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/RuleSummaryOperandDoc"
    }
}

Example:

[
    {
        "formId":"39903D6C042D4D9E89773160488E6D3D",
        "itemId":"2F4F4E67E0CE4BE0BB9544D2CD38A569"
    }
]

Nested Schema : RuleSummaryActionDoc

Type: object

Action metadata describing what happens when the rule triggers.

Show Source

eventId: string

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 of the event targeted by the action.

Example: 9B4AA96F48344015A259D6436EB97B47
formId: string

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}$

Unique identifier of the action target form.

Example: 39903D6C042D4D9E89773160488E6D3D
itemId: string

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}$

Unique identifier of the action target item.

Example: 2F4F4E67E0CE4BE0BB9544D2CD38A569
propertyName: string

Specific property referenced by the action.

Example: VISIT_START
propertyType: string

Allowed Values: [ "visit", "event", "form", "item", "none" ]

Optional property type affected by the action.

Example: form
ruleActionTypeName: string

Allowed Values: [ "CREATE_QUERY", "SEND_NOTIFICATION", "DISABLE_FIELD", "EXECUTE_CUSTOM_ACTION" ]

Action type performed when the rule fires.

Example: CREATE_QUERY

{
    "type":"object",
    "properties":{
        "formId":{
            "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":"Unique identifier of the action target form.",
            "nullable":true,
            "example":"39903D6C042D4D9E89773160488E6D3D"
        },
        "itemId":{
            "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":"Unique identifier of the action target item.",
            "nullable":true,
            "example":"2F4F4E67E0CE4BE0BB9544D2CD38A569"
        },
        "ruleActionTypeName":{
            "type":"string",
            "description":"Action type performed when the rule fires.",
            "nullable":true,
            "example":"CREATE_QUERY",
            "enum":[
                "CREATE_QUERY",
                "SEND_NOTIFICATION",
                "DISABLE_FIELD",
                "EXECUTE_CUSTOM_ACTION"
            ]
        },
        "propertyType":{
            "type":"string",
            "description":"Optional property type affected by the action.",
            "nullable":true,
            "example":"form",
            "enum":[
                "visit",
                "event",
                "form",
                "item",
                "none"
            ]
        },
        "propertyName":{
            "type":"string",
            "description":"Specific property referenced by the action.",
            "nullable":true,
            "example":"VISIT_START"
        },
        "eventId":{
            "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 of the event targeted by the action.",
            "nullable":true,
            "example":"9B4AA96F48344015A259D6436EB97B47"
        }
    },
    "description":"Action metadata describing what happens when the rule triggers."
}

Nested Schema : RuleSummaryOperandDoc

Type: object

Operand metadata used while evaluating the rule.

Show Source

eventId: string

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}$

Unique identifier of the operand event.

Example: 9B4AA96F48344015A259D6436EB97B47
formId: string

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}$

Unique identifier of the operand form.

Example: 39903D6C042D4D9E89773160488E6D3D
itemId: string

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}$

Unique identifier of the operand item.

Example: 2F4F4E67E0CE4BE0BB9544D2CD38A569
mapRelation: string

Allowed Values: [ "ANY", "ALL", "NONE" ]

Relationship between this operand and the other operands.

Example: ALL

{
    "type":"object",
    "properties":{
        "eventId":{
            "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":"Unique identifier of the operand event.",
            "nullable":true,
            "example":"9B4AA96F48344015A259D6436EB97B47"
        },
        "formId":{
            "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":"Unique identifier of the operand form.",
            "nullable":true,
            "example":"39903D6C042D4D9E89773160488E6D3D"
        },
        "itemId":{
            "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":"Unique identifier of the operand item.",
            "nullable":true,
            "example":"2F4F4E67E0CE4BE0BB9544D2CD38A569"
        },
        "mapRelation":{
            "type":"string",
            "description":"Relationship between this operand and the other operands.",
            "nullable":true,
            "example":"ALL",
            "enum":[
                "ANY",
                "ALL",
                "NONE"
            ]
        }
    },
    "description":"Operand metadata used while evaluating the rule."
}

Examples

400 Response

Returned when the supplied parameters fail validation or use an unsupported combination of filter values.

Root Schema : RuleSummaryErrorDoc

Type: object

Error structure returned when a rule list request fails.

Show Source

details: string

Optional context giving additional remediation detail.

Example: Provide at least one ruleId in the query.
errorCode(required): string

Machine readable error code.

Example: RuleSvc-030
errorMessage(required): string

Human-readable explanation that helps resolve the failure.

Example: Invalid UUID list. One or more elements are invalid. Must contain at least one element.
result: string

Successful payload content is null for errors.

Example: null
status(required): string

Allowed Values: [ "failed" ]

Status string indicating the request failed.

Example: failed

{
    "required":[
        "errorCode",
        "errorMessage",
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status string indicating the request failed.",
            "example":"failed",
            "enum":[
                "failed"
            ]
        },
        "result":{
            "type":"string",
            "description":"Successful payload content is null for errors.",
            "nullable":true,
            "example":"null"
        },
        "errorCode":{
            "type":"string",
            "description":"Machine readable error code.",
            "example":"RuleSvc-030"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable explanation that helps resolve the failure.",
            "example":"Invalid UUID list. One or more elements are invalid. Must contain at least one element."
        },
        "details":{
            "type":"string",
            "description":"Optional context giving additional remediation detail.",
            "nullable":true,
            "example":"Provide at least one ruleId in the query."
        }
    },
    "description":"Error structure returned when a rule list request fails."
}

Examples

500 Response

Returned when no data is available for the supplied study context or identifiers.

Root Schema : RuleSummaryErrorDoc

Type: object

Error structure returned when a rule list request fails.

Show Source

details: string

Optional context giving additional remediation detail.

Example: Provide at least one ruleId in the query.
errorCode(required): string

Machine readable error code.

Example: RuleSvc-030
errorMessage(required): string

Human-readable explanation that helps resolve the failure.

Example: Invalid UUID list. One or more elements are invalid. Must contain at least one element.
result: string

Successful payload content is null for errors.

Example: null
status(required): string

Allowed Values: [ "failed" ]

Status string indicating the request failed.

Example: failed

{
    "required":[
        "errorCode",
        "errorMessage",
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status string indicating the request failed.",
            "example":"failed",
            "enum":[
                "failed"
            ]
        },
        "result":{
            "type":"string",
            "description":"Successful payload content is null for errors.",
            "nullable":true,
            "example":"null"
        },
        "errorCode":{
            "type":"string",
            "description":"Machine readable error code.",
            "example":"RuleSvc-030"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable explanation that helps resolve the failure.",
            "example":"Invalid UUID list. One or more elements are invalid. Must contain at least one element."
        },
        "details":{
            "type":"string",
            "description":"Optional context giving additional remediation detail.",
            "nullable":true,
            "example":"Provide at least one ruleId in the query."
        }
    },
    "description":"Error structure returned when a rule list request fails."
}

Examples