Jump to

• Request
• Response

Get rule by form ID

get

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

Retrieves a list of rules and related actions that belong to a form.

Request

Path Parameters

• formId(required): string(uuid)
  Form ID.

  Example:

  39903D6C042D4D9E89773160488E6D3D

• mode(required): string
  Study Mode. (Test, Training or Active)

  Example:

  est

• studyId(required): string(uuid)
  Study ID.

  Example:

  36753A48BBA048CB98A5F3278146118D

Query Parameters

• ruleEnabled: number
  Rule Enabled (1/0) - Optional Filter.

  Example:

  0

• ruleValidationStatus: string
  Rule Validation Status (true/false) - Optional Filter.

  Example:

  true

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RulesListDTO

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

Nested Schema : RulesListDTO

Type: object

Show Source

• empty: boolean
• rules: array rules

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

Nested Schema : rules

Type: array

Show Source

• Array of: object RuleActionsDetailDTO

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

Nested Schema : RuleActionsDetailDTO

Type: object

Show Source

• actions: array actions
• eventId: string (uuid)
  Unique ID of eventId
• eventInstanceNumber: number
  Event Instance Number (Null for non cyclic visits)

  Example: 1
• formId: string (uuid)
  Unique ID of formId
• itemId: string (uuid)
  Unique ID of itemId
• propertyName: string
  Visit Property for rule (used for Visit Start Date and Visit Information)

  Example: visitStartDate
• propertyType: string
  Visit Property for rule (used for Visit Start Date and Visit Information)

  Example: visit
• ruleDescription: string
  Rule Name description

  Example: This rule retrieves ORS Dispensation information to create a query.
• ruleEnabled: number
  Is the rule enabled or not?
• ruleExpr: string
  Rule Expression for the rule logic

  Example: Rule logic code here
• ruleId: string (uuid)
  Unique ID of rule
• ruleJSExpr: string
  Rule Javascript Expression for the rule logic

  Example: Rule logic code here
• ruleName: string
  Rule Name defined

  Example: Rule_GetDispensationinfo
• ruleOrder: number
  Order for the rule logic
• ruleOriginType: string
  Rule Name origin type (Custom Rules/ UI)

  Example: UI
• rulePayload: string
  Rule payload
• ruleRefName: string
  Unique rule ref name

  Example: RULE_B1B8327AFAA6412287106192AB5984EF
• ruleState: string
  State of rule (Draft, UAT, Approved, Published)

  Example: UAT
• ruleValidationStatus: string
  Validation status of rule on save

  Example: success
• ruleVersionNumber: number
  Rule Version Number for a given rule

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Unique ID of rule",
            "format":"uuid"
        },
        "ruleRefName":{
            "type":"string",
            "description":"Unique rule ref name",
            "example":"RULE_B1B8327AFAA6412287106192AB5984EF"
        },
        "ruleVersionNumber":{
            "type":"number",
            "description":"Rule Version Number for a given rule"
        },
        "ruleExpr":{
            "type":"string",
            "description":"Rule Expression for the rule logic",
            "example":"Rule logic code here"
        },
        "ruleJSExpr":{
            "type":"string",
            "description":"Rule Javascript Expression for the rule logic",
            "example":"Rule logic code here"
        },
        "ruleOrder":{
            "type":"number",
            "description":"Order for the rule logic"
        },
        "ruleEnabled":{
            "type":"number",
            "description":"Is the rule enabled or not?"
        },
        "eventId":{
            "type":"string",
            "description":"Unique ID of eventId",
            "format":"uuid"
        },
        "eventInstanceNumber":{
            "type":"number",
            "description":"Event Instance Number (Null for non cyclic visits)",
            "example":1
        },
        "formId":{
            "type":"string",
            "description":"Unique ID of formId",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Unique ID of itemId",
            "format":"uuid"
        },
        "actions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleActionDetailDTO"
            }
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name defined",
            "example":"Rule_GetDispensationinfo"
        },
        "ruleDescription":{
            "type":"string",
            "description":"Rule Name description",
            "example":"This rule retrieves ORS Dispensation information to create a query."
        },
        "ruleOriginType":{
            "type":"string",
            "description":"Rule Name origin type (Custom Rules/ UI)",
            "example":"UI"
        },
        "ruleState":{
            "type":"string",
            "description":"State of rule (Draft, UAT, Approved, Published)",
            "example":"UAT"
        },
        "rulePayload":{
            "type":"string",
            "description":"Rule payload"
        },
        "ruleValidationStatus":{
            "type":"string",
            "description":"Validation status of rule on save",
            "example":"success"
        },
        "propertyType":{
            "type":"string",
            "description":"Visit Property for rule (used for Visit Start Date and Visit Information)",
            "example":"visit"
        },
        "propertyName":{
            "type":"string",
            "description":"Visit Property for rule (used for Visit Start Date and Visit Information)",
            "example":"visitStartDate"
        }
    }
}

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
  Description of Rule Target action

  Example: Calculated values for target item.
• ruleActionId: string (uuid)
  Unique ID of rule action
• ruleActionOrder: number
  Rule target order
• ruleActionParams: string
  Parameters for rule action

  Example: RULE_6B1321B7038349038B81F2AB3F3DFED1 auto query
• ruleActionTarget: string
  Rule target item

  Example: null.79215164E0DC487A97E1B9FF2C03B14E.4DDA38E077C0461D94CD34E61B3A7B56
• ruleActionTypeName: string
  Rule target type name (Type of rule target)

  Example: Calculated values.

{
    "type":"object",
    "properties":{
        "ruleActionId":{
            "type":"string",
            "description":"Unique ID of rule action",
            "format":"uuid"
        },
        "ruleActionTypeName":{
            "type":"string",
            "description":"Rule target type name (Type of rule target)",
            "example":"Calculated values."
        },
        "ruleActionTarget":{
            "type":"string",
            "description":"Rule target item",
            "example":"null.79215164E0DC487A97E1B9FF2C03B14E.4DDA38E077C0461D94CD34E61B3A7B56"
        },
        "ruleActionOrder":{
            "type":"number",
            "description":"Rule target order"
        },
        "ruleActionDescription":{
            "type":"string",
            "description":"Description of Rule Target action",
            "example":"Calculated values for target item."
        },
        "ruleActionParams":{
            "type":"string",
            "description":"Parameters for rule action",
            "example":"RULE_6B1321B7038349038B81F2AB3F3DFED1 auto query"
        }
    }
}

Examples

Select an example RulesListDTOExample

400 Response

Bad request.

Body ()

Root Schema : RDSRestErrorDataDTO

Type: object

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",
    "example":{
        "errorCode":"RULE_ERROR",
        "errorMessage":"Rule execution failed"
    }
}

Example:

{
    "errorCode":"RULE_ERROR",
    "errorMessage":"Rule execution failed"
}

Nested Schema : details

Type: object

Read Only: true

Error Details

500 Response

No data found for supplied parameters.

Body ()

Root Schema : RDSRestErrorDataDTO

Type: object

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",
    "example":{
        "errorCode":"RULE_ERROR",
        "errorMessage":"Rule execution failed"
    }
}

Example:

{
    "errorCode":"RULE_ERROR",
    "errorMessage":"Rule execution failed"
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Back to Top