REST API for Clinical One Platform

Get all rules based on filter parameters

post

/ec-rule-designer-svc/rest/v1.0/rulemgt/studies/{studyId}/{mode}/filteredlist

Retrieves the list of rules based on filter parameters like form name, question name etc with basic information to be used in the user interface, on the Rule Management pane. The filters can be applied on one or multiple parameters. See request body for example Filter payload.

Request

Path Parameters

mode(required): string

Study Mode
studyId(required): string(uuid)

Study Id

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

formId: string
itemId: array itemId
publishRun: string
ruleEnabled: string
ruleState: array ruleState
ruleTrainingEnabled: string
sortColumn: string
sortOrder: string
userId: string (uuid)
userName: string

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string"
        },
        "itemId":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "publishRun":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        },
        "ruleTrainingEnabled":{
            "type":"string"
        },
        "ruleEnabled":{
            "type":"string"
        },
        "ruleState":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "sortColumn":{
            "type":"string"
        },
        "sortOrder":{
            "type":"string"
        }
    }
}

Nested Schema : itemId

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ruleState

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object RulesSimpleListDTOV2

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

Nested Schema : RulesSimpleListDTOV2

Type: object

Show Source

rules: array rules

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

Nested Schema : rules

Type: array

Show Source

Array of: object RulesSimpleDTOV2

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

Nested Schema : RulesSimpleDTOV2

Type: object

Show Source

formName: string
formRefName: string
lastModifiedDate: string (date-time)
publishRun: string
questionName: string
questionRefName: string
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
ruleTrainingEnabled: string
ruleValidationMessage: string
ruleValidationStatus: string
userId: string (uuid)
userName: string
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "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"
        },
        "publishRun":{
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "lastModifiedDate":{
            "type":"string",
            "format":"date-time"
        },
        "formName":{
            "type":"string"
        },
        "questionName":{
            "type":"string"
        },
        "formRefName":{
            "type":"string"
        },
        "questionRefName":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "userName":{
            "type":"string"
        },
        "ruleTrainingEnabled":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

Root Schema : RulesSimpleListDTOV2

Type: object

Show Source

rules: array rules

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

Nested Schema : rules

Type: array

Show Source

Array of: object RulesSimpleDTOV2

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

Nested Schema : RulesSimpleDTOV2

Type: object

Show Source

formName: string
formRefName: string
lastModifiedDate: string (date-time)
publishRun: string
questionName: string
questionRefName: string
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
ruleTrainingEnabled: string
ruleValidationMessage: string
ruleValidationStatus: string
userId: string (uuid)
userName: string
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "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"
        },
        "publishRun":{
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "lastModifiedDate":{
            "type":"string",
            "format":"date-time"
        },
        "formName":{
            "type":"string"
        },
        "questionName":{
            "type":"string"
        },
        "formRefName":{
            "type":"string"
        },
        "questionRefName":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "userName":{
            "type":"string"
        },
        "ruleTrainingEnabled":{
            "type":"string"
        }
    }
}

500 Response

An internal error occured.

Root Schema : RulesSimpleListDTOV2

Type: object

Show Source

rules: array rules

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

Nested Schema : rules

Type: array

Show Source

Array of: object RulesSimpleDTOV2

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

Nested Schema : RulesSimpleDTOV2

Type: object

Show Source

formName: string
formRefName: string
lastModifiedDate: string (date-time)
publishRun: string
questionName: string
questionRefName: string
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
ruleTrainingEnabled: string
ruleValidationMessage: string
ruleValidationStatus: string
userId: string (uuid)
userName: string
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "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"
        },
        "publishRun":{
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "lastModifiedDate":{
            "type":"string",
            "format":"date-time"
        },
        "formName":{
            "type":"string"
        },
        "questionName":{
            "type":"string"
        },
        "formRefName":{
            "type":"string"
        },
        "questionRefName":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "userName":{
            "type":"string"
        },
        "ruleTrainingEnabled":{
            "type":"string"
        }
    }
}