Jump to

• Request
• Response

Get rules by form ID which are in both valid and enabled states

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 which belong to a form.

Request

Path Parameters

• formId(required): string(uuid)
  Item Id
• mode(required): string
  Study Mode
• studyId(required): string(uuid)
  Study Id

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 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.

Body ()

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.

Body ()

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

Back to Top