REST API for Clinical One Platform

Get rule by property

get

/ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/propertyType/{propertyType}

Retrieves a list of rules and related actions based on a property.

Request

Path Parameters

mode(required): string

Study Mode
propertyType(required): string

Property Type
studyId(required): string(uuid)

Study Id

Query Parameters

eventId: string(uuid)

Event Id (just for backward compatibility ignored for rds rules)
eventInstanceNumber: number

Event Instance Number (just for backward compatibility ignored for rds rules)
formId: string(uuid)

Form Id (just for backward compatibility ignored for rds rules)
propertyName(required): string

Property Name
studyVersion: string

Study Version (just for backward compatibility ignored for rds rules)
valid: string

Fetch valid Rules (true/false)

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object RulesListDTOV2

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

Nested Schema : RulesListDTOV2

Type: object

Show Source

empty: boolean
rules: array rules

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleActionsDetailDTOV2"
            }
        }
    }
}

Nested Schema : rules

Type: array

Show Source

Array of: object RuleActionsDetailDTOV2

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

Nested Schema : RuleActionsDetailDTOV2

Type: object

Show Source

actions: array actions
async: number
eventId: string (uuid)
eventInstanceNumber: number
formId: string (uuid)
itemId: string (uuid)
propertyName: string
propertyType: string
ruleDescription: string
ruleEnabled: number
ruleExpr: string
ruleId: string (uuid)
ruleJSExpr: string
ruleName: string
ruleOrder: number
ruleOriginType: string
rulePayload: string
ruleRefName: string
ruleState: string
ruleValidationStatus: string
ruleVersionNumber: number
runAllEvents: number
runAllRepeats: number

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "format":"uuid"
        },
        "ruleRefName":{
            "type":"string"
        },
        "ruleVersionNumber":{
            "type":"number"
        },
        "ruleExpr":{
            "type":"string"
        },
        "ruleJSExpr":{
            "type":"string"
        },
        "ruleOrder":{
            "type":"number"
        },
        "ruleEnabled":{
            "type":"number"
        },
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "eventInstanceNumber":{
            "type":"number"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        },
        "actions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleActionDetailDTO"
            }
        },
        "ruleName":{
            "type":"string"
        },
        "ruleDescription":{
            "type":"string"
        },
        "ruleOriginType":{
            "type":"string"
        },
        "ruleState":{
            "type":"string"
        },
        "rulePayload":{
            "type":"string"
        },
        "ruleValidationStatus":{
            "type":"string"
        },
        "propertyType":{
            "type":"string"
        },
        "propertyName":{
            "type":"string"
        },
        "async":{
            "type":"number"
        },
        "runAllRepeats":{
            "type":"number"
        },
        "runAllEvents":{
            "type":"number"
        }
    }
}

Nested Schema : actions

Type: array

Show Source

Array of: object RuleActionDetailDTO

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

Nested Schema : RuleActionDetailDTO

Type: object

Show Source

ruleActionDescription: string
ruleActionId: string (uuid)
ruleActionOrder: number
ruleActionParams: string
ruleActionTarget: string
ruleActionTypeName: string

{
    "type":"object",
    "properties":{
        "ruleActionId":{
            "type":"string",
            "format":"uuid"
        },
        "ruleActionTypeName":{
            "type":"string"
        },
        "ruleActionTarget":{
            "type":"string"
        },
        "ruleActionOrder":{
            "type":"number"
        },
        "ruleActionDescription":{
            "type":"string"
        },
        "ruleActionParams":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

Root Schema : RDSRestErrorDataDTO

Type: object

Read Only: true

Error details from Rule Designer APIs

Show Source

details: object details

Read Only: true

Error Details
errorCode: string

Read Only: true

Error Code
errorMessage: string

Read Only: true

Error Message
result: string

Read Only: true

Result
status: string

Read Only: true

Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : details

Type: object

Read Only: true

Error Details

500 Response

No data found for supplied parameters.

Root Schema : RDSRestErrorDataDTO

Type: object

Read Only: true

Error details from Rule Designer APIs

Show Source

details: object details

Read Only: true

Error Details
errorCode: string

Read Only: true

Error Code
errorMessage: string

Read Only: true

Error Message
result: string

Read Only: true

Result
status: string

Read Only: true

Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : details

Type: object

Read Only: true

Error Details