Jump to

• Request
• Response

Get all rules by form ID, question ID, or other parameters

get

/ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/simple

Retrieves the list of rules by form ID, question ID and / or property type and name, as well as by rule ID and rule name. Provides basic information to be used in the user interface, on the Rules pane. All rules that belong to the question, form or event that could be an operand or a target item are retrieved.

Request

Path Parameters

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

Query Parameters

• eventId: string(uuid)
  Event Id: returns all the rules linked to the eventId and rules not linked to any eventId
• filterView: string
  Filter View
• formId: string(uuid)
  Form Id
• gridView: string
  Grid View
• itemId: string(uuid)
  Item Id: could be an operand or a target item in multiple rules
• limit: integer(int32)
  Limit
• offset: integer(int32)
  Offset
• propertyName: string
  Property Name: to used in conjuction with propertyType and eventId
• propertyType: string
  Property Type: to used in conjuction with propertyName and eventId
• ruleId: string(uuid)
  Rule Id
• ruleName: string
  Rule Name
• searchString: string
  Search String
• sortColumn: string
  SortColumn
• sortOrder: string
  SortOrder

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 RulesSimpleListDTO

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

Nested Schema : RulesSimpleListDTO

Type: object

Show Source

• rules: array rules

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

Nested Schema : rules

Type: array

Show Source

• Array of: object RulesSimpleDTO

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

Nested Schema : RulesSimpleDTO

Type: object

Show Source

• ruleActionTarget: string
• ruleActionTypeName: string
• ruleDeleted: number
• ruleDescription: string
• ruleEnabled: number
• ruleEverInProduction: string
• ruleId: string (uuid)
• ruleName: string
• ruleOrder: number
• ruleOriginType: string
• ruleRefName: string
• ruleState: string
• ruleValidationMessage: string
• ruleValidationStatus: string

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "format":"uuid"
        },
        "ruleOrder":{
            "type":"number"
        },
        "ruleDeleted":{
            "type":"number"
        },
        "ruleEnabled":{
            "type":"number"
        },
        "ruleName":{
            "type":"string"
        },
        "ruleRefName":{
            "type":"string"
        },
        "ruleDescription":{
            "type":"string"
        },
        "ruleState":{
            "type":"string"
        },
        "ruleValidationStatus":{
            "type":"string"
        },
        "ruleValidationMessage":{
            "type":"string"
        },
        "ruleOriginType":{
            "type":"string"
        },
        "ruleActionTypeName":{
            "type":"string"
        },
        "ruleEverInProduction":{
            "type":"string"
        },
        "ruleActionTarget":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : RulesSimpleListDTO

Type: object

Show Source

• rules: array rules

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

Nested Schema : rules

Type: array

Show Source

• Array of: object RulesSimpleDTO

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

Nested Schema : RulesSimpleDTO

Type: object

Show Source

• ruleActionTarget: string
• ruleActionTypeName: string
• ruleDeleted: number
• ruleDescription: string
• ruleEnabled: number
• ruleEverInProduction: string
• ruleId: string (uuid)
• ruleName: string
• ruleOrder: number
• ruleOriginType: string
• ruleRefName: string
• ruleState: string
• ruleValidationMessage: string
• ruleValidationStatus: string

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "format":"uuid"
        },
        "ruleOrder":{
            "type":"number"
        },
        "ruleDeleted":{
            "type":"number"
        },
        "ruleEnabled":{
            "type":"number"
        },
        "ruleName":{
            "type":"string"
        },
        "ruleRefName":{
            "type":"string"
        },
        "ruleDescription":{
            "type":"string"
        },
        "ruleState":{
            "type":"string"
        },
        "ruleValidationStatus":{
            "type":"string"
        },
        "ruleValidationMessage":{
            "type":"string"
        },
        "ruleOriginType":{
            "type":"string"
        },
        "ruleActionTypeName":{
            "type":"string"
        },
        "ruleEverInProduction":{
            "type":"string"
        },
        "ruleActionTarget":{
            "type":"string"
        }
    }
}

500 Response

An internal error occured.

Body ()

Root Schema : RulesSimpleListDTO

Type: object

Show Source

• rules: array rules

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

Nested Schema : rules

Type: array

Show Source

• Array of: object RulesSimpleDTO

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

Nested Schema : RulesSimpleDTO

Type: object

Show Source

• ruleActionTarget: string
• ruleActionTypeName: string
• ruleDeleted: number
• ruleDescription: string
• ruleEnabled: number
• ruleEverInProduction: string
• ruleId: string (uuid)
• ruleName: string
• ruleOrder: number
• ruleOriginType: string
• ruleRefName: string
• ruleState: string
• ruleValidationMessage: string
• ruleValidationStatus: string

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "format":"uuid"
        },
        "ruleOrder":{
            "type":"number"
        },
        "ruleDeleted":{
            "type":"number"
        },
        "ruleEnabled":{
            "type":"number"
        },
        "ruleName":{
            "type":"string"
        },
        "ruleRefName":{
            "type":"string"
        },
        "ruleDescription":{
            "type":"string"
        },
        "ruleState":{
            "type":"string"
        },
        "ruleValidationStatus":{
            "type":"string"
        },
        "ruleValidationMessage":{
            "type":"string"
        },
        "ruleOriginType":{
            "type":"string"
        },
        "ruleActionTypeName":{
            "type":"string"
        },
        "ruleEverInProduction":{
            "type":"string"
        },
        "ruleActionTarget":{
            "type":"string"
        }
    }
}

Back to Top